From: Alan Knowles Date: Fri, 11 Jan 2019 07:06:19 +0000 (+0800) Subject: Partial Fix #5654 - roojspacker - get it working as a doc tool... X-Git-Url: http://git.roojs.org/?p=roojs1;a=commitdiff_plain;h=b282409b66344f6d0ff1999b55639cfd80097128 Partial Fix #5654 - roojspacker - get it working as a doc tool... --- diff --git a/Roo/Markdown.js b/Roo/Markdown.js index 6ffe6e02d1..de54b7cd9b 100644 --- a/Roo/Markdown.js +++ b/Roo/Markdown.js @@ -138,7 +138,7 @@ Roo.Markdown.toHtml = function(text) { * Block Lexer */ - function Lexer(options) { + var Lexer = function (options) { this.tokens = []; this.tokens.links = {}; this.options = options || marked.defaults; @@ -556,7 +556,7 @@ Roo.Markdown.toHtml = function(text) { * Inline Lexer & Compiler */ - function InlineLexer(links, options) { + var InlineLexer = function (links, options) { this.options = options || marked.defaults; this.links = links; this.rules = inline.normal; @@ -796,7 +796,7 @@ Roo.Markdown.toHtml = function(text) { * Renderer */ - function Renderer(options) { + var Renderer = function (options) { this.options = options || {}; } @@ -946,7 +946,7 @@ Roo.Markdown.toHtml = function(text) { * Parsing & Compiling */ - function Parser(options) { + var Parser = function (options) { this.tokens = []; this.token = null; this.options = options || marked.defaults; @@ -1126,7 +1126,7 @@ Roo.Markdown.toHtml = function(text) { * Helpers */ - function escape(html, encode) { + var escape = function (html, encode) { return html .replace(!encode ? /&(?!#?\w+;)/g : /&/g, '&') .replace(/Defined by", + "494a64a432ff6a121e4ab9003c7a0df3" : "parentcls", + "9bd81329febf6efe22788e03ddeaf0af" : " Class ", + "f561aaf6ef0bf14d4208bb46a4ccb3ad" : "xxx" + }, + "items" : [ + { + "listeners" : { + "render" : "function (_self)\n{\n \n \n \n}" + }, + "String cls" : "doc-body", + "xtype" : "Body", + "$ xns" : "Roo.bootstrap", + "items" : [ + { + "listeners" : { + "render" : "function (_self)\n{\n // this.el.addClass(language);\n \n}" + }, + "String cls" : "left-menu-sidebar", + "xtype" : "NavSidebar", + "$ xns" : "Roo.bootstrap", + "String style" : "padding-top:80px;", + "items" : [ + { + "listeners" : { + "render" : "function (_self)\n{\n _this.navGroup = this;\n \n}", + "childrenrendered" : "function (_self)\n{\n _this.navGroup.autoExpand();\n \n _this.navGroup.activeLookup();\n}" + }, + "| function activeLookup" : "function() \n{ \n return;\n \n var pathname = window.location.pathname.substring(baseURL.length);\n \n if(!pathname.length){\n return;\n }\n \n if(pathname.match(/^\\/Projects/)){\n pathname = '/Projects';\n }\n \n var lookupPath = function(item)\n {\n if(typeof(item.href) == 'undefined' || !item.href.length || item.href == '#'){\n return true;\n }\n \n item.el.removeClass('active');\n \n var href = item.href.substring(baseURL.length);\n \n if(href != pathname){\n return true;\n }\n \n item.el.addClass('active');\n return false;\n \n };\n \n var seted = false;\n \n Roo.each(_this.navGroup.items, function(i){\n \n var s = lookupPath(i);\n \n if(!s){\n return false;\n }\n \n if(typeof(i.menu) == 'undefined' || !i.menu.items.length){\n return;\n }\n \n Roo.each(i.menu.items, function(ii){\n \n var ss = lookupPath(ii);\n \n if(!ss){\n seted = true;\n return false;\n }\n \n });\n \n if(seted){\n return false;\n }\n \n });\n}", + "xtype" : "NavGroup", + "$ xns" : "Roo.bootstrap", + "| function autoExpand" : "function() \n{ \n return;\n \n _this.menu_expand = false;\n \n var lookupMenu = function(menu, index){\n \n if(menu.target == pagedata.page.target){\n _this.menu_expand = index + 1;\n return;\n }\n \n if(!menu.children.length){\n return;\n }\n \n Roo.each(menu.children, function(c){\n lookupMenu(c, index);\n });\n \n }\n \n Roo.each(pagemenus, function(v, k){\n \n lookupMenu(v, k);\n \n });\n \n if(_this.menu_expand === false){\n return;\n }\n \n if(typeof(_this.navGroup.items[_this.menu_expand].menu) == 'undefined'){\n return;\n }\n \n _this.navGroup.items[_this.menu_expand].menu.show(_this.navGroup.items[_this.menu_expand].el, false, false);\n \n}", + "items" : [ + { + "Boolean active" : false, + "String cls" : "", + "xtype" : "NavItem", + "$ xns" : "Roo.bootstrap", + "String style" : "position:fixed;top:0;z-Index:1000;", + "items" : [ + { + "String cls" : "logo", + "Boolean preventDefault" : false, + "xtype" : "Link", + "$ xns" : "Roo.bootstrap", + "$ string href" : "baseURL +'/'" + } + ] + } + ] + }, + { + "String cls" : "left-menu-sidebar-options", + "xtype" : "Container", + "$ xns" : "Roo.bootstrap", + "items" : [ + { + "xtype" : "Row", + "$ xns" : "Roo.bootstrap" + } + ] + } + ] + }, + { + "listeners" : { + "beforetoggle" : "function (_self)\n{\n _this.navGroup.autoExpand(); \n \n _this.navGroup.activeLookup();\n \n _this.navHeaderBar.mask.show();\n \n if(this.el.select('.navbar-collapse',true).first().hasClass('in')){\n _this.navHeaderBar.mask.hide();\n return;\n }\n}", + "render" : "function (_self)\n{\n return;\n \n _this.navHeaderBar = this;\n \n this.el.addClass(language); \n \n var body = Roo.select('body', true).first();\n \n var mark = {\n tag: \"div\",\n cls:\"x-dlg-mask\"\n };\n \n this.mask = Roo.DomHelper.append(body, mark, true);\n \n var size = body.getSize();\n this.mask.setSize(size.width, size.height);\n \n this.mask.setStyle('z-index', '1029');\n \n this.mask.enableDisplayMode(\"block\");\n this.mask.hide();\n \n this.mask.on('click', function(){\n \n this.el.select('.navbar-collapse',true).removeClass('in'); \n this.mask.hide();\n \n }, this);\n \n \n var maxHeight = Roo.lib.Dom.getViewHeight() - this.el.select('.navbar-header', true).first().getHeight();\n \n this.el.select('.navbar-collapse', true).first().setStyle('max-height', maxHeight);\n \n}" + }, + "$ String brand_href" : "baseURL + '/'", + "String position" : "fixed-top", + "String cls" : "mobile-header-menu", + "bool autohide" : true, + "xtype" : "NavHeaderbar", + "Boolean inverse" : false, + "$ xns" : "Roo.bootstrap", + "String brand" : " ", + "String style" : "" + }, + { + "listeners" : { + "render" : "function (_self)\n{\n _this.doc_body_content = this;\n}" + }, + "String cls" : "general-content-body", + "xtype" : "Container", + "$ xns" : "Roo.bootstrap", + "items" : [ + { + "xtype" : "Row", + "$ xns" : "Roo.bootstrap", + "String style" : "margin: 0px;", + "items" : [ + { + "Number md" : 9, + "xtype" : "Column", + "$ xns" : "Roo.bootstrap", + "String style" : "padding-left: 0px;", + "items" : [ + { + "String cls" : "doc-header-container", + "xtype" : "Container", + "$ xns" : "Roo.bootstrap", + "items" : [ + { + "xtype" : "Header", + "Number level" : 4, + "$ xns" : "Roo.bootstrap", + "String html" : " Class ", + "items" : [ + { + "listeners" : { + "render" : "function (_self)\n{\n _this.doc_name = this\n}" + }, + "String tag" : "span", + "String cls" : "doc-classname", + "xtype" : "Element", + "$ xns" : "Roo.bootstrap", + "String html" : "xxx", + "String style" : "font-size: 24px;\n font-weight: bold;" + }, + { + "listeners" : { + "render" : "function (_self)\n{\n _this.doc_extends_sep = this;\n}" + }, + "String tag" : "small", + "String cls" : "doc-extends-str", + "xtype" : "Element", + "$ xns" : "Roo.bootstrap", + "String html" : " extends ", + "items" : [ + { + "listeners" : { + "render" : "function (_self)\n{\n _this.doc_extends = this;\n}", + "click" : "function (e)\n{\n\n if (this.el.dom.innerHTML.length) {\n Roo.docs.init.loadDoc({ name : this.el.dom.innerHTML, is_class : true});\n }\n}" + }, + "String cls" : "doc-extends", + "Boolean preventDefault" : false, + "xtype" : "Link", + "$ xns" : "Roo.bootstrap", + "String html" : "parentcls" + } + ] + } + ] + }, + { + "xtype" : "Header", + "$ xns" : "Roo.bootstrap", + "Number level" : 5, + "String html" : "source: ", + "items" : [ + { + "listeners" : { + "render" : "function (_self)\n{\n _this.doc_source = this;\n}", + "click" : "function (e)\n{\n \n Roo.log([\"click\", this]);\n if (this.el.dom.innerHTML.length > 0) {\n Roo.docs.loadSource();\n }\n}" + }, + "String cls" : "doc-source", + "Boolean preventDefault" : true, + "String href" : "#", + "xtype" : "Link", + "$ xns" : "Roo.bootstrap", + "String html" : "source" + } + ] + } + ] + }, + { + "listeners" : { + "render" : "function (_self)\n{\n _this.doc_desc = this;\n}" + }, + "String cls" : "doc-desc", + "xtype" : "Container", + "$ xns" : "Roo.bootstrap", + "String html" : "doc-desc" + }, + { + "String cls" : "doc-comments", + "xtype" : "Container", + "$ xns" : "Roo.bootstrap", + "String html" : "doc-comments", + "Boolean hidden" : true + } + ] + }, + { + "Number md" : 3, + "xtype" : "Column", + "$ xns" : "Roo.bootstrap", + "items" : [ + { + "listeners" : { + "render" : "function (_self)\n{\n _this.augments = this;\n}" + }, + "String header" : "Inheritance tree", + "String cls" : "doc-augments", + "xtype" : "Container", + "String panel" : "success", + "$ xns" : "Roo.bootstrap" + } + ] + } + ] + }, + { + "listeners" : { + "render" : "function (_self)\n{\n _this.configTableContainer = this;\n}" + }, + "String header" : "Configuration options", + "Boolean expanded" : true, + "String cls" : "doc-table-container", + "xtype" : "Container", + "String panel" : "info", + "$ xns" : "Roo.bootstrap", + "String style" : "margin-top:15px", + "Boolean expandable" : true, + "items" : [ + { + "listeners" : { + "rowclass" : "function (_self, rowcfg)\n{\n rowcfg.rowClass = rowcfg.record.json.expanded ? 'expanded' : '';\n}", + "render" : "function (_self)\n{\n _this.configTable = this;\n}", + "rowclick" : "function (_self, el, rowIndex, e)\n{\n if (e.target.className != 'fixedFont' && e.target.parentNode.className != 'fixedFont') {\n return false;\n }\n \n var r = this.store.getAt(rowIndex);\n r.json.expanded = !r.json.expanded ;\n this.refreshRow(r);\n}" + }, + "boolean striped" : true, + "xtype" : "Table", + "Boolean rowSelection" : true, + "$ xns" : "Roo.bootstrap", + "items" : [ + { + "String header" : "", + "Number md" : 11, + "String dataIndex" : "name", + "$ Function renderer" : "function(v,x,r) { \n\n return Roo.docs.template.config(r.json);\n\n\t\t\t\n}", + "xtype" : "ColumnModel", + "$ xns" : "Roo.grid", + "* prop" : "cm[]" + }, + { + "String header" : "Defined by", + "Number md" : 1, + "String dataIndex" : "memberOf", + "$ Function renderer" : "function(v,x,r) { \n if (r.json.memberOf == Roo.docs.init.currentClass) {\n return '';\n }\n\n\t\treturn \t'' + r.json.memberOf + '';\n\t\t\t\n}", + "xtype" : "ColumnModel", + "$ xns" : "Roo.grid", + "* prop" : "cm[]" + }, + { + "xtype" : "Store", + "$ xns" : "Roo.data", + "* prop" : "store", + "items" : [ + { + "xtype" : "MemoryProxy", + "$ xns" : "Roo.data", + "* prop" : "proxy" + }, + { + "xtype" : "ArrayReader", + "$ xns" : "Roo.data", + "$ fields" : "[ 'name', 'type', 'desc', 'memberOf' ]", + "* prop" : "reader" + } + ] + } + ] + } + ] + }, + { + "listeners" : { + "render" : "function (_self)\n{\n _this.methodsTableContainer = this;\n}" + }, + "String header" : "Public Methods", + "Boolean expanded" : false, + "String cls" : "doc-table-container", + "String panel" : "info", + "xtype" : "Container", + "$ xns" : "Roo.bootstrap", + "Boolean expandable" : true, + "items" : [ + { + "listeners" : { + "rowclass" : "function (_self, rowcfg)\n{\n rowcfg.rowClass = rowcfg.record.json.expanded ? 'expanded' : '';\n}", + "render" : "function (_self)\n{\n _this.methodsTable = this;\n}", + "rowclick" : "function (_self, el, rowIndex, e)\n{\n if (e.target.className != 'fixedFont' && e.target.parentNode.className != 'fixedFont') {\n return false;\n }\n var r = this.store.getAt(rowIndex);\n r.json.expanded = !r.json.expanded ;\n this.refreshRow(r);\n}" + }, + "xtype" : "Table", + "Boolean rowSelection" : true, + "$ xns" : "Roo.bootstrap", + "items" : [ + { + "String header" : " ", + "String dataIndex" : "name", + "Number md" : 11, + "$ Function renderer" : "function(v,x,r) { \n\n return Roo.docs.template.method(r.json);\n\t\t \n\t\t\t\n}", + "xtype" : "ColumnModel", + "$ xns" : "Roo.grid", + "Boolean sortable" : false, + "* prop" : "cm[]" + }, + { + "String header" : "Defined by", + "String dataIndex" : "memberOf", + "Number md" : 1, + "$ Function renderer" : "function(v,x,r) { \n\n if (r.json.memberOf == Roo.docs.init.currentClass) {\n return '';\n }\n\t\treturn \t'' + r.json.memberOf + '';\n\t\t\t\n}", + "xtype" : "ColumnModel", + "$ xns" : "Roo.grid", + "* prop" : "cm[]" + }, + { + "$ Object sortInfo" : "{ field : 'name', direction : 'ASC' }", + "xtype" : "Store", + "$ xns" : "Roo.data", + "* prop" : "store", + "items" : [ + { + "xtype" : "MemoryProxy", + "$ xns" : "Roo.data", + "* prop" : "proxy" + }, + { + "xtype" : "ArrayReader", + "$ xns" : "Roo.data", + "$ fields" : "[ 'name', 'type', 'desc', 'memberOf' ]", + "* prop" : "reader" + } + ] + } + ] + } + ] + }, + { + "listeners" : { + "render" : "function (_self)\n{\n _this.eventsTableContainer = this;\n}" + }, + "String header" : "Events", + "Boolean expanded" : false, + "String cls" : "doc-table-container", + "xtype" : "Container", + "String panel" : "info", + "$ xns" : "Roo.bootstrap", + "Boolean expandable" : true, + "items" : [ + { + "listeners" : { + "rowclass" : "function (_self, rowcfg)\n{\n rowcfg.rowClass = rowcfg.record.json.expanded ? 'expanded' : '';\n}", + "render" : "function (_self)\n{\n _this.eventsTable = this;\n}", + "rowclick" : "function (_self, el, rowIndex, e)\n{\n if (e.target.className != 'fixedFont' && e.target.parentNode.className != 'fixedFont') {\n return false;\n }\n var r = this.store.getAt(rowIndex);\n r.json.expanded = !r.json.expanded ;\n this.refreshRow(r);\n}" + }, + "xtype" : "Table", + "Boolean rowSelection" : true, + "$ xns" : "Roo.bootstrap", + "items" : [ + { + "String header" : "", + "Number md" : 11, + "String dataIndex" : "name", + "$ Function renderer" : "function(v,x,r) { \n\n return Roo.docs.template.event(r.json);\n\t\t \n\t\t\t\n}", + "xtype" : "ColumnModel", + "$ xns" : "Roo.grid", + "* prop" : "cm[]" + }, + { + "String header" : "Defined by", + "Number md" : 1, + "String dataIndex" : "memberOf", + "$ Function renderer" : "function(v,x,r) { \n if (r.json.memberOf == Roo.docs.init.currentClass) {\n return '';\n }\n\n\t\treturn \t'' + r.json.memberOf + '';\n\t\t\t\n}", + "xtype" : "ColumnModel", + "$ xns" : "Roo.grid", + "* prop" : "cm[]" + }, + { + "xtype" : "Store", + "$ xns" : "Roo.data", + "* prop" : "store", + "items" : [ + { + "xtype" : "ArrayReader", + "$ fields" : "[ 'name', 'type', 'desc', 'memberOf' ]", + "$ xns" : "Roo.data", + "* prop" : "reader" + }, + { + "xtype" : "MemoryProxy", + "$ xns" : "Roo.data", + "* prop" : "proxy" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/docs2/Roo.docs.init.js b/docs2/Roo.docs.init.js new file mode 100644 index 0000000000..ebdce4c4ba --- /dev/null +++ b/docs2/Roo.docs.init.js @@ -0,0 +1,222 @@ + + +Roo.docs.init = { + + onReady : function() + { + + //if (typeof(pagedata) == 'undefined') { + // Site.onReady.defer(100, Roo.docs.init); + // return; + //} + //Roo.debug = 1; + + Roo.XComponent.hideProgress = true; + Roo.XComponent.build(); + + + + + Roo.XComponent.on('buildcomplete', function() { + + //Roo.XComponent.modules[0].el.fireEvent('render'); + this.loadTree(); + }, this); + + + + }, + + loadTree: function() + { + Roo.docs.doc_body_content.hide(); + + Roo.Ajax.request({ + url : 'tree.json', + method : 'GET', + success : function(res, o) + { + var d = Roo.decode(res.responseText); + Roo.log(d); + d.forEach(function(e) { + if (e.cn.length) { + this.addTreeItem(Roo.docs.navGroup, e, 'NavSidebarItem'); + } + }, this); + d.forEach(function(e) { + if (!e.cn.length) { + this.addTreeItem(Roo.docs.navGroup, e, 'NavSidebarItem'); + } + }, this); + var roo = Roo.docs.navGroup.items[1].menu; + roo.show(roo.triggerEl, '?', false); + + }, + scope : this + }); + + + }, + addTreeItem : function(parent, e, type) { + // add a node.. + var node = parent.addxtypeChild(Roo.factory({ + html: e.name.split('.').pop(), + id : e.name, + xns : Roo.bootstrap, + showArrow: false, + xtype : type, + preventDefault : true, + // cls : type == 'NavSidebarItem' ? 'open' : '', + listeners : { + click : (function(mi,ev,c) + { + + ev.stopPropagation(); + + if (c.cn.length) { + Roo.log(ev); + if (mi.menu.el.hasClass('show')) { + mi.menu.hide(); + } else { + mi.menu.show(mi.menu.triggerEl,'?', false); + } + + } + + Roo.docs.init.loadDoc(c); + + }).createDelegate(this,[e], true) + + }, + fa : e.cn.length ? 'chevron-right' : '', + menu : !e.cn.length ? false : Roo.factory({ + type : 'treeview', + xns: Roo.bootstrap, + xtype : 'Menu', + listeners : { + beforehide : (function(mi,c) + { + if (c.name.split('.').length < 2) { + return false; + } + return true; + + }).createDelegate(this,[e], true) + + } + + }) + })); + parent.items.push(node); + if (e.cn.length && type == 'NavSidebarItem') { + this.topm = node.menu; + } + + + if (!e.cn.length) { + return; + } + e.cn.forEach(function(ec) { + var cn = ec.name.split('.').pop(); + Roo.log(cn); + if (cn == cn.toLowerCase()) { + this.addTreeItem(node.menu, ec,'MenuItem'); + } + + }, this); + e.cn.forEach(function(ec) { + var cn = ec.name.split('.').pop(); + if (cn != cn.toLowerCase()) { + this.addTreeItem(node.menu, ec,'MenuItem'); + } + }, this); + + }, + loadDoc : function(cls) + { + Roo.docs.doc_body_content.hide(); + this.currentClass = cls.name; + if (!cls.is_class) { + return; + } + Roo.docs.doc_body_content.show(); + Roo.Ajax.request({ + url : 'symbols/' + cls.name + '.json', + method : 'GET', + success : function(res, o) + { + var d = Roo.decode(res.responseText); + this.fillDoc(d); + + }, + scope : this + }); + + + }, + fillDoc : function(d) + { + /*{ + "name" : "Roo.bootstrap.Progress", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Progress class", + "config" : [ + { + */ + document.body.scrollTop = 0; + for (var k in d) { + if (typeof(Roo.docs['doc_' + k]) != 'undefined') { + Roo.docs['doc_' + k].el.dom.innerHTML = d[k].split("\n").join("
"); + } + } + Roo.docs.doc_extends.hide(); + Roo.docs.doc_extends_sep.hide(); + if (d.augments.length) { + Roo.docs.doc_extends.show(); + Roo.docs.doc_extends_sep.show(); + Roo.docs.doc_extends.el.dom.innerHTML = d.augments[0]; + } + Roo.docs.doc_source.el.dom.innerHTML = d.name.replace(/\./g,"/") + ".js"; + + if (d.augments.length) { + Roo.docs.augments.show(); + Roo.docs.augments.bodyEl().dom.innerHTML = Roo.docs.template.augments(d); + } else { + Roo.docs.augments.hide(); + } + + + + Roo.docs.configTableContainer.hide(); + Roo.docs.methodsTableContainer.hide(); + Roo.docs.eventsTableContainer.hide(); + if (d.config.length) { + Roo.docs.configTableContainer.show(); + Roo.docs.configTable.store.load( { params : { data : d.config.sort(Roo.docs.template.makeSortby("name")) }}); + } + + if (d.methods.length) { + Roo.docs.methodsTable.store.load( { params : { data : Roo.docs.template.methodsSort(d) }}); + Roo.docs.methodsTableContainer.show(); + } + if (d.events.length) { + Roo.docs.eventsTable.store.load( { params : { data : d.events.sort(Roo.docs.template.makeSortby("name")) }}); + Roo.docs.eventsTableContainer.show(); + } + + + } + + + + +}; + + +Roo.onReady(Roo.docs.init.onReady, Roo.docs.init); + + \ No newline at end of file diff --git a/docs2/Roo.docs.js b/docs2/Roo.docs.js new file mode 100644 index 0000000000..8ce67e190c --- /dev/null +++ b/docs2/Roo.docs.js @@ -0,0 +1,743 @@ +// + + + + + + + + + + + + + + + diff --git a/docs2/json/roodata.json b/docs2/json/roodata.json new file mode 100644 index 0000000000..6ab53ba4b5 --- /dev/null +++ b/docs2/json/roodata.json @@ -0,0 +1,100039 @@ +{ + "Array" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "indexOf", + "type" : "function", + "desc" : "Checks whether or not the specified object exists in the array.", + "sig" : "(o)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "map", + "type" : "function", + "desc" : "Map (JS 1.6 compatibility)", + "sig" : "(function() {\n\n})", + "static" : false, + "memberOf" : "" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Removes the specified object from the array. If the object is not found nothing happens.", + "sig" : "(o)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Date" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Provides a convenient method of performing basic date arithmetic. This method\ndoes not modify the Date instance being called - it creates and returns\na new Date instance containing the resulting date value.\n\nExamples:\n
\n//Basic usage:\nvar dt = new Date('10/29/2006').add(Date.DAY, 5);\ndocument.write(dt); //returns 'Fri Oct 06 2006 00:00:00'\n\n//Negative values will subtract correctly:\nvar dt2 = new Date('10/1/2006').add(Date.DAY, -5);\ndocument.write(dt2); //returns 'Tue Sep 26 2006 00:00:00'\n\n//You can even chain several calls together in one line!\nvar dt3 = new Date('10/1/2006').add(Date.DAY, 5).add(Date.HOUR, 8).add(Date.MINUTE, -30);\ndocument.write(dt3); //returns 'Fri Oct 06 2006 07:30:00'\n 
", + "sig" : "(interval, value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "clearTime", + "type" : "function", + "desc" : "Clears any time information from this date", + "sig" : "(clone)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "clone", + "type" : "function", + "desc" : "Creates and returns a new Date instance with the exact same date value as the called instance.\nDates are copied and passed by reference, so if a copied date variable is modified later, the original\nvariable will also be changed. When the intention is to create a new variable that will not\nmodify the original instance, you should create a clone.\n\nExample of correctly cloning a date:\n
\n//wrong way:\nvar orig = new Date('10/1/2006');\nvar copy = orig;\ncopy.setDate(5);\ndocument.write(orig);  //returns 'Thu Oct 05 2006'!\n\n//correct way:\nvar orig = new Date('10/1/2006');\nvar copy = orig.clone();\ncopy.setDate(5);\ndocument.write(orig);  //returns 'Thu Oct 01 2006'\n
", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "format", + "type" : "function", + "desc" : "Formats a date given the supplied format string", + "sig" : "(format)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getDayOfYear", + "type" : "function", + "desc" : "Get the numeric day number of the year, adjusted for leap year.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getDaysInMonth", + "type" : "function", + "desc" : "Get the number of days in the current month, adjusted for leap year.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getElapsed", + "type" : "function", + "desc" : "Returns the number of milliseconds between this date and date", + "sig" : "(date)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getFirstDateOfMonth", + "type" : "function", + "desc" : "Get the first date of this date's month", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getFirstDayOfMonth", + "type" : "function", + "desc" : "Get the first day of the current month, adjusted for leap year. The returned value\nis the numeric day index within the week (0-6) which can be used in conjunction with\nthe {@link #monthNames} array to retrieve the textual day name.\nExample:\n
\nvar dt = new Date('1/10/2007');\ndocument.write(Date.dayNames[dt.getFirstDayOfMonth()]); //output: 'Monday'\n
", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getGMTColonOffset", + "type" : "function", + "desc" : "Get the offset from GMT of the current date (equivalent to the format specifier 'P').", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getGMTOffset", + "type" : "function", + "desc" : "Get the offset from GMT of the current date (equivalent to the format specifier 'O').", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getLastDateOfMonth", + "type" : "function", + "desc" : "Get the last date of this date's month", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getLastDayOfMonth", + "type" : "function", + "desc" : "Get the last day of the current month, adjusted for leap year. The returned value\nis the numeric day index within the week (0-6) which can be used in conjunction with\nthe {@link #monthNames} array to retrieve the textual day name.\nExample:\n
\nvar dt = new Date('1/10/2007');\ndocument.write(Date.dayNames[dt.getLastDayOfMonth()]); //output: 'Wednesday'\n
", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getSuffix", + "type" : "function", + "desc" : "Get the English ordinal suffix of the current day (equivalent to the format specifier 'S').", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getTimezone", + "type" : "function", + "desc" : "Get the timezone abbreviation of the current date (equivalent to the format specifier 'T').", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getWeekOfYear", + "type" : "function", + "desc" : "Get the string representation of the numeric week number of the year\n(equivalent to the format specifier 'W').", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isLeapYear", + "type" : "function", + "desc" : "Whether or not the current date is in a leap year.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "parseDate", + "type" : "function", + "desc" : "Parses the passed string using the specified format. Note that this function expects dates in normal calendar\nformat, meaning that months are 1-based (1 = January) and not zero-based like in JavaScript dates. Any part of\nthe date format that is not specified will default to the current date value for that part. Time parts can also\nbe specified, but default to 0. Keep in mind that the input date string must precisely match the specified format\nstring or the parse operation will fail.\nExample Usage:\n
\n//dt = Fri May 25 2007 (current date)\nvar dt = new Date();\n\n//dt = Thu May 25 2006 (today's month/day in 2006)\ndt = Date.parseDate(\"2006\", \"Y\");\n\n//dt = Sun Jan 15 2006 (all date parts specified)\ndt = Date.parseDate(\"2006-1-15\", \"Y-m-d\");\n\n//dt = Sun Jan 15 2006 15:20:01 GMT-0600 (CST)\ndt = Date.parseDate(\"2006-1-15 3:20:01 PM\", \"Y-m-d h:i:s A\" );\n
", + "sig" : "(input, format)", + "static" : true, + "memberOf" : "" + } + ] + }, + "Function" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "createCallback", + "type" : "function", + "desc" : "Creates a callback that passes arguments[0], arguments[1], arguments[2], ...\nCall directly on any function. Example: myFunction.createCallback(myarg, myarg2)\nWill create a function that is bound to those 2 args.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "createDelegate", + "type" : "function", + "desc" : "Creates a delegate (callback) that sets the scope to obj.\nCall directly on any function. Example: this.myFunction.createDelegate(this)\nWill create a function that is automatically scoped to this.", + "sig" : "(obj, args, appendArgs)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "createInterceptor", + "type" : "function", + "desc" : "Creates an interceptor function. The passed fcn is called before the original one. If it returns false, the original one is not called.\nThe resulting function returns the results of the original function.\nThe passed fcn is called with the parameters of the original function.", + "sig" : "(fcn, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "createSequence", + "type" : "function", + "desc" : "Create a combined function call sequence of the original function + the passed function.\nThe resulting function returns the results of the original function.\nThe passed fcn is called with the parameters of the original function", + "sig" : "(fcn, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "defer", + "type" : "function", + "desc" : "Calls this function after the number of millseconds specified.", + "sig" : "(millis, obj, args, appendArgs)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Number" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "constrain", + "type" : "function", + "desc" : "Checks whether or not the current number is within a desired range. If the number is already within the\nrange it is returned, otherwise the min or max value is returned depending on which side of the range is\nexceeded. Note that this method returns the constrained value but does not change the current number.", + "sig" : "(min, max)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "addBehaviors", + "type" : "function", + "desc" : "Applies event listeners to elements by selectors when the document is ready.\nThe event name is specified with an @ suffix.\n
\nRoo.addBehaviors({\n   // add a listener for click on all anchors in element with id foo\n   '#foo a@click' : function(e, t){\n       // do something\n   },\n\n   // add the same listener to multiple selectors (separated by comma BEFORE the @)\n   '#foo a, #bar span.some-class@mouseover' : function(){\n       // do something\n   }\n});\n
", + "sig" : "(obj)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "apply", + "type" : "function", + "desc" : "Copies all the properties of config to obj.", + "sig" : "(obj, config, defaults)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "applyIf", + "type" : "function", + "desc" : "Copies all the properties of config to obj if they don't already exist.", + "sig" : "(obj, config)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "decode", + "type" : "function", + "desc" : "Shorthand for {@link Roo.util.JSON#decode}", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "" + }, + { + "name" : "each", + "type" : "function", + "desc" : "Iterates an array calling the passed function with each item, stopping if your function returns false. If the\npassed array is not really an array, your function is called once with it.\nThe supplied function is called with (Object item, Number index, Array allItems).", + "sig" : "(array, fn, scope)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "encode", + "type" : "function", + "desc" : "Shorthand for {@link Roo.util.JSON#encode}", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "" + }, + { + "name" : "encodeURIComponent", + "type" : "function", + "desc" : "Safe version of encodeURIComponent", + "sig" : "(data)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "escapeRe", + "type" : "function", + "desc" : "Escapes the passed string for use in a regular expression", + "sig" : "(str)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "extend", + "type" : "function", + "desc" : "Extends one class with another class and optionally overrides members with the passed literal. This class\nalso adds the function \"override()\" to the class that can be used to override\nmembers on an instance.", + "sig" : "(subclass, superclass, overrides)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "factory", + "type" : "function", + "desc" : "Creates namespaces to be used for scoping variables and classes so that they are not global. Usage:\n
\nRoo.factory({ xns: Roo.data, xtype : 'Store', .....});\nRoo.factory(conf, Roo.data);\n
", + "sig" : "(classname, namespace)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "fly", + "type" : "function", + "desc" : "Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -\nthe dom node can be overwritten by other code.\nShorthand of {@link Roo.Element#fly}", + "sig" : "(el, named)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "get", + "type" : "function", + "desc" : "Static method to retrieve Element objects. Uses simple caching to consistently return the same object.\nAutomatically fixes if an object was recreated with the same id via AJAX or DOM.\nShorthand of {@link Roo.Element#get}", + "sig" : "(el)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "getCmp", + "type" : "function", + "desc" : "Shorthand for {@link Roo.ComponentMgr#get}", + "sig" : "(id)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "getDom", + "type" : "function", + "desc" : "Return the dom node for the passed string (id), dom node, or Roo.Element", + "sig" : "(el)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "id", + "type" : "function", + "desc" : "Generates unique ids. If the element already has an id, it is unchanged", + "sig" : "(el, prefix)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "isEmpty", + "type" : "function", + "desc" : "Returns true if the passed value is null, undefined or an empty string (optional).", + "sig" : "(value, allowBlank)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "namespace", + "type" : "function", + "desc" : "Creates namespaces to be used for scoping variables and classes so that they are not global. Usage:\n
\nRoo.namespace('Company', 'Company.data');\nCompany.Widget = function() { ... }\nCompany.data.CustomStore = function(config) { ... }\n
", + "sig" : "(namespace1, namespace2, etc)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "onReady", + "type" : "function", + "desc" : "Fires when the document is ready (before onload and before images are loaded). Shorthand of {@link Roo.EventManager#onDocumentReady}.", + "sig" : "(fn, scope, override)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "override", + "type" : "function", + "desc" : "Adds a list of functions to the prototype of an existing class, overwriting any existing methods with the same name.\nUsage:
\nRoo.override(MyClass, {\n    newMethod1: function(){\n        // etc.\n    },\n    newMethod2: function(foo){\n        // etc.\n    }\n});\n 
", + "sig" : "(origclass, overrides)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "query", + "type" : "function", + "desc" : "Selects an array of DOM nodes by CSS/XPath selector. Shorthand of {@link Roo.DomQuery#select}", + "sig" : "(path, root)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Selects elements based on the passed CSS selector to enable working on them as 1.", + "sig" : "(selector, unique, root)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "selectNode", + "type" : "function", + "desc" : "Selects a single element as a Roo Element\nThis is about as close as you can get to jQuery's $('do crazy stuff')", + "sig" : "(selector, root)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "type", + "type" : "function", + "desc" : "Returns the type of object that is passed in. If the object passed in is null or undefined it\nreturn false otherwise it returns one of the following values:", + "sig" : "(config)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "unregister", + "type" : "function", + "desc" : "Removes this quick tip from its element and destroys it.", + "sig" : "(el)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.ReaderLayout" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "layout", + "type" : "function", + "desc" : "Fires when a layout is performed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.LayoutManager" + }, + { + "name" : "regioncollapsed", + "type" : "function", + "desc" : "Fires when a region is collapsed.", + "sig" : "function (region)\n{\n\n}", + "memberOf" : "Roo.LayoutManager" + }, + { + "name" : "regionexpanded", + "type" : "function", + "desc" : "Fires when a region is expanded.", + "sig" : "function (region)\n{\n\n}", + "memberOf" : "Roo.LayoutManager" + }, + { + "name" : "regionresized", + "type" : "function", + "desc" : "Fires when the user resizes a region.", + "sig" : "function (region, newSize)\n{\n\n}", + "memberOf" : "Roo.LayoutManager" + } + ], + "methods" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Adds a ContentPanel (or subclass) to this layout.", + "sig" : "(target, panel)", + "static" : false, + "memberOf" : "Roo.BorderLayout" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addRegion", + "type" : "function", + "desc" : "Creates and adds a new region if it doesn't already exist.", + "sig" : "(target, config)", + "static" : false, + "memberOf" : "Roo.BorderLayout" + }, + { + "name" : "addxtype", + "type" : "function", + "desc" : "Adds a xtype elements to the layout.\n
\n\nlayout.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\nlayout.addxtype({\n        xtype : 'NestedLayoutPanel',\n        region: 'west',\n        layout: {\n           center: { },\n           west: { }   \n        },\n        items : [ ... list of content panels or nested layout panels.. ]\n   }\n);\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "Roo.BorderLayout" + }, + { + "name" : "batchAdd", + "type" : "function", + "desc" : "Adds a batch of multiple ContentPanels dynamically by passing a special regions config object. This config\nobject should contain properties for each region to add ContentPanels to, and each property's value should be\na valid ContentPanel config object. Example:\n
\n// Create the main layout\nvar layout = new Roo.BorderLayout('main-ct', {\n    west: {\n        split:true,\n        minSize: 175,\n        titlebar: true\n    },\n    center: {\n        title:'Components'\n    }\n}, 'main-ct');\n\n// Create and add multiple ContentPanels at once via configs\nlayout.batchAdd({\n   west: {\n       id: 'source-files',\n       autoCreate:true,\n       title:'Ext Source Files',\n       autoScroll:true,\n       fitToFrame:true\n   },\n   center : {\n       el: cview,\n       autoScroll:true,\n       fitToFrame:true,\n       toolbar: tb,\n       resizeEl:'cbody'\n   }\n});\n
", + "sig" : "(regions)", + "static" : false, + "memberOf" : "Roo.BorderLayout" + }, + { + "name" : "beginUpdate", + "type" : "function", + "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutManager" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "create", + "type" : "function", + "desc" : "Shortcut for creating a new BorderLayout object and adding one or more ContentPanels to it in a single step, handling\nthe beginUpdate and endUpdate calls internally. The key to this method is the panels property that can be\nprovided with each region config, which allows you to add ContentPanel configs in addition to the region configs\nduring creation. The following code is equivalent to the constructor-based example at the beginning of this class:\n
\n// shorthand\nvar CP = Roo.ContentPanel;\n\nvar layout = Roo.BorderLayout.create({\n    north: {\n        initialSize: 25,\n        titlebar: false,\n        panels: [new CP(\"north\", \"North\")]\n    },\n    west: {\n        split:true,\n        initialSize: 200,\n        minSize: 175,\n        maxSize: 400,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"west\", {title: \"West\"})]\n    },\n    east: {\n        split:true,\n        initialSize: 202,\n        minSize: 175,\n        maxSize: 400,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"autoTabs\", {title: \"Auto Tabs\", closable: true})]\n    },\n    south: {\n        split:true,\n        initialSize: 100,\n        minSize: 100,\n        maxSize: 200,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"south\", {title: \"South\", closable: true})]\n    },\n    center: {\n        titlebar: true,\n        autoScroll:true,\n        resizeTabs: true,\n        minTabWidth: 50,\n        preferredTabWidth: 150,\n        panels: [\n            new CP(\"center1\", {title: \"Close Me\", closable: true}),\n            new CP(\"center2\", {title: \"Center Panel\", closable: false})\n        ]\n    }\n}, document.body);\n\nlayout.getRegion(\"center\").showPanel(\"center1\");\n
", + "sig" : "(config, targetEl)", + "static" : true, + "memberOf" : "Roo.BorderLayout" + }, + { + "name" : "endUpdate", + "type" : "function", + "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout", + "sig" : "(noLayout)", + "static" : false, + "memberOf" : "Roo.LayoutManager" + }, + { + "name" : "findPanel", + "type" : "function", + "desc" : "Searches all regions for a panel with the specified id", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "Roo.BorderLayout" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the Element this layout is bound to.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutManager" + }, + { + "name" : "getRegion", + "type" : "function", + "desc" : "Returns the specified region.", + "sig" : "(target)", + "static" : false, + "memberOf" : "Roo.LayoutManager" + }, + { + "name" : "getViewSize", + "type" : "function", + "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutManager" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "isUpdating", + "type" : "function", + "desc" : "Returns true if this layout is currently being updated", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutManager" + }, + { + "name" : "layout", + "type" : "function", + "desc" : "Performs a layout update.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BorderLayout" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Remove a ContentPanel (or subclass) to this layout.", + "sig" : "(target, panel)", + "static" : false, + "memberOf" : "Roo.BorderLayout" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "restoreState", + "type" : "function", + "desc" : "Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.", + "sig" : "(provider)", + "static" : false, + "memberOf" : "Roo.BorderLayout" + }, + { + "name" : "showPanel", + "type" : "function", + "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "Roo.BorderLayout" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.Resizable" : { + "props" : [ + { + "name" : "adjustments", + "type" : "Array/String", + "desc" : "String \"auto\" or an array [width, height] with values to be added to the\nresize operation's new size (defaults to [0, 0])", + "memberOf" : "" + }, + { + "name" : "animate", + "type" : "Boolean", + "desc" : "True to animate the resize (not compatible with dynamic sizing, defaults to false)", + "memberOf" : "" + }, + { + "name" : "constrainTo", + "type" : "String/HTMLElement/Element", + "desc" : "Constrain the resize to a particular element", + "memberOf" : "" + }, + { + "name" : "disableTrackOver", + "type" : "Boolean", + "desc" : "True to disable mouse tracking. This is only applied at config time. (defaults to false)", + "memberOf" : "" + }, + { + "name" : "draggable", + "type" : "Boolean", + "desc" : "Convenience to initialize drag drop (defaults to false)", + "memberOf" : "" + }, + { + "name" : "duration", + "type" : "Number", + "desc" : "Animation duration if animate = true (defaults to .35)", + "memberOf" : "" + }, + { + "name" : "dynamic", + "type" : "Boolean", + "desc" : "True to resize the element while dragging instead of using a proxy (defaults to false)", + "memberOf" : "" + }, + { + "name" : "easing", + "type" : "String", + "desc" : "Animation easing if animate = true (defaults to 'easingOutStrong')", + "memberOf" : "" + }, + { + "name" : "enabled", + "type" : "Boolean", + "desc" : "False to disable resizing (defaults to true)", + "memberOf" : "" + }, + { + "name" : "handles", + "type" : "String", + "desc" : "String consisting of the resize handles to display (defaults to undefined)", + "memberOf" : "" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The height of the element in pixels (defaults to null)", + "memberOf" : "" + }, + { + "name" : "heightIncrement", + "type" : "Number", + "desc" : "The increment to snap the height resize in pixels (dynamic must be true, defaults to 0)", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maxHeight", + "type" : "Number", + "desc" : "The maximum height for the element (defaults to 10000)", + "memberOf" : "" + }, + { + "name" : "maxWidth", + "type" : "Number", + "desc" : "The maximum width for the element (defaults to 10000)", + "memberOf" : "" + }, + { + "name" : "minHeight", + "type" : "Number", + "desc" : "The minimum height for the element (defaults to 5)", + "memberOf" : "" + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum width for the element (defaults to 5)", + "memberOf" : "" + }, + { + "name" : "minX", + "type" : "Number", + "desc" : "The minimum allowed page X for the element (only used for west resizing, defaults to 0)", + "memberOf" : "" + }, + { + "name" : "minY", + "type" : "Number", + "desc" : "The minimum allowed page Y for the element (only used for north resizing, defaults to 0)", + "memberOf" : "" + }, + { + "name" : "multiDirectional", + "type" : "Boolean", + "desc" : "Deprecated. The old style of adding multi-direction resize handles, deprecated\nin favor of the handles config option (defaults to false)", + "memberOf" : "" + }, + { + "name" : "pinned", + "type" : "Boolean", + "desc" : "True to ensure that the resize handles are always visible, false to display them only when the\nuser mouses over the resizable borders. This is only applied at config time. (defaults to false)", + "memberOf" : "" + }, + { + "name" : "preserveRatio", + "type" : "Boolean", + "desc" : "True to preserve the original ratio between height and width during resize (defaults to false)", + "memberOf" : "" + }, + { + "name" : "resizeChild", + "type" : "Boolean/String/Element", + "desc" : "True to resize the first child, or id/element to resize (defaults to false)", + "memberOf" : "" + }, + { + "name" : "resizeRegion", + "type" : "Roo.lib.Region", + "desc" : "Constrain the resize to a particular region", + "memberOf" : "" + }, + { + "name" : "transparent", + "type" : "Boolean", + "desc" : "True for transparent handles. This is only applied at config time. (defaults to false)", + "memberOf" : "" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The width of the element in pixels (defaults to null)", + "memberOf" : "" + }, + { + "name" : "widthIncrement", + "type" : "Number", + "desc" : "The increment to snap the width resize in pixels (dynamic must be true, defaults to 0)", + "memberOf" : "" + }, + { + "name" : "wrap", + "type" : "Boolean", + "desc" : "True to wrap an element with a div if needed (required for textareas and images, defaults to false)", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "beforeresize", + "type" : "function", + "desc" : "Fired before resize is allowed. Set enabled to false to cancel resize.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fired after a resize.", + "sig" : "function (_self, width, height, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "resizing", + "type" : "function", + "desc" : "Fired a resizing.", + "sig" : "function (_self, x, y, w, h, e)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this resizable. If the element was wrapped and\nremoveEl is not true then the element remains.", + "sig" : "(removeEl)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the element this component is bound to.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getResizeChild", + "type" : "function", + "desc" : "Returns the resizeChild element (or null).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "resizeTo", + "type" : "function", + "desc" : "Perform a manual resize", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.Shadow" : { + "props" : [ + { + "name" : "mode", + "type" : "String", + "desc" : "The shadow display mode. Supports the following options:
\nsides: Shadow displays on both sides and bottom only
\nframe: Shadow displays equally on all four sides
\ndrop: Traditional bottom-right drop shadow (default)", + "memberOf" : "Roo" + }, + { + "name" : "offset", + "type" : "String", + "desc" : "The number of pixels to offset the shadow from the element (defaults to 4)", + "memberOf" : "" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "hide", + "type" : "function", + "desc" : "Hides this shadow", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if the shadow is visible, else false", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "realign", + "type" : "function", + "desc" : "Direct alignment when values are already available. Show must be called at least once before\ncalling this method to ensure it is initialized.", + "sig" : "(left, top, width, height)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setZIndex", + "type" : "function", + "desc" : "Adjust the z-index of this shadow", + "sig" : "(zindex)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Displays the shadow under the target element", + "sig" : "(targetEl)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.SplitBar" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "beforeresize", + "type" : "function", + "desc" : "Fires before the splitter is dragged", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "moved", + "type" : "function", + "desc" : "Fires when the splitter is moved", + "sig" : "function (_self, newSize)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})", + "sig" : "function (_self, newSize)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroy this splitbar.", + "sig" : "(removeEl)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getAdapter", + "type" : "function", + "desc" : "Get the adapter this SplitBar uses", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getMaximumSize", + "type" : "function", + "desc" : "Gets the maximum size for the resizing element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getMinimumSize", + "type" : "function", + "desc" : "Gets the minimum size for the resizing element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "setAdapter", + "type" : "function", + "desc" : "Set the adapter this SplitBar uses", + "sig" : "(adapter)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setCurrentSize", + "type" : "function", + "desc" : "Sets the initialize size for the resizing element", + "sig" : "(size)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setMaximumSize", + "type" : "function", + "desc" : "Sets the maximum size for the resizing element", + "sig" : "(maxSize)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setMinimumSize", + "type" : "function", + "desc" : "Sets the minimum size for the resizing element", + "sig" : "(minSize)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.SplitBar.AbsoluteLayoutAdapter" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "getElementSize", + "type" : "function", + "desc" : "Called before drag operations to get the current size of the resizing element.", + "sig" : "(s)", + "static" : false, + "memberOf" : "Roo.SplitBar.BasicLayoutAdapter" + }, + { + "name" : "setElementSize", + "type" : "function", + "desc" : "Called after drag operations to set the size of the resizing element.", + "sig" : "(s, newSize, onComplete)", + "static" : false, + "memberOf" : "Roo.SplitBar.BasicLayoutAdapter" + } + ] + }, + "Roo.SplitBar.BasicLayoutAdapter" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "getElementSize", + "type" : "function", + "desc" : "Called before drag operations to get the current size of the resizing element.", + "sig" : "(s)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setElementSize", + "type" : "function", + "desc" : "Called after drag operations to set the size of the resizing element.", + "sig" : "(s, newSize, onComplete)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.SplitButton" : { + "props" : [ + { + "name" : "arrowHandler", + "type" : "Function", + "desc" : "A function called when the arrow button is clicked (can be used instead of click event)", + "memberOf" : "" + }, + { + "name" : "arrowTooltip", + "type" : "String", + "desc" : "The title attribute of the arrow", + "memberOf" : "" + }, + { + "name" : "clickEvent", + "type" : "String", + "desc" : "The type of event to map to the button's event handler (defaults to 'click')", + "memberOf" : "Roo.Button" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the button's main element.", + "memberOf" : "Roo.Button" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to start disabled (defaults to false)", + "memberOf" : "Roo.Button" + }, + { + "name" : "enableToggle", + "type" : "Boolean", + "desc" : "True to enable pressed/not pressed toggling (defaults to false)", + "memberOf" : "Roo.Button" + }, + { + "name" : "handleMouseEvents", + "type" : "Boolean", + "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)", + "memberOf" : "Roo.Button" + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function called when the button is clicked (can be used instead of click event)", + "memberOf" : "Roo.Button" + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to start hidden (defaults to false)", + "memberOf" : "Roo.Button" + }, + { + "name" : "icon", + "type" : "String", + "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")", + "memberOf" : "Roo.Button" + }, + { + "name" : "iconCls", + "type" : "String", + "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).", + "memberOf" : "Roo.Button" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "menu", + "type" : "Mixed", + "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).", + "memberOf" : "Roo.Button" + }, + { + "name" : "menuAlign", + "type" : "String", + "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').", + "memberOf" : "Roo.Button" + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum width for this button (used to give a set of buttons a common width)", + "memberOf" : "Roo.Button" + }, + { + "name" : "pressed", + "type" : "Boolean", + "desc" : "True to start pressed (only if enableToggle = true)", + "memberOf" : "Roo.Button" + }, + { + "name" : "renderTo", + "type" : "String/HTMLElement/Element", + "desc" : "The element to append the button to", + "memberOf" : "Roo.Button" + }, + { + "name" : "repeat", + "type" : "Boolean/Object", + "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).", + "memberOf" : "Roo.Button" + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "The scope of the handler", + "memberOf" : "Roo.Button" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The DOM tabIndex for this button (defaults to undefined)", + "memberOf" : "Roo.Button" + }, + { + "name" : "template", + "type" : "Roo.Template", + "desc" : "(Optional)\nAn {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.", + "memberOf" : "Roo.Button" + }, + { + "name" : "text", + "type" : "String", + "desc" : "The button text", + "memberOf" : "Roo.Button" + }, + { + "name" : "toggleGroup", + "type" : "String", + "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)", + "memberOf" : "Roo.Button" + }, + { + "name" : "tooltip", + "type" : "String/Object", + "desc" : "The tooltip for the button - can be a string or QuickTips config object", + "memberOf" : "Roo.Button" + }, + { + "name" : "tooltipType", + "type" : "String", + "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.", + "memberOf" : "Roo.Button" + }, + { + "name" : "type", + "type" : "String", + "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).", + "memberOf" : "Roo.Button" + } + ], + "events" : [ + { + "name" : "arrowclick", + "type" : "function", + "desc" : "Fires when this button's arrow is clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when this button is clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.Button" + }, + { + "name" : "mouseout", + "type" : "function", + "desc" : "Fires when the mouse exits the button", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.Button" + }, + { + "name" : "mouseover", + "type" : "function", + "desc" : "Fires when the mouse hovers over the button", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.Button" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires when the button is rendered", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Button" + }, + { + "name" : "toggle", + "type" : "function", + "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)", + "sig" : "function (_self, pressed)\n{\n\n}", + "memberOf" : "Roo.Button" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this Button and removes any listeners.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Focus the button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the button's underlying element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "getText", + "type" : "function", + "desc" : "Gets the text for this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "setArrowHandler", + "type" : "function", + "desc" : "Sets this button's arrow click handler", + "sig" : "(handler, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for boolean enable/disable", + "sig" : "(enabled)", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "setHandler", + "type" : "function", + "desc" : "Sets this button's click handler", + "sig" : "(handler, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setText", + "type" : "function", + "desc" : "Sets this button's text", + "sig" : "(text)", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function for boolean show/hide", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "toggle", + "type" : "function", + "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.", + "sig" : "(state)", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.SplitLayoutRegion" : { + "props" : [ + { + "name" : "alwaysShowTabs", + "type" : "Boolean", + "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "animate", + "type" : "Boolean", + "desc" : "True to animate expand/collapse (defaults to false)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "autoHide", + "type" : "Boolean", + "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to enable overflow scrolling (defaults to false)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "closeOnTab", + "type" : "Boolean", + "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "cmargins", + "type" : "Object", + "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "collapsed", + "type" : "Boolean", + "desc" : "True to set the initial display to collapsed (defaults to false)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "collapsedTitle", + "type" : "String", + "desc" : "Optional string message to display in the collapsed block of a north or south region", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "collapsible", + "type" : "Boolean", + "desc" : "False to disable collapsing (defaults to true)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "disableTabTips", + "type" : "Boolean", + "desc" : "True to disable tab tooltips", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "floatable", + "type" : "Boolean", + "desc" : "False to disable floating (defaults to true)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "For North/South panels", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to start the region hidden (defaults to false)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "hideTabs", + "type" : "Boolean", + "desc" : "True to hide the tab strip (defaults to false)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "hideWhenEmpty", + "type" : "Boolean", + "desc" : "True to hide the region when it has no panels", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "margins", + "type" : "Object", + "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "minTabWidth", + "type" : "Number", + "desc" : "The minimum tab width (defaults to 40)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "preferredTabWidth", + "type" : "Number", + "desc" : "The preferred tab width (defaults to 150)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "preservePanels", + "type" : "Boolean", + "desc" : "True to preserve removed panels so they can be readded later (defaults to false)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "resizeTabs", + "type" : "Boolean", + "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "showPin", + "type" : "Boolean", + "desc" : "True to show a pin button", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "split", + "type" : "Boolean", + "desc" : "To show the splitter", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "tabPosition", + "type" : "String", + "desc" : [ + "(top", + "bottom)" + ], + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title for the region (overrides panel titles)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "titlebar", + "type" : "Boolean", + "desc" : "True to display a title bar (defaults to true)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "toolbar", + "type" : "Boolean", + "desc" : "xtype configuration for a toolbar - shows on right of tabbar", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "For East/West panels", + "memberOf" : "Roo.LayoutRegion" + } + ], + "events" : [ + { + "name" : "beforecollapse", + "type" : "function", + "desc" : "Fires when this region before collapse.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "beforeremove", + "type" : "function", + "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.", + "sig" : "function (_self, panel, e)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "collapsed", + "type" : "function", + "desc" : "Fires when this region is collapsed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "expanded", + "type" : "function", + "desc" : "Fires when this region is expanded.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "invalidated", + "type" : "function", + "desc" : "Fires when the layout for this region is changed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "panelactivated", + "type" : "function", + "desc" : "Fires when a panel is activated.", + "sig" : "function (_self, panel)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "paneladded", + "type" : "function", + "desc" : "Fires when a panel is added.", + "sig" : "function (_self, panel)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "panelremoved", + "type" : "function", + "desc" : "Fires when a panel is removed.", + "sig" : "function (_self, panel)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "resized", + "type" : "function", + "desc" : "Fires when the user resizes this region.", + "sig" : "function (_self, newSize)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "slidehide", + "type" : "function", + "desc" : "Fires when this region slides out of view.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "slideshow", + "type" : "function", + "desc" : "Fires when this region is slid into view.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "visibilitychange", + "type" : "function", + "desc" : "Fires when this region is shown or hidden", + "sig" : "function (_self, visibility)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + } + ], + "methods" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Adds the passed ContentPanel(s) to this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "collapse", + "type" : "function", + "desc" : "Collapses this region.", + "sig" : "(skipAnim)", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Expands this region if it was previously collapsed.", + "sig" : "(e, skipAnim)", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getActivePanel", + "type" : "function", + "desc" : "Get the active panel for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the container element for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "getPanel", + "type" : "function", + "desc" : "Returns the panel specified or null if it's not in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Returns this regions position (north/south/east/west/center).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "getSplitBar", + "type" : "function", + "desc" : "Returns the {@link Roo.SplitBar} for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getTabs", + "type" : "function", + "desc" : "Returns the TabPanel component used by this region", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hasPanel", + "type" : "function", + "desc" : "Returns true if the panel is in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hides this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "hidePanel", + "type" : "function", + "desc" : "Hides the tab for the specified panel.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this region is currently visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", + "sig" : "(panel, preservePanel)", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "resizeTo", + "type" : "function", + "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", + "sig" : "(newSize)", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "setCollapsedTitle", + "type" : "function", + "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)", + "sig" : "(title)", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Shows this region if it was previously hidden.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "showPanel", + "type" : "function", + "desc" : "Shows the specified panel.", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unhidePanel", + "type" : "function", + "desc" : "Unhides the tab for a previously hidden panel.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + } + ] + }, + "Roo.TabPanel" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "beforetabchange", + "type" : "function", + "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change", + "sig" : "function (_self, e, tab)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "tabchange", + "type" : "function", + "desc" : "Fires when the active tab changes", + "sig" : "function (_self, activePanel)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addTab", + "type" : "function", + "desc" : "Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.", + "sig" : "(id, text, content, closable)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addTabItem", + "type" : "function", + "desc" : "Adds an existing {@link Roo.TabPanelItem}.", + "sig" : "(item)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "autoSizeTabs", + "type" : "function", + "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "beginUpdate", + "type" : "function", + "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this TabPanel", + "sig" : "(removeEl)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "disableTab", + "type" : "function", + "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "enableTab", + "type" : "function", + "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "endUpdate", + "type" : "function", + "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getActiveTab", + "type" : "function", + "desc" : "Gets the active {@link Roo.TabPanelItem}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getCount", + "type" : "function", + "desc" : "Returns the number of tabs in this TabPanel.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getTab", + "type" : "function", + "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hideTab", + "type" : "function", + "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeTab", + "type" : "function", + "desc" : "Removes a {@link Roo.TabPanelItem}.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setTabWidth", + "type" : "function", + "desc" : "Resizes all the tabs to the passed width", + "sig" : "(The)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "syncHeight", + "type" : "function", + "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling", + "sig" : "(targetHeight)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unhideTab", + "type" : "function", + "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.TabPanelItem" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Fires when this tab becomes the active tab.", + "sig" : "function (tabPanel, _self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeclose", + "type" : "function", + "desc" : "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "close", + "type" : "function", + "desc" : "Fires when this tab is closed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "deactivate", + "type" : "function", + "desc" : "Fires when this tab is no longer the active tab.", + "sig" : "function (tabPanel, _self)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Activates this TabPanelItem -- this does deactivate the currently active TabPanelItem.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enables this TabPanelItem if it was previously disabled.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getText", + "type" : "function", + "desc" : "Returns the text for this tab", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getUpdateManager", + "type" : "function", + "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isActive", + "type" : "function", + "desc" : "Returns true if this tab is the active tab.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isHidden", + "type" : "function", + "desc" : "Returns true if this tab is \"hidden\"", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "refresh", + "type" : "function", + "desc" : "Forces a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the setUrl method has not been called.\n This does not activate the panel, just updates its content.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "setContent", + "type" : "function", + "desc" : "Sets the content for this TabPanelItem.", + "sig" : "(content, loadScripts)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setHidden", + "type" : "function", + "desc" : "Show or hide the tab", + "sig" : "(hidden)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setText", + "type" : "function", + "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)", + "sig" : "(text)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setTooltip", + "type" : "function", + "desc" : "Set the tooltip for the tab.", + "sig" : "(tooltip)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setUrl", + "type" : "function", + "desc" : "Set a URL to be used to load the content for this TabPanelItem.", + "sig" : "(url, params, loadOnce)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Shows this TabPanelItem -- this does not deactivate the currently active TabPanelItem.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.Template" : { + "props" : [ + { + "name" : "html", + "type" : "String", + "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")", + "memberOf" : "" + }, + { + "name" : "url", + "type" : "String", + "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...", + "memberOf" : "" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "append", + "type" : "function", + "desc" : "Applies the supplied values to the template and appends the new node(s) to el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "apply", + "type" : "function", + "desc" : "Alias for {@link #applyTemplate}", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "applyTemplate", + "type" : "function", + "desc" : "Returns an HTML fragment of this template with the specified values applied.", + "sig" : "(values)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "compile", + "type" : "function", + "desc" : "Compiles the template into an internal function, eliminating the RegEx overhead.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "from", + "type" : "function", + "desc" : "Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML.", + "sig" : "(el)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "insertAfter", + "type" : "function", + "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "insertBefore", + "type" : "function", + "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "insertFirst", + "type" : "function", + "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "overwrite", + "type" : "function", + "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "set", + "type" : "function", + "desc" : "Sets the HTML used as the template and optionally compiles it.", + "sig" : "(html, compile)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.Toolbar" : { + "props" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "The id or element that will contain the toolbar", + "memberOf" : "" + }, + { + "name" : "items", + "type" : "Array", + "desc" : "array of button configs or elements to add (will be converted to a MixedCollection)", + "memberOf" : "Roo" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Adds element(s) to the toolbar -- this function takes a variable number of \narguments of mixed type and adds them to the toolbar.", + "sig" : "(arg1, arg2)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addButton", + "type" : "function", + "desc" : "Adds a button (or buttons). See {@link Roo.Toolbar.Button} for more info on the config.", + "sig" : "(config)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addDom", + "type" : "function", + "desc" : "Adds a new element to the toolbar from the passed {@link Roo.DomHelper} config.", + "sig" : "(config)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addElement", + "type" : "function", + "desc" : "Adds any standard HTML element to the toolbar", + "sig" : "(el)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addField", + "type" : "function", + "desc" : "Adds a dynamically rendered Roo.form field (TextField, ComboBox, etc).\nNote: the field should not have been rendered yet. For a field that has already been\nrendered, use {@link #addElement}.", + "sig" : "(field)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addFill", + "type" : "function", + "desc" : "Adds a fill element that forces subsequent additions to the right side of the toolbar", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addItem", + "type" : "function", + "desc" : "Adds any Toolbar.Item or subclass", + "sig" : "(item)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addSeparator", + "type" : "function", + "desc" : "Adds a separator", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addSpacer", + "type" : "function", + "desc" : "Adds a spacer element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addText", + "type" : "function", + "desc" : "Adds text to the toolbar", + "sig" : "(text)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addxtype", + "type" : "function", + "desc" : "Add an Xtype element", + "sig" : "(xtype)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the Element for this toolbar.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide the toolbar", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "insertButton", + "type" : "function", + "desc" : "Inserts any {@link Roo.Toolbar.Item}/{@link Roo.Toolbar.Button} at the specified index.", + "sig" : "(index, item)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show the toolbar", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.Toolbar.Button" : { + "props" : [ + { + "name" : "clickEvent", + "type" : "String", + "desc" : "The type of event to map to the button's event handler (defaults to 'click')", + "memberOf" : "Roo.Button" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the button's main element.", + "memberOf" : "Roo.Button" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to start disabled (defaults to false)", + "memberOf" : "Roo.Button" + }, + { + "name" : "enableToggle", + "type" : "Boolean", + "desc" : "True to enable pressed/not pressed toggling (defaults to false)", + "memberOf" : "Roo.Button" + }, + { + "name" : "handleMouseEvents", + "type" : "Boolean", + "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)", + "memberOf" : "Roo.Button" + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function called when the button is clicked (can be used instead of click event)", + "memberOf" : "Roo.Button" + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to start hidden (defaults to false)", + "memberOf" : "Roo.Button" + }, + { + "name" : "icon", + "type" : "String", + "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")", + "memberOf" : "Roo.Button" + }, + { + "name" : "iconCls", + "type" : "String", + "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).", + "memberOf" : "Roo.Button" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "menu", + "type" : "Mixed", + "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).", + "memberOf" : "Roo.Button" + }, + { + "name" : "menuAlign", + "type" : "String", + "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').", + "memberOf" : "Roo.Button" + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum width for this button (used to give a set of buttons a common width)", + "memberOf" : "Roo.Button" + }, + { + "name" : "pressed", + "type" : "Boolean", + "desc" : "True to start pressed (only if enableToggle = true)", + "memberOf" : "Roo.Button" + }, + { + "name" : "renderTo", + "type" : "String/HTMLElement/Element", + "desc" : "The element to append the button to", + "memberOf" : "Roo.Button" + }, + { + "name" : "repeat", + "type" : "Boolean/Object", + "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).", + "memberOf" : "Roo.Button" + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "The scope of the handler", + "memberOf" : "Roo.Button" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The DOM tabIndex for this button (defaults to undefined)", + "memberOf" : "Roo.Button" + }, + { + "name" : "template", + "type" : "Roo.Template", + "desc" : "(Optional)\nAn {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.", + "memberOf" : "Roo.Button" + }, + { + "name" : "text", + "type" : "String", + "desc" : "The button text", + "memberOf" : "Roo.Button" + }, + { + "name" : "toggleGroup", + "type" : "String", + "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)", + "memberOf" : "Roo.Button" + }, + { + "name" : "tooltip", + "type" : "String/Object", + "desc" : "The tooltip for the button - can be a string or QuickTips config object", + "memberOf" : "Roo.Button" + }, + { + "name" : "tooltipType", + "type" : "String", + "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.", + "memberOf" : "Roo.Button" + }, + { + "name" : "type", + "type" : "String", + "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).", + "memberOf" : "Roo.Button" + } + ], + "events" : [ + { + "name" : "click", + "type" : "function", + "desc" : "Fires when this button is clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.Button" + }, + { + "name" : "mouseout", + "type" : "function", + "desc" : "Fires when the mouse exits the button", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.Button" + }, + { + "name" : "mouseover", + "type" : "function", + "desc" : "Fires when the mouse hovers over the button", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.Button" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires when the button is rendered", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Button" + }, + { + "name" : "toggle", + "type" : "function", + "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)", + "sig" : "function (_self, pressed)\n{\n\n}", + "memberOf" : "Roo.Button" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Removes and destroys this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disables this item", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enables this item", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Focus the button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the button's underlying element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "getText", + "type" : "function", + "desc" : "Gets the text for this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hides this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for boolean enable/disable", + "sig" : "(enabled)", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "setHandler", + "type" : "function", + "desc" : "Assigns this button's click handler", + "sig" : "(handler, scope)", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "setText", + "type" : "function", + "desc" : "Sets this button's text", + "sig" : "(text)", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function for boolean show/hide", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Shows this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "toggle", + "type" : "function", + "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.", + "sig" : "(state)", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.Toolbar.Fill" : { + "props" : [ + ], + "events" : [ + { + "name" : "render", + "type" : "function", + "desc" : "Fires when the button is rendered", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Toolbar.Item" + } + ], + "methods" : [ + { + "name" : "destroy", + "type" : "function", + "desc" : "Removes and destroys this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Get this item's HTML Element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hides this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function for boolean show/hide.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Shows this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + } + ] + }, + "Roo.Toolbar.Item" : { + "props" : [ + ], + "events" : [ + { + "name" : "render", + "type" : "function", + "desc" : "Fires when the button is rendered", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "destroy", + "type" : "function", + "desc" : "Removes and destroys this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Get this item's HTML Element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hides this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function for boolean show/hide.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Shows this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.Toolbar.Separator" : { + "props" : [ + ], + "events" : [ + { + "name" : "render", + "type" : "function", + "desc" : "Fires when the button is rendered", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Toolbar.Item" + } + ], + "methods" : [ + { + "name" : "destroy", + "type" : "function", + "desc" : "Removes and destroys this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Get this item's HTML Element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hides this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function for boolean show/hide.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Shows this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + } + ] + }, + "Roo.Toolbar.Spacer" : { + "props" : [ + ], + "events" : [ + { + "name" : "render", + "type" : "function", + "desc" : "Fires when the button is rendered", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Toolbar.Item" + } + ], + "methods" : [ + { + "name" : "destroy", + "type" : "function", + "desc" : "Removes and destroys this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Get this item's HTML Element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hides this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function for boolean show/hide.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Shows this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + } + ] + }, + "Roo.Toolbar.SplitButton" : { + "props" : [ + { + "name" : "arrowHandler", + "type" : "Function", + "desc" : "A function called when the arrow button is clicked (can be used instead of click event)", + "memberOf" : "Roo.SplitButton" + }, + { + "name" : "arrowTooltip", + "type" : "String", + "desc" : "The title attribute of the arrow", + "memberOf" : "Roo.SplitButton" + }, + { + "name" : "clickEvent", + "type" : "String", + "desc" : "The type of event to map to the button's event handler (defaults to 'click')", + "memberOf" : "Roo.Button" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the button's main element.", + "memberOf" : "Roo.Button" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to start disabled (defaults to false)", + "memberOf" : "Roo.Button" + }, + { + "name" : "enableToggle", + "type" : "Boolean", + "desc" : "True to enable pressed/not pressed toggling (defaults to false)", + "memberOf" : "Roo.Button" + }, + { + "name" : "handleMouseEvents", + "type" : "Boolean", + "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)", + "memberOf" : "Roo.Button" + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function called when the button is clicked (can be used instead of click event)", + "memberOf" : "Roo.Button" + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to start hidden (defaults to false)", + "memberOf" : "Roo.Button" + }, + { + "name" : "icon", + "type" : "String", + "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")", + "memberOf" : "Roo.Button" + }, + { + "name" : "iconCls", + "type" : "String", + "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).", + "memberOf" : "Roo.Button" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "menu", + "type" : "Mixed", + "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).", + "memberOf" : "Roo.Button" + }, + { + "name" : "menuAlign", + "type" : "String", + "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').", + "memberOf" : "Roo.Button" + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum width for this button (used to give a set of buttons a common width)", + "memberOf" : "Roo.Button" + }, + { + "name" : "pressed", + "type" : "Boolean", + "desc" : "True to start pressed (only if enableToggle = true)", + "memberOf" : "Roo.Button" + }, + { + "name" : "renderTo", + "type" : "String/HTMLElement/Element", + "desc" : "The element to append the button to", + "memberOf" : "Roo.Button" + }, + { + "name" : "repeat", + "type" : "Boolean/Object", + "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).", + "memberOf" : "Roo.Button" + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "The scope of the handler", + "memberOf" : "Roo.Button" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The DOM tabIndex for this button (defaults to undefined)", + "memberOf" : "Roo.Button" + }, + { + "name" : "template", + "type" : "Roo.Template", + "desc" : "(Optional)\nAn {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.", + "memberOf" : "Roo.Button" + }, + { + "name" : "text", + "type" : "String", + "desc" : "The button text", + "memberOf" : "Roo.Button" + }, + { + "name" : "toggleGroup", + "type" : "String", + "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)", + "memberOf" : "Roo.Button" + }, + { + "name" : "tooltip", + "type" : "String/Object", + "desc" : "The tooltip for the button - can be a string or QuickTips config object", + "memberOf" : "Roo.Button" + }, + { + "name" : "tooltipType", + "type" : "String", + "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.", + "memberOf" : "Roo.Button" + }, + { + "name" : "type", + "type" : "String", + "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).", + "memberOf" : "Roo.Button" + } + ], + "events" : [ + { + "name" : "arrowclick", + "type" : "function", + "desc" : "Fires when this button's arrow is clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.SplitButton" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when this button is clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.Button" + }, + { + "name" : "mouseout", + "type" : "function", + "desc" : "Fires when the mouse exits the button", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.Button" + }, + { + "name" : "mouseover", + "type" : "function", + "desc" : "Fires when the mouse hovers over the button", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.Button" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires when the button is rendered", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Button" + }, + { + "name" : "toggle", + "type" : "function", + "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)", + "sig" : "function (_self, pressed)\n{\n\n}", + "memberOf" : "Roo.Button" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Removes and destroys this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Focus the button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.SplitButton" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the button's underlying element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "getText", + "type" : "function", + "desc" : "Gets the text for this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hides this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "setArrowHandler", + "type" : "function", + "desc" : "Sets this button's arrow click handler", + "sig" : "(handler, scope)", + "static" : false, + "memberOf" : "Roo.SplitButton" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for boolean enable/disable", + "sig" : "(enabled)", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "setHandler", + "type" : "function", + "desc" : "Sets this button's click handler", + "sig" : "(handler, scope)", + "static" : false, + "memberOf" : "Roo.SplitButton" + }, + { + "name" : "setText", + "type" : "function", + "desc" : "Sets this button's text", + "sig" : "(text)", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function for boolean show/hide", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Shows this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "toggle", + "type" : "function", + "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.", + "sig" : "(state)", + "static" : false, + "memberOf" : "Roo.Button" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.Toolbar.TextItem" : { + "props" : [ + ], + "events" : [ + { + "name" : "render", + "type" : "function", + "desc" : "Fires when the button is rendered", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Toolbar.Item" + } + ], + "methods" : [ + { + "name" : "destroy", + "type" : "function", + "desc" : "Removes and destroys this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Get this item's HTML Element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hides this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function for boolean show/hide.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Shows this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item" + } + ] + }, + "Roo.TreePanel" : { + "props" : [ + { + "name" : "adjustments", + "type" : "Array", + "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "background", + "type" : "Boolean", + "desc" : "True if the panel should not be activated when it is added (defaults to false)", + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "True if the panel can be closed/removed", + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "content", + "type" : "String", + "desc" : "Raw content to fill content panel with (uses setContent on construction.)", + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "fitContainer", + "type" : "Boolean", + "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "fitToFrame", + "type" : "Boolean", + "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "region", + "type" : "String", + "desc" : [ + "(center", + "north", + "south", + "east", + "west)" + ], + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "resizeEl", + "type" : "String/HTMLElement/Element", + "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title for this panel", + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "toolbar", + "type" : "Toolbar", + "desc" : "A toolbar for this panel", + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "tree", + "type" : "Roo.tree.TreePanel", + "desc" : "The tree TreePanel, with config etc.", + "memberOf" : "Roo" + }, + { + "name" : "url", + "type" : "String", + "desc" : "Calls {@link #setUrl} with this value", + "memberOf" : "Roo.ContentPanel" + } + ], + "events" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Fires when this panel is activated.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "deactivate", + "type" : "function", + "desc" : "Fires when this panel is activated.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires when this tab is created", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires when this panel is resized if fitToFrame is true.", + "sig" : "function (_self, width, height)\n{\n\n}", + "memberOf" : "Roo.ContentPanel" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addxtype", + "type" : "function", + "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this panel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns this panel's element - used by regiosn to add.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns this panel's id", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "getTitle", + "type" : "function", + "desc" : "Returns this panel's title", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "getToolbar", + "type" : "function", + "desc" : "Returns the toolbar for this Panel if one was configured.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "getUpdateManager", + "type" : "function", + "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "isClosable", + "type" : "function", + "desc" : "Returns true is this panel was configured to be closable", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.", + "sig" : "(url, params, callback, discardUrl)", + "static" : false, + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "refresh", + "type" : "function", + "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "setContent", + "type" : "function", + "desc" : "Updates this panel's element", + "sig" : "(content, loadScripts)", + "static" : false, + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "setTitle", + "type" : "function", + "desc" : "Set this panel's title", + "sig" : "(title)", + "static" : false, + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "setUrl", + "type" : "function", + "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "sig" : "(url, params, loadOnce)", + "static" : false, + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.UpdateManager" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "beforeupdate", + "type" : "function", + "desc" : "Fired before an update is made, return false from your handler and the update is cancelled.", + "sig" : "function (el, url, params)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "failure", + "type" : "function", + "desc" : "Fired on update failure.", + "sig" : "function (el, oResponseObject)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "update", + "type" : "function", + "desc" : "Fired after successful update is made.", + "sig" : "function (el, oResponseObject)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "abort", + "type" : "function", + "desc" : "Aborts the executing transaction", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "formUpdate", + "type" : "function", + "desc" : "Performs an async form post, updating this element with the response. If the form has the attribute enctype=\"multipart/form-data\", it assumes it's a file upload.\nUses this.sslBlankUrl for SSL file uploads to prevent IE security warning.", + "sig" : "(form, url, reset, callback)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Get the Element this UpdateManager is bound to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "isUpdating", + "type" : "function", + "desc" : "Returns true if an update is in progress", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "refresh", + "type" : "function", + "desc" : "Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately", + "sig" : "(callback)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "setDefaultUrl", + "type" : "function", + "desc" : "Set the defaultUrl used for updates", + "sig" : "(defaultUrl)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setRenderer", + "type" : "function", + "desc" : "Set the content renderer for this UpdateManager. See {@link Roo.UpdateManager.BasicRenderer#render} for more details.", + "sig" : "(renderer)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "showLoading", + "type" : "function", + "desc" : "Called to update the element to \"Loading\" state. Override to perform custom action.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "startAutoRefresh", + "type" : "function", + "desc" : "Set this element to auto refresh.", + "sig" : "(interval, url, params, callback, refreshNow)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "stopAutoRefresh", + "type" : "function", + "desc" : "Stop auto refresh on this element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "update", + "type" : "function", + "desc" : "Performs an async request, updating this element with the response. If params are specified it uses POST, otherwise it uses GET.", + "sig" : "(url, params, callback, discardUrl)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "updateElement", + "type" : "function", + "desc" : "Static convenience method. This method is deprecated in favor of el.load({url:'foo.php', ...}).\nUsage:\n
Roo.UpdateManager.updateElement(\"my-div\", \"stuff.php\");
", + "sig" : "(el, url, params, options)", + "static" : true, + "memberOf" : "" + } + ] + }, + "Roo.UpdateManager.BasicRenderer" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "render", + "type" : "function", + "desc" : "This is called when the transaction is completed and it's time to update the element - The BasicRenderer\nupdates the elements innerHTML with the responseText - To perform a custom render (i.e. XML or JSON processing),\ncreate an object with a \"render(el, response)\" method and pass it to setRenderer on the UpdateManager.", + "sig" : "(el, response, updateManager, callback)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.UpdateManager.defaults" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.View" : { + "props" : [ + { + "name" : "dataName", + "type" : "String", + "desc" : "the named area of the template to use as the data area\n Works with domtemplates roo-name=\"name\"", + "memberOf" : "" + }, + { + "name" : "el", + "type" : "String|Roo.Element", + "desc" : "The container element.", + "memberOf" : "" + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The empty text to show when nothing is loaded.", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "multiSelect", + "type" : "Boolean", + "desc" : "Allow multiple selection", + "memberOf" : "" + }, + { + "name" : "selectedClass", + "type" : "String", + "desc" : "The css class to add to selected nodes", + "memberOf" : "" + }, + { + "name" : "singleSelect", + "type" : "Boolean", + "desc" : "Allow single selection", + "memberOf" : "" + }, + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "Data store to load data from.", + "memberOf" : "" + }, + { + "name" : "text", + "type" : "String", + "desc" : "to display on mask (default Loading)", + "memberOf" : "" + }, + { + "name" : "tickable", + "type" : "Boolean", + "desc" : "- selecting", + "memberOf" : "" + }, + { + "name" : "toggleSelect", + "type" : "Boolean", + "desc" : "- selecting", + "memberOf" : "" + }, + { + "name" : "tpl", + "type" : "String|Roo.Template", + "desc" : "The template used by this View", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "beforeclick", + "type" : "function", + "desc" : "Fires before a click is processed. Returns false to cancel the default action.", + "sig" : "function (_self, index, node, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeselect", + "type" : "function", + "desc" : "Fires before a selection is made. If any handlers return false, the selection is cancelled.", + "sig" : "function (_self, node, selections)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when a template node is clicked.", + "sig" : "function (_self, index, node, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "contextmenu", + "type" : "function", + "desc" : "Fires when a template node is right clicked.", + "sig" : "function (_self, index, node, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "dblclick", + "type" : "function", + "desc" : "Fires when a template node is double clicked.", + "sig" : "function (_self, index, node, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "preparedata", + "type" : "function", + "desc" : "Fires on every row to render, to allow you to change the data.", + "sig" : "function (_self, data)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "selectionchange", + "type" : "function", + "desc" : "Fires when the selected nodes change.", + "sig" : "function (_self, selections)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearSelections", + "type" : "function", + "desc" : "Clear all selections", + "sig" : "(suppressEvent)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "findItemFromChild", + "type" : "function", + "desc" : "Returns the template node the passed child belongs to or null if it doesn't belong to one.", + "sig" : "(node)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the element this view is bound to.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getNode", + "type" : "function", + "desc" : "Gets a template node.", + "sig" : "(nodeInfo)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getNodes", + "type" : "function", + "desc" : "Gets a range template nodes.", + "sig" : "(startIndex, endIndex)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getSelectedIndexes", + "type" : "function", + "desc" : "Get the indexes of the selected nodes.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getSelectedNodes", + "type" : "function", + "desc" : "Get the currently selected nodes.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getSelectionCount", + "type" : "function", + "desc" : "Get the number of selected nodes.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "indexOf", + "type" : "function", + "desc" : "Finds the index of the passed node", + "sig" : "(nodeInfo)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isSelected", + "type" : "function", + "desc" : "Returns true if the passed node is selected", + "sig" : "(node)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onBeforeLoad", + "type" : "function", + "desc" : "onbeforeLoad - masks the loading area.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "prepareData", + "type" : "function", + "desc" : "Function to override to reformat the data that is sent to\nthe template for each node.\nDEPRICATED - use the preparedata event handler.", + "sig" : "(data)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "refresh", + "type" : "function", + "desc" : "Refreshes the view. - called by datachanged on the store. - do not call directly.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "refreshNode", + "type" : "function", + "desc" : "Refresh an individual node.", + "sig" : "(index)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Selects nodes.", + "sig" : "(nodeInfo, keepExisting, suppressEvent)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setStore", + "type" : "function", + "desc" : "Changes the data store this view uses and refresh the view.", + "sig" : "(store)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unselect", + "type" : "function", + "desc" : "Unselects nodes.", + "sig" : "(nodeInfo, keepExisting, suppressEvent)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.XComponent" : { + "props" : [ + { + "name" : "disabled", + "type" : "Function|boolean", + "desc" : "If this module is disabled by some rule, return true from the funtion", + "memberOf" : "" + }, + { + "name" : "items", + "type" : "Array", + "desc" : "A single item array - the first element is the root of the tree..\nIt's done this way to stay compatible with the Xtype system...", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "String", + "desc" : "String to display while loading.", + "memberOf" : "" + }, + { + "name" : "order", + "type" : "String", + "desc" : "Used to set the order in which elements are created (usefull for multiple tabs)", + "memberOf" : "" + }, + { + "name" : "parent", + "type" : "String", + "desc" : "Name of parent element which it get xtype added to..", + "memberOf" : "" + }, + { + "name" : "region", + "type" : "String", + "desc" : "Region to render component to (defaults to center)", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "built", + "type" : "function", + "desc" : "Fires when this the componnt is built", + "sig" : "function (c)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "build", + "type" : "function", + "desc" : "Build the registered modules.", + "sig" : "(parent, optional)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "buildOrder", + "type" : "function", + "desc" : "make a list of modules to build.", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "overlayStrings", + "type" : "function", + "desc" : "Overlay a set of modified strings onto a component\nThis is dependant on our builder exporting the strings and 'named strings' elements.", + "sig" : "(element, associative)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "preBuild", + "type" : "function", + "desc" : "move modules into their correct place in the tree..", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "register", + "type" : "function", + "desc" : "Register components to be built later.\n\nThis solves the following issues\n- Building is not done on page load, but after an authentication process has occured.\n- Interface elements are registered on page load\n- Parent Interface elements may not be loaded before child, so this handles that..\n\n\nexample:\n\nMyApp.register({\n order : '000001',\n module : 'Pman.Tab.projectMgr',\n region : 'center',\n parent : 'Pman.layout',\n disabled : false, // or use a function..\n })\n* @param {Object} details about module", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "render\nrender element to dom or tree", + "sig" : "(optional)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "toObject", + "type" : "function", + "desc" : "convert a string to an object..\neg. 'AAA.BBB' -> finds AAA.BBB", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.XComponent.event.events" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.XTemplate" : { + "props" : [ + { + "name" : "html", + "type" : "String", + "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")", + "memberOf" : "Roo.Template" + }, + { + "name" : "url", + "type" : "String", + "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...", + "memberOf" : "Roo.Template" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "append", + "type" : "function", + "desc" : "Applies the supplied values to the template and appends the new node(s) to el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template" + }, + { + "name" : "apply", + "type" : "function", + "desc" : "Alias for {@link #applyTemplate}", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Template" + }, + { + "name" : "applySubTemplate", + "type" : "function", + "desc" : "same as applyTemplate, except it's done to one of the subTemplates\nwhen using named templates, you can do:\n\nvar str = pl.applySubTemplate('your-name', values);", + "sig" : "(id, values, parent)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "applyTemplate", + "type" : "function", + "desc" : "Returns an HTML fragment of this template with the specified values applied.", + "sig" : "(values)", + "static" : false, + "memberOf" : "Roo.Template" + }, + { + "name" : "compile", + "type" : "function", + "desc" : "compile the template\n\nThis is not recursive, so I'm not sure how nested templates are really going to be handled..", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "from", + "type" : "function", + "desc" : "Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML.", + "sig" : "(el)", + "static" : true, + "memberOf" : "Roo.Template" + }, + { + "name" : "insertAfter", + "type" : "function", + "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template" + }, + { + "name" : "insertBefore", + "type" : "function", + "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template" + }, + { + "name" : "insertFirst", + "type" : "function", + "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template" + }, + { + "name" : "overwrite", + "type" : "function", + "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template" + }, + { + "name" : "set", + "type" : "function", + "desc" : "Sets the HTML used as the template and optionally compiles it.", + "sig" : "(html, compile)", + "static" : false, + "memberOf" : "Roo.Template" + } + ] + }, + "Roo.bootstrap" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.bootstrap.Alert" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "faicon", + "type" : "String", + "desc" : "font-awesomeicon", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "html", + "type" : "String", + "desc" : "The content of alert", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title of alert", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "weight", + "type" : "String", + "desc" : [ + "( success", + "info", + "warning", + "danger )" + ], + "memberOf" : "" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.BezierSignature" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.Body" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.Brick" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "bgimage", + "type" : "String", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "href", + "type" : "String", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "square", + "type" : "Boolean", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "title", + "type" : "String", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "video", + "type" : "String", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "When a Brick is click", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.Button" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "badge", + "type" : "String", + "desc" : "text for badge", + "memberOf" : "" + }, + { + "name" : "badge_weight", + "type" : "String", + "desc" : [ + "(default", + "primary", + "secondary", + "success", + "info", + "warning", + "danger", + "link )" + ], + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "default false;", + "memberOf" : "" + }, + { + "name" : "fa", + "type" : "String", + "desc" : "fontawesome icon - eg. 'comment' - without the fa/fas etc..", + "memberOf" : "" + }, + { + "name" : "glyphicon", + "type" : "String", + "desc" : "depricated - use fa", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "href", + "type" : "String", + "desc" : "empty or href", + "memberOf" : "" + }, + { + "name" : "html", + "type" : "String", + "desc" : "The button content", + "memberOf" : "" + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "dark themed version", + "memberOf" : "" + }, + { + "name" : "isClose", + "type" : "Boolean", + "desc" : "default false;", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "offtext", + "type" : "String", + "desc" : "text for off slidy toggle state", + "memberOf" : "" + }, + { + "name" : "ontext", + "type" : "String", + "desc" : "text for on slidy toggle state", + "memberOf" : "" + }, + { + "name" : "outline", + "type" : "Boolean", + "desc" : "default false (except for weight=default which emulates old behaveiour with an outline)", + "memberOf" : "" + }, + { + "name" : "pressed", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : "default true (stop click event triggering the URL if it's a link.)", + "memberOf" : "" + }, + { + "name" : "removeClass", + "type" : "Boolean", + "desc" : "remove the standard class..", + "memberOf" : "" + }, + { + "name" : "size", + "type" : "String", + "desc" : [ + "( lg", + "sm", + "xs)" + ], + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tag", + "type" : "String", + "desc" : [ + "( a", + "input", + "submit)" + ], + "memberOf" : "" + }, + { + "name" : "target", + "type" : "String", + "desc" : "target for a href. (_self|_blank|_parent|_top| other)", + "memberOf" : "" + }, + { + "name" : "theme", + "type" : "String", + "desc" : [ + "(default", + "glow)" + ], + "memberOf" : "" + }, + { + "name" : "toggle", + "type" : "Boolean", + "desc" : "is it a slidy toggle button", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "weight", + "type" : "String", + "desc" : [ + "(default", + "primary", + "secondary", + "success", + "info", + "warning", + "danger", + "link )" + ], + "memberOf" : "" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "When a butotn is pressed", + "sig" : "function (btn, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "toggle", + "type" : "function", + "desc" : "After the button has been toggles", + "sig" : "function (btn, e, pressed)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enables this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getText", + "type" : "function", + "desc" : "get the text of the first selected button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isActive", + "type" : "function", + "desc" : "get the current active state", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setActive", + "type" : "function", + "desc" : "sets the active state on/off,", + "sig" : "(state)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setText", + "type" : "function", + "desc" : "set the text of the first selected button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "toggleActive", + "type" : "function", + "desc" : "toggles the current active state", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.ButtonGroup" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "align", + "type" : "String", + "desc" : "vertical | justified (default none)", + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "btn", + "type" : "Boolean", + "desc" : "true | false", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "direction", + "type" : "String", + "desc" : "up | down (default down)", + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "size", + "type" : "String", + "desc" : "lg | sm | xs (default empty normal)", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "toolbar", + "type" : "Boolean", + "desc" : "false | true", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addItem", + "type" : "function", + "desc" : "Add a button to the group (similar to NavItem API.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.Calendar" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "header", + "type" : "Object", + "desc" : "generate the user specific header of the calendar, default false", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadMask", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "startDay", + "type" : "Number", + "desc" : "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "eventclick", + "type" : "function", + "desc" : "Fires when the mouse click an", + "sig" : "function (_self, )\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "evententer", + "type" : "function", + "desc" : "Fires when mouse over an event", + "sig" : "function (_self, Event)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "eventleave", + "type" : "function", + "desc" : "Fires when the mouse leaves an", + "sig" : "function (_self, )\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "monthchange", + "type" : "function", + "desc" : "Fires when the displayed month changes", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Fires when a date is selected", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.CheckBox" : { + "props" : [ + { + "name" : "accept", + "type" : "String", + "desc" : [ + "(image", + "video", + "audio)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "center", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "boxLabel", + "type" : "String", + "desc" : "The text that appears beside the checkbox", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "capture", + "type" : "String", + "desc" : [ + "(user", + "camera)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "initnal the element", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "groupId", + "type" : "String", + "desc" : "the checkbox group id // normal just use for checkbox", + "memberOf" : "" + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "inline", + "type" : "Boolean", + "desc" : "inline the element (default false)", + "memberOf" : "" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "inputValue", + "type" : "String", + "desc" : "The value that should go into the generated input element's value when checked.", + "memberOf" : "" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : [ + "(top", + "left)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "String", + "desc" : "label tooltip", + "memberOf" : "" + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "valueOff", + "type" : "String", + "desc" : "The value that should go into the generated input element's value when unchecked.", + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "weight", + "type" : "String", + "desc" : [ + "(primary", + "warning", + "info", + "danger", + "success)" + ], + "memberOf" : "" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "check", + "type" : "function", + "desc" : "Fires when the element is checked or unchecked.", + "sig" : "function (_self, checked)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when the element is click.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "get", + "type" : "function", + "desc" : "fetch a CheckBox Group based on the group ID", + "sig" : "(the)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "inputEl", + "type" : "function", + "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "markValid", + "type" : "function", + "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "register", + "type" : "function", + "desc" : "register a CheckBox Group", + "sig" : "(the)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + } + ] + }, + "Roo.bootstrap.Column" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "alert", + "type" : "String", + "desc" : [ + "(success", + "info", + "warning", + "danger)" + ], + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "fa", + "type" : "String", + "desc" : [ + "(ban", + "check", + "...)" + ], + "memberOf" : "" + }, + { + "name" : "fasize", + "type" : "Number", + "desc" : [ + "(1", + "2", + "....)" + ], + "memberOf" : "" + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "html", + "type" : "String", + "desc" : "content of column.", + "memberOf" : "" + }, + { + "name" : "icon", + "type" : "String", + "desc" : [ + "(info-sign", + "check", + "...)" + ], + "memberOf" : "" + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden", + "memberOf" : "" + }, + { + "name" : "lgoff", + "type" : "Number", + "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens or 0 for hidden", + "memberOf" : "" + }, + { + "name" : "mdoff", + "type" : "Number", + "desc" : "colspan offset out of 12 for computer-sized screens or 0 for hidden", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden", + "memberOf" : "" + }, + { + "name" : "smoff", + "type" : "Number", + "desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens or 0 for hidden", + "memberOf" : "" + }, + { + "name" : "xsoff", + "type" : "Number", + "desc" : "colspan offset out of 12 for mobile-sized screens or 0 for hidden", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.ComboBox" : { + "props" : [ + { + "name" : "accept", + "type" : "String", + "desc" : [ + "(image", + "video", + "audio)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "center", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allQuery", + "type" : "String", + "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')", + "memberOf" : "" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "alwaysQuery", + "type" : "Boolean", + "desc" : "Disable caching of results, and always send query", + "memberOf" : "" + }, + { + "name" : "animate", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "" + }, + { + "name" : "append", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})", + "memberOf" : "" + }, + { + "name" : "autoFocus", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "blockFocus", + "type" : "Boolean", + "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar", + "memberOf" : "" + }, + { + "name" : "btnPosition", + "type" : "String", + "desc" : "set the position of the trigger button (left | right) default right", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "capture", + "type" : "String", + "desc" : [ + "(user", + "camera)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "caret", + "type" : "String", + "desc" : [ + "(search", + "calendar)" + ], + "memberOf" : "Roo.bootstrap.TriggerField" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableClear", + "type" : "Boolean", + "desc" : "Disable showing of clear button.", + "memberOf" : "" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "displayField", + "type" : "String", + "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')", + "memberOf" : "" + }, + { + "name" : "editable", + "type" : "Boolean", + "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)", + "memberOf" : "" + }, + { + "name" : "emptyResultText", + "type" : "Boolean", + "desc" : "only for touch device", + "memberOf" : "" + }, + { + "name" : "emptyTitle", + "type" : "String", + "desc" : "default ''", + "memberOf" : "" + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "forceSelection", + "type" : "Boolean", + "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)", + "memberOf" : "" + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "handleHeight", + "type" : "Number", + "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)", + "memberOf" : "" + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hiddenName", + "type" : "String", + "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "Roo.bootstrap.TriggerField" + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - uses BS4 is-valid now", + "memberOf" : "" + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : [ + "(top", + "left)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "lazyRender", + "type" : "Boolean", + "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)", + "memberOf" : "" + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "listAlign", + "type" : "String", + "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')", + "memberOf" : "" + }, + { + "name" : "listClass", + "type" : "String", + "desc" : "CSS class to apply to the dropdown list element (defaults to '')", + "memberOf" : "" + }, + { + "name" : "listWidth", + "type" : "Number", + "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadingText", + "type" : "String", + "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')", + "memberOf" : "" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxHeight", + "type" : "Number", + "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)", + "memberOf" : "" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minChars", + "type" : "Number", + "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)", + "memberOf" : "" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minListWidth", + "type" : "Number", + "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)", + "memberOf" : "" + }, + { + "name" : "mobileTouchView", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "mobile_restrict_height", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "modalTitle", + "type" : "String", + "desc" : "The title of the dialog that pops up on mobile views.", + "memberOf" : "" + }, + { + "name" : "mode", + "type" : "String", + "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)", + "memberOf" : "" + }, + { + "name" : "multiple", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "pageSize", + "type" : "Number", + "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)", + "memberOf" : "" + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "queryDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')", + "memberOf" : "" + }, + { + "name" : "queryParam", + "type" : "String", + "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')", + "memberOf" : "" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "removable", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.TriggerField" + }, + { + "name" : "resizable", + "type" : "Boolean", + "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)", + "memberOf" : "" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)", + "memberOf" : "" + }, + { + "name" : "selectedClass", + "type" : "String", + "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')", + "memberOf" : "" + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right", + "memberOf" : "" + }, + { + "name" : "showToggleBtn", + "type" : "Boolean", + "desc" : "show toggle button or not (true|false) default true", + "memberOf" : "" + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "specialFilter", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "The data store to which this combo is bound (defaults to undefined)", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tickable", + "type" : "Boolean", + "desc" : "ComboBox with tickable selections (true|false), default false", + "memberOf" : "" + }, + { + "name" : "title", + "type" : "String", + "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tpl", + "type" : "String/Roo.Template", + "desc" : "The template to use to render the output", + "memberOf" : "" + }, + { + "name" : "triggerAction", + "type" : "String", + "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')", + "memberOf" : "" + }, + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be appended if specified.", + "memberOf" : "Roo.bootstrap.TriggerField" + }, + { + "name" : "triggerList", + "type" : "Boolean", + "desc" : "trigger show the list or not (true|false) default true", + "memberOf" : "" + }, + { + "name" : "triggerText", + "type" : "String", + "desc" : "multiple combobox trigger button text default 'Select'", + "memberOf" : "" + }, + { + "name" : "typeAhead", + "type" : "Boolean", + "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)", + "memberOf" : "" + }, + { + "name" : "typeAheadDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)", + "memberOf" : "" + }, + { + "name" : "useNativeIOS", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - uses BS4 is-valid now", + "memberOf" : "" + }, + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "valueField", + "type" : "String", + "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.", + "memberOf" : "" + }, + { + "name" : "valueNotFoundText", + "type" : "String", + "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)", + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "events" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "afterremove", + "type" : "function", + "desc" : "Fires when the remove value from the combobox array", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforequery", + "type" : "function", + "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:", + "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeselect", + "type" : "function", + "desc" : "Fires before a list item is selected. Return false to cancel the selection.", + "sig" : "function (combo, record, index)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "collapse", + "type" : "function", + "desc" : "Fires when the dropdown list is collapsed", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "edit", + "type" : "function", + "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", + "sig" : "function (combo, record)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Fires when the dropdown list is expanded", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Fires when the remove value from the combobox array", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Fires when a list item is selected", + "sig" : "function (combo, record, index)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialfilter", + "type" : "function", + "desc" : "Fires when specialfilter", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "tick", + "type" : "function", + "desc" : "Fires when tick the element", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "touchviewdisplay", + "type" : "function", + "desc" : "Fires when touch view require special display (default is using displayField)", + "sig" : "function (combo, cfg)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.TriggerField" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "clearValue", + "type" : "function", + "desc" : "Clears any text/value currently set in the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "collapse", + "type" : "function", + "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "doQuery", + "type" : "function", + "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", + "sig" : "(query, forceAll)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the currently selected field value or empty string if no value is set.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "inputEl", + "type" : "function", + "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "isExpanded", + "type" : "function", + "desc" : "Returns true if the dropdown list is expanded, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "markValid", + "type" : "function", + "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onTriggerClick", + "type" : "function", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.bootstrap.TriggerField" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(index, scrollIntoView)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectByValue", + "type" : "function", + "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(value, scrollIntoView)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setEditable", + "type" : "function", + "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setFromData", + "type" : "function", + "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + } + ] + }, + "Roo.bootstrap.Component" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.Container" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "alert", + "type" : "String", + "desc" : [ + "(success", + "info", + "warning", + "danger)" + ], + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "clickable", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "expandable", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "expanded", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "fa", + "type" : "String", + "desc" : "font awesome icon", + "memberOf" : "" + }, + { + "name" : "footer", + "type" : "String", + "desc" : "content of footer (for panel)", + "memberOf" : "" + }, + { + "name" : "header", + "type" : "String", + "desc" : "content of header (for panel)", + "memberOf" : "" + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "html", + "type" : "String", + "desc" : "content of element", + "memberOf" : "" + }, + { + "name" : "icon", + "type" : "String", + "desc" : [ + "(info-sign", + "check", + "...)" + ], + "memberOf" : "" + }, + { + "name" : "jumbotron", + "type" : "Boolean", + "desc" : "is it a jumbotron element", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "panel", + "type" : "String", + "desc" : [ + "(default", + "primary", + "success", + "info", + "warning", + "danger)" + ], + "memberOf" : "" + }, + { + "name" : "rheader", + "type" : "String", + "desc" : "contet on the right of header", + "memberOf" : "" + }, + { + "name" : "sticky", + "type" : "String", + "desc" : [ + "(footer", + "wrap", + "push)" + ], + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tag", + "type" : "String", + "desc" : [ + "(header", + "aside", + "section)" + ], + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "well", + "type" : "String", + "desc" : [ + "(lg", + "sm", + "md)" + ], + "memberOf" : "" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "When a element is chick", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "collapse", + "type" : "function", + "desc" : "After the panel has been collapsed", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "expand", + "type" : "function", + "desc" : "After the panel has been expand", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.DateField" : { + "props" : [ + { + "name" : "accept", + "type" : "String", + "desc" : [ + "(image", + "video", + "audio)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "center", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "altFormats", + "type" : "String", + "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').", + "memberOf" : "" + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "calendarWeeks", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "capture", + "type" : "String", + "desc" : [ + "(user", + "camera)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "daysOfWeekDisabled", + "type" : "Object", + "desc" : "default empty", + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "endDate", + "type" : "Number", + "desc" : "default Infinity", + "memberOf" : "" + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "format", + "type" : "String", + "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').", + "memberOf" : "" + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "keyboardNavigation", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : [ + "(top", + "left)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "language", + "type" : "String", + "desc" : "default en", + "memberOf" : "" + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minViewMode", + "type" : "String", + "desc" : "default empty, (months|years)", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "singleMode", + "type" : "Boolean", + "desc" : "default false (true | false)", + "memberOf" : "" + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "startDate", + "type" : "Number", + "desc" : "default -Infinity", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "todayBtn", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "" + }, + { + "name" : "todayHighlight", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "viewMode", + "type" : "String", + "desc" : "default empty, (months|years)", + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "weekStart", + "type" : "Number", + "desc" : "default 0", + "memberOf" : "" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeselect", + "type" : "function", + "desc" : "Fires when before select a date.", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Fires when select a date.", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires when this field show.", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "inputEl", + "type" : "function", + "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "markValid", + "type" : "function", + "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + } + ] + }, + "Roo.bootstrap.DateSplitField" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dayAllowBlank", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "dayFormat", + "type" : "string", + "desc" : "default 'd'", + "memberOf" : "" + }, + { + "name" : "dayPlaceholder", + "type" : "string", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : [ + "(top", + "left)" + ], + "memberOf" : "" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label (0-12)", + "memberOf" : "" + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "" + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "" + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "" + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "monthAllowBlank", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "monthFormat", + "type" : "string", + "desc" : "default 'm'", + "memberOf" : "" + }, + { + "name" : "monthPlaceholder", + "type" : "string", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "yearAllowBlank", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "yearFormat", + "type" : "string", + "desc" : "default 'Y'", + "memberOf" : "" + }, + { + "name" : "yearPlaceholder", + "type" : "string", + "desc" : "", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "days", + "type" : "function", + "desc" : "getting the data of days", + "sig" : "function (_self, days)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "years", + "type" : "function", + "desc" : "getting the data of years", + "sig" : "function (_self, years)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.DocumentManager" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "boxes", + "type" : "Number", + "desc" : "number of boxes, 0 is no limit.. default 0", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "editable", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : [ + "(left", + "top)" + ], + "memberOf" : "" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "default 4", + "memberOf" : "" + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "" + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "" + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "" + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "method", + "type" : "String", + "desc" : "default POST", + "memberOf" : "" + }, + { + "name" : "multiple", + "type" : "Boolean", + "desc" : "multiple upload default true", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "paramName", + "type" : "String", + "desc" : "default 'imageUpload'", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "thumbSize", + "type" : "Number", + "desc" : "default 300", + "memberOf" : "" + }, + { + "name" : "toolTipName", + "type" : "String", + "desc" : "default 'filename'", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "url", + "type" : "String", + "desc" : "action url", + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "afterupload", + "type" : "function", + "desc" : "Fire when xhr load exception", + "sig" : "function (_self, xhr)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeselectfile", + "type" : "function", + "desc" : "Fire before select file", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fire after click the image", + "sig" : "function (_self, file)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "edit", + "type" : "function", + "desc" : "Fire when upload a image and editable set to true", + "sig" : "function (_self, file)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "exception", + "type" : "function", + "desc" : "Fire when xhr load exception", + "sig" : "function (_self, xhr)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "initial", + "type" : "function", + "desc" : "Fire when initial the DocumentManager", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "inspect", + "type" : "function", + "desc" : "inspect selected file", + "sig" : "function (_self, file)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "prepare", + "type" : "function", + "desc" : "prepare the form data", + "sig" : "function (_self, formData)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "previewrendered", + "type" : "function", + "desc" : "Fire when preview rendered", + "sig" : "function (_self, file)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "process", + "type" : "function", + "desc" : "Fire before process file", + "sig" : "function (_self, file)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "refresh", + "type" : "function", + "desc" : "Fire after refresh the file", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Fire when remove the file", + "sig" : "function (_self, file)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.DocumentSlider" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fire after click", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "initial", + "type" : "function", + "desc" : "Fire after initEvent", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "update", + "type" : "function", + "desc" : "Fire after update", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.DocumentViewer" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "showDownload", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "showTrash", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fire after click", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "download", + "type" : "function", + "desc" : "Fire after download button", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "initial", + "type" : "function", + "desc" : "Fire after initEvent", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "trash", + "type" : "function", + "desc" : "Fire after trash button", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.Element" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "clickable", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "class of the element", + "memberOf" : "" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "html", + "type" : "String", + "desc" : "contents of the element", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tag", + "type" : "String", + "desc" : "tag of the element", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "When a element is chick", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.FieldLabel" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "class of the element", + "memberOf" : "" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "html", + "type" : "String", + "desc" : "contents of the element", + "memberOf" : "" + }, + { + "name" : "iconTooltip", + "type" : "String", + "desc" : "default \"This field is required\"", + "memberOf" : "" + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - BS4 uses is-invalid", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tag", + "type" : "String", + "desc" : "tag of the element default label", + "memberOf" : "" + }, + { + "name" : "target", + "type" : "String", + "desc" : "label target", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - BS4 uses is-valid", + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "get", + "type" : "function", + "desc" : "fetch a FieldLabel Group based on the target", + "sig" : "(target)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "markValid", + "type" : "function", + "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "register", + "type" : "function", + "desc" : "register a FieldLabel Group", + "sig" : "(the)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.Form" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "align", + "type" : "String", + "desc" : "left | right - for navbars", + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "baseParams", + "type" : "Object", + "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "errorMask", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "fileUpload", + "type" : "Boolean", + "desc" : "Set to true if this form is a file upload.", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "top | left (default top)", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadMask", + "type" : "Boolean", + "desc" : "load mask when submit (default true)", + "memberOf" : "" + }, + { + "name" : "maskBody", + "type" : "Boolean", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "maskOffset", + "type" : "Number", + "desc" : "Default 100", + "memberOf" : "" + }, + { + "name" : "method", + "type" : "String", + "desc" : "GET | POST (default POST)", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "timeout", + "type" : "Number", + "desc" : "Timeout for form actions in seconds (default is 30 seconds).", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "url", + "type" : "String", + "desc" : "The URL to use for form actions if one isn't supplied in the action options.", + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "actioncomplete", + "type" : "function", + "desc" : "Fires when an action is completed.", + "sig" : "function (_self, action)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "actionfailed", + "type" : "function", + "desc" : "Fires when an action fails.", + "sig" : "function (_self, action)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeaction", + "type" : "function", + "desc" : "Fires before any action is performed. Return false to cancel the action.", + "sig" : "function (_self, action)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "clientvalidation", + "type" : "function", + "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state", + "sig" : "function (_self, valid)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clears all invalid messages in this form.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "doAction", + "type" : "function", + "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.", + "sig" : "(actionName, options)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "findField", + "type" : "function", + "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getFieldValues", + "type" : "function", + "desc" : "Returns the fields in this form as an object with key/value pairs.\nThis differs from getValues as it calls getValue on each child item, rather than using dom data.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getValues", + "type" : "function", + "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.", + "sig" : "(asString)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if any fields in this form have changed since their original load.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns true if client-side validation on the form is successful.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark fields in this form invalid in bulk.", + "sig" : "(errors)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets this form.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setValues", + "type" : "function", + "desc" : "Set values for fields in this form in bulk.", + "sig" : "(values)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.Graph" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "g_height", + "type" : "number", + "desc" : "height of the chart (respected by all elements in the set)", + "memberOf" : "" + }, + { + "name" : "g_r", + "type" : "number", + "desc" : "radius (pie)", + "memberOf" : "" + }, + { + "name" : "g_width", + "type" : "number", + "desc" : "width of the chart (respected by all elements in the set)", + "memberOf" : "" + }, + { + "name" : "g_x", + "type" : "number", + "desc" : "coodinator | centre x (pie)", + "memberOf" : "" + }, + { + "name" : "g_y", + "type" : "number", + "desc" : "coodinator | centre y (pie)", + "memberOf" : "" + }, + { + "name" : "graphtype", + "type" : "String", + "desc" : "bar | vbar | pie", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "title", + "type" : "Object", + "desc" : "The title of the chart\n \n -{Array} values\n -opts (object) options for the chart \n o {\n o type (string) type of endings of the bar. Default: 'square'. Other options are: 'round', 'sharp', 'soft'.\n o gutter (number)(string) default '20%' (WHAT DOES IT DO?)\n o vgutter (number)\n o colors (array) colors be used repeatedly to plot the bars. If multicolumn bar is used each sequence of bars with use a different color.\n o stacked (boolean) whether or not to tread values as in a stacked bar chart\n o to\n o stretch (boolean)\n o }\n -opts (object) options for the pie\n o{\n o cut\n o startAngle (number)\n o endAngle (number)\n }", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "The img click event for the img.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.Header" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "html", + "type" : "String", + "desc" : "content of header", + "memberOf" : "" + }, + { + "name" : "level", + "type" : "Number", + "desc" : [ + "(1", + "2", + "3", + "4", + "5", + "6)" + ], + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.HtmlEditor" : { + "props" : [ + { + "name" : "accept", + "type" : "String", + "desc" : [ + "(image", + "video", + "audio)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "center", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "buttons", + "type" : "Array", + "desc" : "Array of toolbar's buttons. - defaults to empty", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "capture", + "type" : "String", + "desc" : [ + "(user", + "camera)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cols", + "type" : "Number", + "desc" : "Specifies the visible width of a text area", + "memberOf" : "Roo.bootstrap.TextArea" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "(in pixels)", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "html", + "type" : "string", + "desc" : "text", + "memberOf" : "Roo.bootstrap.TextArea" + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : [ + "(top", + "left)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "resizable", + "type" : "String", + "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.", + "memberOf" : "" + }, + { + "name" : "resize", + "type" : "string", + "desc" : [ + "(none", + "both", + "horizontal", + "vertical", + "inherit", + "initial)" + ], + "memberOf" : "Roo.bootstrap.TextArea" + }, + { + "name" : "rows", + "type" : "Number", + "desc" : "Specifies the visible number of lines in a text area", + "memberOf" : "Roo.bootstrap.TextArea" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "stylesheets", + "type" : "Array", + "desc" : "url of stylesheets. set to [] to disable stylesheets.", + "memberOf" : "" + }, + { + "name" : "toolbars", + "type" : "Array", + "desc" : "Array of toolbars. - defaults to just the Standard one", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "(in pixels)", + "memberOf" : "" + }, + { + "name" : "wrap", + "type" : "string", + "desc" : [ + "(soft", + "hard)" + ], + "memberOf" : "Roo.bootstrap.TextArea" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "events" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "autosave", + "type" : "function", + "desc" : "Auto save the htmlEditor value as a file into Events", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforepush", + "type" : "function", + "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforesync", + "type" : "function", + "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "", + "sig" : "function ()\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "change", + "type" : "function", + "desc" : "", + "sig" : "function ()\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "editmodechange", + "type" : "function", + "desc" : "Fires when the editor switches edit modes", + "sig" : "function (_self, sourceEdit)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "editorevent", + "type" : "function", + "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "firstfocus", + "type" : "function", + "desc" : "Fires when on first focus - needed by toolbars..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "", + "sig" : "function ()\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "initialize", + "type" : "function", + "desc" : "Fires when the editor is fully initialized (including the iframe)", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "push", + "type" : "function", + "desc" : "Fires when the iframe editor is updated with content from the textarea.", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "savedpreview", + "type" : "function", + "desc" : "preview the saved version of htmlEditor", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "", + "sig" : "function ()\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "sync", + "type" : "function", + "desc" : "Fires when the textarea is updated with content from the editor iframe.", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.TextArea" + }, + { + "name" : "createToolbar", + "type" : "function", + "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.", + "sig" : "(editor)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "inputEl", + "type" : "function", + "desc" : "return the real textarea element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.TextArea" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.TextArea" + }, + { + "name" : "markValid", + "type" : "function", + "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.TextArea" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "toggleSourceEdit", + "type" : "function", + "desc" : "Toggles the editor between standard and source edit mode.", + "sig" : "(sourceEdit)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + } + ] + }, + "Roo.bootstrap.Img" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "alt", + "type" : "String", + "desc" : "image alternative text", + "memberOf" : "" + }, + { + "name" : "border", + "type" : "String", + "desc" : "rounded | circle | thumbnail", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "href", + "type" : "String", + "desc" : "a tag href", + "memberOf" : "" + }, + { + "name" : "imgResponsive", + "type" : "Boolean", + "desc" : "false | true", + "memberOf" : "" + }, + { + "name" : "lgUrl", + "type" : "String", + "desc" : "lg image source", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "mdUrl", + "type" : "String", + "desc" : "md image source", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "smUrl", + "type" : "String", + "desc" : "sm image source", + "memberOf" : "" + }, + { + "name" : "src", + "type" : "String", + "desc" : "image source", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "target", + "type" : "String", + "desc" : [ + "(_self", + "_blank", + "_parent", + "_top)" + ], + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xsUrl", + "type" : "String", + "desc" : "xs image source", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "The img click event for the img.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setSrc", + "type" : "function", + "desc" : "Sets the url of the image - used to update it", + "sig" : "(url)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.Input" : { + "props" : [ + { + "name" : "accept", + "type" : "String", + "desc" : [ + "(image", + "video", + "audio)" + ], + "memberOf" : "" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "center", + "right)" + ], + "memberOf" : "" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "" + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "capture", + "type" : "String", + "desc" : [ + "(user", + "camera)" + ], + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "" + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "" + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "" + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : [ + "(top", + "left)" + ], + "memberOf" : "" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "" + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "" + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "" + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "" + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "" + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "" + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "" + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "" + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "" + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "" + }, + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "" + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "inputEl", + "type" : "function", + "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "markValid", + "type" : "function", + "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.bootstrap.LayoutMasonry" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "alternativePadWidth", + "type" : "Number", + "desc" : "padding below box..", + "memberOf" : "" + }, + { + "name" : "boxHeight", + "type" : "Number", + "desc" : "- 0 for square, or fix it at a certian height", + "memberOf" : "" + }, + { + "name" : "boxWidth", + "type" : "Number", + "desc" : "width of the columns", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "gutter", + "type" : "Number", + "desc" : "gutter width..", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "isAutoInitial", + "type" : "Boolean", + "desc" : "defalut true", + "memberOf" : "" + }, + { + "name" : "isHorizontal", + "type" : "Boolean", + "desc" : "defalut false", + "memberOf" : "" + }, + { + "name" : "isLayoutInstant", + "type" : "Boolean", + "desc" : "= no animation?", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maxCols", + "type" : "Number", + "desc" : "maximum number of columns", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "padWidth", + "type" : "Number", + "desc" : "padding below box..", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "layout", + "type" : "function", + "desc" : "Fire after layout the items", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "_processVerticalLayoutQueue", + "type" : "function", + "desc" : "Sets position of item in DOM", + "sig" : "(item, x, y, isInstant)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addBrick", + "type" : "function", + "desc" : "adds a Masonry Brick", + "sig" : "(the)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearAll", + "type" : "function", + "desc" : "clear all the Masonry Brick", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "get", + "type" : "function", + "desc" : "fetch a Masonry Layout based on the masonry layout ID", + "sig" : "(the)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "register", + "type" : "function", + "desc" : "register a Masonry Brick", + "sig" : "(the)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "register", + "type" : "function", + "desc" : "register a Masonry Layout", + "sig" : "(the)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeBrick", + "type" : "function", + "desc" : "remove a Masonry Brick", + "sig" : "(the)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.LayoutMasonryAuto" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "columnWidth", + "type" : "Number", + "desc" : "width of the columns", + "memberOf" : "" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "isAutoInitial", + "type" : "Boolean", + "desc" : "defalut true", + "memberOf" : "" + }, + { + "name" : "isFitWidth", + "type" : "Boolean", + "desc" : "- resize the width..", + "memberOf" : "" + }, + { + "name" : "isLayoutInstant", + "type" : "Boolean", + "desc" : "= no animation?", + "memberOf" : "" + }, + { + "name" : "isOriginLeft", + "type" : "Boolean", + "desc" : "= left align?", + "memberOf" : "" + }, + { + "name" : "isOriginTop", + "type" : "Boolean", + "desc" : "= top align?", + "memberOf" : "" + }, + { + "name" : "isResizingContainer", + "type" : "Boolean", + "desc" : "= not sure if this is used..", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maxCols", + "type" : "Number", + "desc" : "maximum number of columns", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "padHeight", + "type" : "Number", + "desc" : "padding below box..", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "_getColGroup", + "type" : "function", + "desc" : "", + "sig" : "(colSpan)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "_postLayout", + "type" : "function", + "desc" : "Any logic you want to do after each layout,\ni.e. size the container", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "_processLayoutQueue", + "type" : "function", + "desc" : "Sets position of item in DOM", + "sig" : "(item, x, y, isInstant)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.Link" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "alt", + "type" : "String", + "desc" : "image alternative text", + "memberOf" : "" + }, + { + "name" : "anchor", + "type" : "String", + "desc" : "name for the anchor link", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "fa", + "type" : "String", + "desc" : "- favicon", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "href", + "type" : "String", + "desc" : "a tag href", + "memberOf" : "" + }, + { + "name" : "html", + "type" : "String", + "desc" : "the content of the link.", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "target", + "type" : "String", + "desc" : [ + "(_self", + "_blank", + "_parent", + "_top)" + ], + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "The img click event for the img.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.LocationPicker" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableDoubleClickZoom", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "" + }, + { + "name" : "draggable", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "" + }, + { + "name" : "enableAutocomplete", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "" + }, + { + "name" : "enableReverseGeocode", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "latitude", + "type" : "Number", + "desc" : "Position when init default 0", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "locationName", + "type" : "String", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "longitude", + "type" : "Number", + "desc" : "Position when init default 0", + "memberOf" : "" + }, + { + "name" : "mapTypeControl", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "" + }, + { + "name" : "mapTypeId", + "type" : "String", + "desc" : "default google.maps.MapTypeId.ROADMAP", + "memberOf" : "" + }, + { + "name" : "markerTitle", + "type" : "String", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "radius", + "type" : "Number", + "desc" : "default 0", + "memberOf" : "" + }, + { + "name" : "scrollwheel", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "" + }, + { + "name" : "streetViewControl", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "zoom", + "type" : "Number", + "desc" : "default 15", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "OverlayViewDraw", + "type" : "function", + "desc" : "Fires when OverlayView Draw", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "OverlayViewHide", + "type" : "function", + "desc" : "Fires when OverlayView Draw", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "OverlayViewOnAdd", + "type" : "function", + "desc" : "Fires when OverlayView Draw", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "OverlayViewOnRemove", + "type" : "function", + "desc" : "Fires when OverlayView Draw", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "OverlayViewShow", + "type" : "function", + "desc" : "Fires when OverlayView Draw", + "sig" : "function (_self, cpx)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires when the map hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "initial", + "type" : "function", + "desc" : "Fires when the picker initialized.", + "sig" : "function (_self, location)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "loadexception", + "type" : "function", + "desc" : "Fires when load google lib failed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "mapClick", + "type" : "function", + "desc" : "Fires when click the map.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "mapRightClick", + "type" : "function", + "desc" : "Fires when right click the map.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "markerClick", + "type" : "function", + "desc" : "Fires when click the marker.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "markerRightClick", + "type" : "function", + "desc" : "Fires when right click the marker.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "positionchanged", + "type" : "function", + "desc" : "Fires when the picker position changed.", + "sig" : "function (_self, location)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires when the map resize.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires when the map show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.MasonryBrick" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "bgimage", + "type" : "String", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "href", + "type" : "String", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "defalut false", + "memberOf" : "" + }, + { + "name" : "isFitContainer", + "type" : "Boolean", + "desc" : "defalut true", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "placetitle", + "type" : "String", + "desc" : [ + "(center", + "bottom)" + ], + "memberOf" : "" + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : "defalut false", + "memberOf" : "" + }, + { + "name" : "size", + "type" : "String", + "desc" : [ + "(xs", + "sm", + "md", + "md-left", + "md-right", + "tall", + "wide)" + ], + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "title", + "type" : "String", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "videourl", + "type" : "String", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "When a MasonryBrick is clcik", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "get", + "type" : "function", + "desc" : "fetch a masonry brick based on the masonry brick ID", + "sig" : "(the)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "register", + "type" : "function", + "desc" : "register a Masonry Brick", + "sig" : "(the)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.Menu" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hidden", + "type" : "bool", + "desc" : "if the menu should be hidden when rendered.", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "isLink", + "type" : "bool", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "registerMenu", + "type" : "Boolean", + "desc" : "True (default) - means that clicking on screen etc. hides it.", + "memberOf" : "" + }, + { + "name" : "stopEvent", + "type" : "bool", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "type", + "type" : "String", + "desc" : [ + "(dropdown", + "treeview", + "submenu)" + ], + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before this menu is hidden", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before this menu is displayed", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", + "sig" : "function (_self, menuItem, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after this menu is hidden", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "itemclick", + "type" : "function", + "desc" : "Fires when a menu item contained in this menu is clicked", + "sig" : "function (baseItem, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "mouseout", + "type" : "function", + "desc" : "Fires when the mouse exits this menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "mouseover", + "type" : "function", + "desc" : "Fires when the mouse is hovering over this menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after this menu is displayed", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hides this menu and optionally all parent menus", + "sig" : "(deep)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Displays this menu relative to another element", + "sig" : "(element, position, parentMenu)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "showAt", + "type" : "function", + "desc" : "Displays this menu at a specific xy position", + "sig" : "(xyPosition, parentMenu)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.MenuItem" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : "used on sidebars to highlight active itesm", + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "fa", + "type" : "String", + "desc" : "favicon to show on left of menu item.", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "href", + "type" : "String", + "desc" : "the link", + "memberOf" : "" + }, + { + "name" : "html", + "type" : "String", + "desc" : "the menu label", + "memberOf" : "" + }, + { + "name" : "isContainer", + "type" : "Boolean", + "desc" : "is it a container - just returns a drop down item..", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "menu", + "type" : "Roo.bootsrap.Menu", + "desc" : "the child menu.", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : "do not trigger A href on clicks (default false).", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "The raw click event for the entire grid.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.MenuMgr" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "get", + "type" : "function", + "desc" : "Returns a {@link Roo.menu.Menu} object", + "sig" : "(menu)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hideAll", + "type" : "function", + "desc" : "Hides all menus that are currently visible", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.bootstrap.MenuSeparator" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.MessageBar" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeClass", + "type" : "String", + "desc" : "insert the bar before the given class", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "fixed", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "html", + "type" : "String", + "desc" : "contents of the MessageBar", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "weight", + "type" : "String", + "desc" : [ + "(info", + "success", + "warning", + "danger)" + ], + "memberOf" : "" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.MessageBox" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "alert", + "type" : "function", + "desc" : "Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).\nIf a callback function is passed it will be called after the user clicks the button, and the\nid of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).", + "sig" : "(title, msg, fn, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "confirm", + "type" : "function", + "desc" : "Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).\nIf a callback function is passed it will be called after the user clicks either button, and the id of the\nbutton that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).", + "sig" : "(title, msg, fn, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getDialog", + "type" : "function", + "desc" : "Returns a reference to the underlying {@link Roo.BasicDialog} element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hides the message box if it is displayed", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if the message box is currently displayed", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "progress", + "type" : "function", + "desc" : "Displays a message box with a progress bar. This message box has no buttons and is not closeable by\nthe user. You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}\nand closing the message box when the process is complete.", + "sig" : "(title, msg)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "prompt", + "type" : "function", + "desc" : "Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to\nJavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function\nis passed it will be called after the user clicks either button, and the id of the button that was clicked\n(could also be the top-right close button) and the text that was entered will be passed as the two\nparameters to the callback.", + "sig" : "(title, msg, fn, scope, multiline)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.\nThe following config object properties are supported:\n
\nProperty    Type             Description\n----------  ---------------  ------------------------------------------------------------------------------------\nanimEl            String/Element   An id or Element from which the message box should animate as it opens and\n                                   closes (defaults to undefined)\nbuttons           Object/Boolean   A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',\n                                   cancel:'Bar'}), or false to not show any buttons (defaults to false)\nclosable          Boolean          False to hide the top-right close button (defaults to true).  Note that\n                                   progress and wait dialogs will ignore this property and always hide the\n                                   close button as they can only be closed programmatically.\ncls               String           A custom CSS class to apply to the message box element\ndefaultTextHeight Number           The default height in pixels of the message box's multiline textarea if\n                                   displayed (defaults to 75)\nfn                Function         A callback function to execute after closing the dialog.  The arguments to the\n                                   function will be btn (the name of the button that was clicked, if applicable,\n                                   e.g. \"ok\"), and text (the value of the active text field, if applicable).\n                                   Progress and wait dialogs will ignore this option since they do not respond to\n                                   user actions and can only be closed programmatically, so any required function\n                                   should be called by the same code after it closes the dialog.\nicon              String           A CSS class that provides a background image to be used as an icon for\n                                   the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')\nmaxWidth          Number           The maximum width in pixels of the message box (defaults to 600)\nminWidth          Number           The minimum width in pixels of the message box (defaults to 100)\nmodal             Boolean          False to allow user interaction with the page while the message box is\n                                   displayed (defaults to true)\nmsg               String           A string that will replace the existing message box body text (defaults\n                                   to the XHTML-compliant non-breaking space character ' ')\nmultiline         Boolean          True to prompt the user to enter multi-line text (defaults to false)\nprogress          Boolean          True to display a progress bar (defaults to false)\nprogressText      String           The text to display inside the progress bar if progress = true (defaults to '')\nprompt            Boolean          True to prompt the user to enter single-line text (defaults to false)\nproxyDrag         Boolean          True to display a lightweight proxy while dragging (defaults to false)\ntitle             String           The title text\nvalue             String           The string value to set into the active textbox element if displayed\nwait              Boolean          True to display a progress bar (defaults to false)\nwidth             Number           The width of the dialog in pixels\n
\n\nExample usage:\n
\nRoo.Msg.show({\n   title: 'Address',\n   msg: 'Please enter your address:',\n   width: 300,\n   buttons: Roo.MessageBox.OKCANCEL,\n   multiline: true,\n   fn: saveAddress,\n   animEl: 'addAddressBtn'\n});\n
", + "sig" : "(config)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "updateProgress", + "type" : "function", + "desc" : "Updates a progress-style message box's text and progress bar. Only relevant on message boxes\ninitiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true.", + "sig" : "(value, text)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "updateText", + "type" : "function", + "desc" : "Updates the message box body text", + "sig" : "(text)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "wait", + "type" : "function", + "desc" : "Displays a message box with an infinitely auto-updating progress bar. This can be used to block user\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.", + "sig" : "(msg, title)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.bootstrap.Modal" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "allow_close", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "" + }, + { + "name" : "animate", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "" + }, + { + "name" : "buttonPosition", + "type" : "String", + "desc" : [ + "(left", + "right", + "center)" + ], + "memberOf" : "" + }, + { + "name" : "buttons", + "type" : "Array", + "desc" : "Array of buttons or standard button set..", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "fitwindow", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "html", + "type" : "String", + "desc" : "- the body of the dialog (for simple ones) - you can also use template..", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "max_width", + "type" : "Number", + "desc" : "set the max width of modal", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "size", + "type" : "String", + "desc" : [ + "(sm", + "lg)" + ], + "memberOf" : "" + }, + { + "name" : "specificTitle", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "title", + "type" : "String", + "desc" : "Title of dialog", + "memberOf" : "" + }, + { + "name" : "tmpl", + "type" : "Roo.Template", + "desc" : "- a template with variables. to use it, add a handler in show:method adn", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "btnclick", + "type" : "function", + "desc" : "The raw btnclick event for the button", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fire when dialog resize", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyBody", + "type" : "function", + "desc" : "Set the body of the Dialog using the template", + "sig" : "(data)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setBody", + "type" : "function", + "desc" : "Set the body of the Dialog", + "sig" : "(str)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setTitle", + "type" : "function", + "desc" : "Set the title of the Dialog", + "sig" : "(str)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.MoneyField" : { + "props" : [ + { + "name" : "accept", + "type" : "String", + "desc" : [ + "(image", + "video", + "audio)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "center", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allQuery", + "type" : "String", + "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowDecimals", + "type" : "Boolean", + "desc" : "False to disallow decimal values (defaults to true)", + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowNegative", + "type" : "Boolean", + "desc" : "False to prevent entering a negative sign (defaults to true)", + "memberOf" : "" + }, + { + "name" : "allowZero", + "type" : "Boolean", + "desc" : "False to blank out if the user enters '0' (defaults to true)", + "memberOf" : "" + }, + { + "name" : "alwaysQuery", + "type" : "Boolean", + "desc" : "Disable caching of results, and always send query", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "animate", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "append", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "autoFocus", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "blockFocus", + "type" : "Boolean", + "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "btnPosition", + "type" : "String", + "desc" : "set the position of the trigger button (left | right) default right", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "capture", + "type" : "String", + "desc" : [ + "(user", + "camera)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "caret", + "type" : "String", + "desc" : [ + "(search", + "calendar)" + ], + "memberOf" : "Roo.bootstrap.TriggerField" + }, + { + "name" : "castInt", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "decimalPrecision", + "type" : "Number", + "desc" : "The maximum precision to display after the decimal separator (defaults to 2)", + "memberOf" : "" + }, + { + "name" : "decimalSeparator", + "type" : "String", + "desc" : "Character(s) to allow as the decimal separator (defaults to '.')", + "memberOf" : "" + }, + { + "name" : "defaults", + "type" : "String", + "desc" : "currency of the MoneyField\nvalue should be in lkey", + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableClear", + "type" : "Boolean", + "desc" : "Disable showing of clear button.", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "displayField", + "type" : "String", + "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "editable", + "type" : "Boolean", + "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "emptyResultText", + "type" : "Boolean", + "desc" : "only for touch device", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "emptyTitle", + "type" : "String", + "desc" : "default ''", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "forceSelection", + "type" : "Boolean", + "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "handleHeight", + "type" : "Number", + "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hiddenName", + "type" : "String", + "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "Roo.bootstrap.TriggerField" + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - uses BS4 is-valid now", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : [ + "(top", + "left)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "lazyRender", + "type" : "Boolean", + "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "listAlign", + "type" : "String", + "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "listClass", + "type" : "String", + "desc" : "CSS class to apply to the dropdown list element (defaults to '')", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "listWidth", + "type" : "Number", + "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadingText", + "type" : "String", + "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxHeight", + "type" : "Number", + "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxText", + "type" : "String", + "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")", + "memberOf" : "" + }, + { + "name" : "maxValue", + "type" : "Number", + "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)", + "memberOf" : "" + }, + { + "name" : "max_length", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "" + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minChars", + "type" : "Number", + "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minListWidth", + "type" : "Number", + "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "minText", + "type" : "String", + "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")", + "memberOf" : "" + }, + { + "name" : "minValue", + "type" : "Number", + "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)", + "memberOf" : "" + }, + { + "name" : "mobileTouchView", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "mobile_restrict_height", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "modalTitle", + "type" : "String", + "desc" : "The title of the dialog that pops up on mobile views.", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "mode", + "type" : "String", + "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "multiple", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "nanText", + "type" : "String", + "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")", + "memberOf" : "" + }, + { + "name" : "pageSize", + "type" : "Number", + "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "queryDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "queryParam", + "type" : "String", + "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "removable", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.TriggerField" + }, + { + "name" : "resizable", + "type" : "Boolean", + "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "selectedClass", + "type" : "String", + "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "showToggleBtn", + "type" : "Boolean", + "desc" : "show toggle button or not (true|false) default true", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "specialFilter", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "The data store to which this combo is bound (defaults to undefined)", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "thousandsDelimiter", + "type" : "String", + "desc" : "Symbol of thousandsDelimiter", + "memberOf" : "" + }, + { + "name" : "tickable", + "type" : "Boolean", + "desc" : "ComboBox with tickable selections (true|false), default false", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "title", + "type" : "String", + "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tpl", + "type" : "String/Roo.Template", + "desc" : "The template to use to render the output", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "triggerAction", + "type" : "String", + "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be appended if specified.", + "memberOf" : "Roo.bootstrap.TriggerField" + }, + { + "name" : "triggerList", + "type" : "Boolean", + "desc" : "trigger show the list or not (true|false) default true", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "triggerText", + "type" : "String", + "desc" : "multiple combobox trigger button text default 'Select'", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "typeAhead", + "type" : "Boolean", + "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "typeAheadDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "useNativeIOS", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - uses BS4 is-valid now", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "valueField", + "type" : "String", + "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "valueNotFoundText", + "type" : "String", + "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "events" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "afterremove", + "type" : "function", + "desc" : "Fires when the remove value from the combobox array", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforequery", + "type" : "function", + "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:", + "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeselect", + "type" : "function", + "desc" : "Fires before a list item is selected. Return false to cancel the selection.", + "sig" : "function (combo, record, index)\n{\n\n}", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "collapse", + "type" : "function", + "desc" : "Fires when the dropdown list is collapsed", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "edit", + "type" : "function", + "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", + "sig" : "function (combo, record)\n{\n\n}", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Fires when the dropdown list is expanded", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Fires when the remove value from the combobox array", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Fires when a list item is selected", + "sig" : "function (combo, record, index)\n{\n\n}", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialfilter", + "type" : "function", + "desc" : "Fires when specialfilter", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "tick", + "type" : "function", + "desc" : "Fires when tick the element", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "touchviewdisplay", + "type" : "function", + "desc" : "Fires when touch view require special display (default is using displayField)", + "sig" : "function (combo, cfg)\n{\n\n}", + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.TriggerField" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "clearValue", + "type" : "function", + "desc" : "Clears any text/value currently set in the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "collapse", + "type" : "function", + "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "doQuery", + "type" : "function", + "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", + "sig" : "(query, forceAll)", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the currently selected field value or empty string if no value is set.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "inputEl", + "type" : "function", + "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "isExpanded", + "type" : "function", + "desc" : "Returns true if the dropdown list is expanded, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "markValid", + "type" : "function", + "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onTriggerClick", + "type" : "function", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.bootstrap.TriggerField" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(index, scrollIntoView)", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "selectByValue", + "type" : "function", + "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(value, scrollIntoView)", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setEditable", + "type" : "function", + "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "setFromData", + "type" : "function", + "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + } + ] + }, + "Roo.bootstrap.MonthField" : { + "props" : [ + { + "name" : "accept", + "type" : "String", + "desc" : [ + "(image", + "video", + "audio)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "center", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "capture", + "type" : "String", + "desc" : [ + "(user", + "camera)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : [ + "(top", + "left)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "language", + "type" : "String", + "desc" : "default en", + "memberOf" : "" + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Fires when select a date.", + "sig" : "function (_self, oldvalue, newvalue)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires when this field show.", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "inputEl", + "type" : "function", + "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "markValid", + "type" : "function", + "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + } + ] + }, + "Roo.bootstrap.NavGroup" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "navId", + "type" : "String", + "desc" : "- reference Id for navbar.", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "type", + "type" : "String", + "desc" : [ + "(nav", + "pills", + "tab)" + ], + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "changed", + "type" : "function", + "desc" : "Fires when the active item changes", + "sig" : "function (_self, selected, prev)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addItem", + "type" : "function", + "desc" : "adds a Navigation item", + "sig" : "(the)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearAll", + "type" : "function", + "desc" : "clear all the Navigation item", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "get", + "type" : "function", + "desc" : "fetch a Navigation Group based on the navigation ID", + "sig" : "(the)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "getActive", + "type" : "function", + "desc" : "gets the active Navigation item", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "register", + "type" : "function", + "desc" : "register a Navigation item", + "sig" : "(the)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "register", + "type" : "function", + "desc" : "register a Navigation Group", + "sig" : "(the)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setActiveItem", + "type" : "function", + "desc" : "sets the active Navigation item", + "sig" : "(the)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.NavHeaderbar" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "Roo.bootstrap.NavSimplebar" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "arrangement", + "type" : "Boolean", + "desc" : "stacked | justified", + "memberOf" : "Roo.bootstrap.NavSimplebar" + }, + { + "name" : "autohide", + "type" : "Boolean", + "desc" : "a top nav bar header that hides on scroll.", + "memberOf" : "" + }, + { + "name" : "brand", + "type" : "String", + "desc" : "what is brand", + "memberOf" : "" + }, + { + "name" : "brand_href", + "type" : "String", + "desc" : "href of the brand", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "desktopCenter", + "type" : "Boolean", + "desc" : "should the header be centered on desktop using a container class", + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "is inverted color", + "memberOf" : "Roo.bootstrap.NavSimplebar" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadMask", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.NavSimplebar" + }, + { + "name" : "main", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.NavSimplebar" + }, + { + "name" : "mobilerow", + "type" : "Roo.bootstrap.Row", + "desc" : "- a row to display on mobile only..", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "position", + "type" : "String", + "desc" : [ + "(fixed-top", + "fixed-bottom", + "static-top)" + ], + "memberOf" : "" + }, + { + "name" : "srButton", + "type" : "Boolean", + "desc" : "generate the (screen reader / mobile) sr-only button default true", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tag", + "type" : "String", + "desc" : [ + "(header", + "footer", + "nav", + "div)" + ], + "memberOf" : "Roo.bootstrap.NavSimplebar" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "type", + "type" : "String", + "desc" : [ + "(nav", + "pills", + "tabs)" + ], + "memberOf" : "Roo.bootstrap.NavSimplebar" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "weight", + "type" : "String", + "desc" : [ + "(light", + "primary", + "secondary", + "success", + "danger", + "warning", + "info", + "dark", + "white)" + ], + "memberOf" : "Roo.bootstrap.NavSimplebar" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforetoggle", + "type" : "function", + "desc" : "Fire before toggle the menu", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Navbar" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.NavItem" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : "Is item active", + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "animateRef", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "badge", + "type" : "String", + "desc" : "text inside badge", + "memberOf" : "" + }, + { + "name" : "badgecls", + "type" : "String", + "desc" : [ + "(bg-green", + "bg-red", + "bg-yellow)" + ], + "memberOf" : "" + }, + { + "name" : "button_weight", + "type" : "String", + "desc" : [ + "(default", + "primary", + "secondary", + "success", + "info", + "warning", + "danger", + "link )" + ], + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "Is item disabled", + "memberOf" : "" + }, + { + "name" : "fa", + "type" : "String", + "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)", + "memberOf" : "" + }, + { + "name" : "glyphicon", + "type" : "String", + "desc" : "DEPRICATED - use fa", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "href", + "type" : "String", + "desc" : "link to", + "memberOf" : "" + }, + { + "name" : "html", + "type" : "String", + "desc" : "content of button", + "memberOf" : "" + }, + { + "name" : "icon", + "type" : "String", + "desc" : "DEPRICATED - use fa", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tabId", + "type" : "String", + "desc" : "the tab that this item activates.", + "memberOf" : "" + }, + { + "name" : "tagtype", + "type" : "String", + "desc" : [ + "(a", + "span)" + ], + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "changed", + "type" : "function", + "desc" : "Fires when the active item active state changes", + "sig" : "function (_self, state)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "The raw click event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "scrollto", + "type" : "function", + "desc" : "Fires when scroll to element", + "sig" : "function (_self, options, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.NavProgressBar" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "changed", + "type" : "function", + "desc" : "Fires when the active item changes", + "sig" : "function (_self, selected, prev)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.NavProgressItem" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "icon", + "type" : "String", + "desc" : "show icon instead of number", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "position", + "type" : "String", + "desc" : [ + "(top", + "bottom)" + ], + "memberOf" : "" + }, + { + "name" : "rid", + "type" : "String", + "desc" : "the reference id", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "The raw click event for the entire grid.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.NavSidebar" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforetoggle", + "type" : "function", + "desc" : "Fire before toggle the menu", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Navbar" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.NavSidebarItem" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : "Is item active", + "memberOf" : "Roo.bootstrap.NavItem" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "animateRef", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.NavItem" + }, + { + "name" : "badge", + "type" : "String", + "desc" : "text inside badge", + "memberOf" : "Roo.bootstrap.NavItem" + }, + { + "name" : "badgecls", + "type" : "String", + "desc" : [ + "(bg-green", + "bg-red", + "bg-yellow)" + ], + "memberOf" : "Roo.bootstrap.NavItem" + }, + { + "name" : "button_weight", + "type" : "String", + "desc" : [ + "(default", + "primary", + "secondary", + "success", + "info", + "warning", + "danger", + "link )" + ], + "memberOf" : "Roo.bootstrap.NavItem" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "Is item disabled", + "memberOf" : "Roo.bootstrap.NavItem" + }, + { + "name" : "fa", + "type" : "String", + "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)", + "memberOf" : "Roo.bootstrap.NavItem" + }, + { + "name" : "glyphicon", + "type" : "String", + "desc" : "DEPRICATED - use fa", + "memberOf" : "Roo.bootstrap.NavItem" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "href", + "type" : "String", + "desc" : "link to", + "memberOf" : "Roo.bootstrap.NavItem" + }, + { + "name" : "html", + "type" : "String", + "desc" : "content of button", + "memberOf" : "Roo.bootstrap.NavItem" + }, + { + "name" : "icon", + "type" : "String", + "desc" : "DEPRICATED - use fa", + "memberOf" : "Roo.bootstrap.NavItem" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.NavItem" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tabId", + "type" : "String", + "desc" : "the tab that this item activates.", + "memberOf" : "Roo.bootstrap.NavItem" + }, + { + "name" : "tagtype", + "type" : "String", + "desc" : [ + "(a", + "span)" + ], + "memberOf" : "Roo.bootstrap.NavItem" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "changed", + "type" : "function", + "desc" : "Fires when the active item active state changes", + "sig" : "function (_self, state)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "The raw click event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "scrollto", + "type" : "function", + "desc" : "Fires when scroll to element", + "sig" : "function (_self, options, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.NavItem" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.NavItem" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.NavSimplebar" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "arrangement", + "type" : "Boolean", + "desc" : "stacked | justified", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "is inverted color", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadMask", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "main", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tag", + "type" : "String", + "desc" : [ + "(header", + "footer", + "nav", + "div)" + ], + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "type", + "type" : "String", + "desc" : [ + "(nav", + "pills", + "tabs)" + ], + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "weight", + "type" : "String", + "desc" : [ + "(light", + "primary", + "secondary", + "success", + "danger", + "warning", + "info", + "dark", + "white)" + ], + "memberOf" : "" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforetoggle", + "type" : "function", + "desc" : "Fire before toggle the menu", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Navbar" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.Navbar" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforetoggle", + "type" : "function", + "desc" : "Fire before toggle the menu", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.NumberField" : { + "props" : [ + { + "name" : "accept", + "type" : "String", + "desc" : [ + "(image", + "video", + "audio)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "center", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowDecimals", + "type" : "Boolean", + "desc" : "False to disallow decimal values (defaults to true)", + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowNegative", + "type" : "Boolean", + "desc" : "False to prevent entering a negative sign (defaults to true)", + "memberOf" : "" + }, + { + "name" : "allowZero", + "type" : "Boolean", + "desc" : "False to blank out if the user enters '0' (defaults to true)", + "memberOf" : "" + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "capture", + "type" : "String", + "desc" : [ + "(user", + "camera)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "decimalPrecision", + "type" : "Number", + "desc" : "The maximum precision to display after the decimal separator (defaults to 2)", + "memberOf" : "" + }, + { + "name" : "decimalSeparator", + "type" : "String", + "desc" : "Character(s) to allow as the decimal separator (defaults to '.')", + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : [ + "(top", + "left)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxText", + "type" : "String", + "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")", + "memberOf" : "" + }, + { + "name" : "maxValue", + "type" : "Number", + "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)", + "memberOf" : "" + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minText", + "type" : "String", + "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")", + "memberOf" : "" + }, + { + "name" : "minValue", + "type" : "Number", + "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "nanText", + "type" : "String", + "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")", + "memberOf" : "" + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "thousandsDelimiter", + "type" : "String", + "desc" : "Symbol of thousandsDelimiter", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "valueAlign", + "type" : "String", + "desc" : "alignment of value", + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "inputEl", + "type" : "function", + "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "markValid", + "type" : "function", + "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + } + ] + }, + "Roo.bootstrap.Pagination" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "false | true", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "size", + "type" : "String", + "desc" : "xs | sm | md | lg", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.PaginationItem" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "href", + "type" : "String", + "desc" : "the link", + "memberOf" : "" + }, + { + "name" : "html", + "type" : "String", + "desc" : "text", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "The raw click event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.PagingToolbar" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "Roo.bootstrap.NavSimplebar" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "arrangement", + "type" : "Boolean", + "desc" : "stacked | justified", + "memberOf" : "Roo.bootstrap.NavSimplebar" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "container The id or element that will contain the toolbar", + "memberOf" : "" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataSource", + "type" : "Roo.data.Store", + "desc" : "The underlying data store providing the paged data", + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "displayInfo", + "type" : "Boolean", + "desc" : "True to display the displayMsg (defaults to false)", + "memberOf" : "" + }, + { + "name" : "displayMsg", + "type" : "String", + "desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")", + "memberOf" : "" + }, + { + "name" : "emptyMsg", + "type" : "String", + "desc" : "The message to display when no records are found (defaults to \"No data to display\")", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "is inverted color", + "memberOf" : "Roo.bootstrap.NavSimplebar" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadMask", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.NavSimplebar" + }, + { + "name" : "main", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.NavSimplebar" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "pageSize", + "type" : "Number", + "desc" : "The number of records to display per page (defaults to 20)", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tag", + "type" : "String", + "desc" : [ + "(header", + "footer", + "nav", + "div)" + ], + "memberOf" : "Roo.bootstrap.NavSimplebar" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "type", + "type" : "String", + "desc" : [ + "(nav", + "pills", + "tabs)" + ], + "memberOf" : "Roo.bootstrap.NavSimplebar" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "weight", + "type" : "String", + "desc" : [ + "(light", + "primary", + "secondary", + "success", + "danger", + "warning", + "info", + "dark", + "white)" + ], + "memberOf" : "Roo.bootstrap.NavSimplebar" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforetoggle", + "type" : "function", + "desc" : "Fire before toggle the menu", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Navbar" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "bind", + "type" : "function", + "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}", + "sig" : "(store)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unbind", + "type" : "function", + "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}", + "sig" : "(store)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.bootstrap.PhoneInput" : { + "props" : [ + { + "name" : "accept", + "type" : "String", + "desc" : [ + "(image", + "video", + "audio)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "center", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "capture", + "type" : "String", + "desc" : [ + "(user", + "camera)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "caret", + "type" : "String", + "desc" : [ + "(search", + "calendar)" + ], + "memberOf" : "Roo.bootstrap.TriggerField" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "defaultDialCode", + "type" : "String", + "desc" : "default '+852'", + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "Roo.bootstrap.TriggerField" + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : [ + "(top", + "left)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "preferedCountries", + "type" : "Array", + "desc" : "default []", + "memberOf" : "" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "removable", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.TriggerField" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be appended if specified.", + "memberOf" : "Roo.bootstrap.TriggerField" + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.TriggerField" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "inputEl", + "type" : "function", + "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "markValid", + "type" : "function", + "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onTriggerClick", + "type" : "function", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.bootstrap.TriggerField" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + } + ] + }, + "Roo.bootstrap.Popover" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "delay", + "type" : "Number", + "desc" : "- delay before showing", + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "html", + "type" : "String", + "desc" : "contents of the popover (or false to use children..)", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "over", + "type" : "String", + "desc" : "what (parent or false to trigger manually.)", + "memberOf" : "" + }, + { + "name" : "placement", + "type" : "String", + "desc" : "how it is placed", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "title", + "type" : "String", + "desc" : "of popover (or false to hide)", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "trigger", + "type" : "String", + "desc" : "click || hover (or false to trigger manually)", + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "After the popover hide", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "After the popover show", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.Progress" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : "animated of the progress bar", + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "striped", + "type" : "Boolean", + "desc" : "striped of the progress bar", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.ProgressBar" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "aria_valuemax", + "type" : "Number", + "desc" : "aria-value max", + "memberOf" : "" + }, + { + "name" : "aria_valuemin", + "type" : "Number", + "desc" : "aria-value min", + "memberOf" : "" + }, + { + "name" : "aria_valuenow", + "type" : "Number", + "desc" : "aria-value now", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "label", + "type" : "String", + "desc" : "label for the progress bar", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "panel", + "type" : "String", + "desc" : [ + "(success", + "info", + "warning", + "danger )" + ], + "memberOf" : "" + }, + { + "name" : "role", + "type" : "String", + "desc" : "role of the progress bar", + "memberOf" : "" + }, + { + "name" : "sr_only", + "type" : "String", + "desc" : "text", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.Radio" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "boxLabel", + "type" : "String", + "desc" : "- the label associated", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "value", + "type" : "String", + "desc" : "- the value of radio", + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.RadioSet" : { + "props" : [ + { + "name" : "accept", + "type" : "String", + "desc" : [ + "(image", + "video", + "audio)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "center", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "capture", + "type" : "String", + "desc" : [ + "(user", + "camera)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "" + }, + { + "name" : "inline", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : [ + "(top", + "left)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "weight", + "type" : "String", + "desc" : [ + "(primary", + "warning", + "info", + "danger", + "success)" + ], + "memberOf" : "" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "check", + "type" : "function", + "desc" : "Fires when the element is checked or unchecked.", + "sig" : "function (_self, item)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when the element is click.", + "sig" : "function (_self, item, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "inputEl", + "type" : "function", + "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "markValid", + "type" : "function", + "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + } + ] + }, + "Roo.bootstrap.Row" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.SecurePass" : { + "props" : [ + { + "name" : "Label", + "type" : "String/Object", + "desc" : "for the strength meter (defaults to\n'Password strength:')", + "memberOf" : "" + }, + { + "name" : "accept", + "type" : "String", + "desc" : [ + "(image", + "video", + "audio)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "center", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "capture", + "type" : "String", + "desc" : [ + "(user", + "camera)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "errors", + "type" : "String/Object", + "desc" : "A Error spec, or true for a default spec (defaults to\n{\n PwdEmpty: \"Please type a password, and then retype it to confirm.\",\n PwdShort: \"Your password must be at least 6 characters long. Please type a different password.\",\n PwdLong: \"Your password can't contain more than 16 characters. Please type a different password.\",\n PwdBadChar: \"The password contains characters that aren't allowed. Please type a different password.\",\n IDInPwd: \"Your password can't include the part of your ID. Please type a different password.\",\n FNInPwd: \"Your password can't contain your first name. Please type a different password.\",\n LNInPwd: \"Your password can't contain your last name. Please type a different password.\"\n})", + "memberOf" : "" + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : [ + "(top", + "left)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "pwdStrengths", + "type" : "String/Object", + "desc" : "A pwdStrengths spec, or true for a default spec (defaults to\n['Weak', 'Medium', 'Strong'])", + "memberOf" : "" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "inputEl", + "type" : "function", + "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "markValid", + "type" : "function", + "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + } + ] + }, + "Roo.bootstrap.Slider" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.SplitBar" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "beforeresize", + "type" : "function", + "desc" : "Fires before the splitter is dragged", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "moved", + "type" : "function", + "desc" : "Fires when the splitter is moved", + "sig" : "function (_self, newSize)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})", + "sig" : "function (_self, newSize)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroy this splitbar.", + "sig" : "(removeEl)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getAdapter", + "type" : "function", + "desc" : "Get the adapter this SplitBar uses", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getMaximumSize", + "type" : "function", + "desc" : "Gets the maximum size for the resizing element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getMinimumSize", + "type" : "function", + "desc" : "Gets the minimum size for the resizing element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "setAdapter", + "type" : "function", + "desc" : "Set the adapter this SplitBar uses", + "sig" : "(adapter)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setCurrentSize", + "type" : "function", + "desc" : "Sets the initialize size for the resizing element", + "sig" : "(size)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setMaximumSize", + "type" : "function", + "desc" : "Sets the maximum size for the resizing element", + "sig" : "(maxSize)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setMinimumSize", + "type" : "function", + "desc" : "Sets the minimum size for the resizing element", + "sig" : "(minSize)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "getElementSize", + "type" : "function", + "desc" : "Called before drag operations to get the current size of the resizing element.", + "sig" : "(s)", + "static" : false, + "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter" + }, + { + "name" : "setElementSize", + "type" : "function", + "desc" : "Called after drag operations to set the size of the resizing element.", + "sig" : "(s, newSize, onComplete)", + "static" : false, + "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter" + } + ] + }, + "Roo.bootstrap.SplitBar.BasicLayoutAdapter" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "getElementSize", + "type" : "function", + "desc" : "Called before drag operations to get the current size of the resizing element.", + "sig" : "(s)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setElementSize", + "type" : "function", + "desc" : "Called after drag operations to set the size of the resizing element.", + "sig" : "(s, newSize, onComplete)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.bootstrap.TabGroup" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "alert", + "type" : "String", + "desc" : [ + "(success", + "info", + "warning", + "danger)" + ], + "memberOf" : "Roo.bootstrap.Column" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autoslide", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "bullets", + "type" : "Boolean", + "desc" : "show bullets for the panels", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "carousel", + "type" : "Boolean", + "desc" : "true to make the group behave like a carousel", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "fa", + "type" : "String", + "desc" : [ + "(ban", + "check", + "...)" + ], + "memberOf" : "Roo.bootstrap.Column" + }, + { + "name" : "fasize", + "type" : "Number", + "desc" : [ + "(1", + "2", + "....)" + ], + "memberOf" : "Roo.bootstrap.Column" + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Column" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "html", + "type" : "String", + "desc" : "content of column.", + "memberOf" : "Roo.bootstrap.Column" + }, + { + "name" : "icon", + "type" : "String", + "desc" : [ + "(info-sign", + "check", + "...)" + ], + "memberOf" : "Roo.bootstrap.Column" + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column" + }, + { + "name" : "lgoff", + "type" : "Number", + "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column" + }, + { + "name" : "mdoff", + "type" : "Number", + "desc" : "colspan offset out of 12 for computer-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "navId", + "type" : "String", + "desc" : "the navigation id (for use with navbars) - will be auto generated if it does not exist..", + "memberOf" : "" + }, + { + "name" : "showarrow", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column" + }, + { + "name" : "smoff", + "type" : "Number", + "desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "timer", + "type" : "Number", + "desc" : "auto slide timer .. default 0 millisecond", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column" + }, + { + "name" : "xsoff", + "type" : "Number", + "desc" : "colspan offset out of 12 for mobile-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "get", + "type" : "function", + "desc" : "fetch a Navigation Group based on the navigation ID\nif one does not exist , it will get created.", + "sig" : "(the)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "register", + "type" : "function", + "desc" : "register a Navigation item", + "sig" : "(the)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "register", + "type" : "function", + "desc" : "register a Navigation Group", + "sig" : "(the)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "showPanel", + "type" : "function", + "desc" : "show a specific panel", + "sig" : "(panel)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.TabPanel" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : "panel active", + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "href", + "type" : "String", + "desc" : "click to link..", + "memberOf" : "" + }, + { + "name" : "html", + "type" : "String", + "desc" : "panel content", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "navId", + "type" : "String", + "desc" : "The Roo.bootstrap.NavGroup which triggers show hide ()", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tabId", + "type" : "String", + "desc" : "unique tab ID (will be autogenerated if not set. - used to match TabItem to Panel)", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedeactivate", + "type" : "function", + "desc" : "Fires before a tab is de-activated - can be used to do validation on a form.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "changed", + "type" : "function", + "desc" : "Fires when the active status changes", + "sig" : "function (_self, state)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.Table" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "center", + "right)" + ], + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "auto_hide_footer", + "type" : "Boolean", + "desc" : "auto hide footer if only one page (default false)", + "memberOf" : "" + }, + { + "name" : "bgcolor", + "type" : "String", + "desc" : "Specifies the background color for a table", + "memberOf" : "" + }, + { + "name" : "border", + "type" : "Number", + "desc" : "Specifies whether the table cells should have borders or not", + "memberOf" : "" + }, + { + "name" : "bordered", + "type" : "boolean", + "desc" : "Add borders to the table", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cellSelection", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "cellpadding", + "type" : "Number", + "desc" : "Specifies the space between the cell wall and the cell content", + "memberOf" : "" + }, + { + "name" : "cellspacing", + "type" : "Number", + "desc" : "Specifies the space between cells", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "table class", + "memberOf" : "" + }, + { + "name" : "condensed", + "type" : "boolean", + "desc" : "Format condensed", + "memberOf" : "" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "footer", + "type" : "Roo.bootstrap.PagingToolbar", + "desc" : "a paging toolbar", + "memberOf" : "" + }, + { + "name" : "footerShow", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "frame", + "type" : "String", + "desc" : "Specifies which parts of the outside borders that should be visible", + "memberOf" : "" + }, + { + "name" : "headerShow", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hover", + "type" : "boolean", + "desc" : "Add hover highlighting", + "memberOf" : "" + }, + { + "name" : "layout", + "type" : "String", + "desc" : "table layout (auto | fixed | initial | inherit)", + "memberOf" : "" + }, + { + "name" : "lazyLoad", + "type" : "Boolean", + "desc" : "auto load data while scrolling to the end (default false)", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadMask", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "responsive", + "type" : "boolean", + "desc" : "Format condensed", + "memberOf" : "" + }, + { + "name" : "rowSelection", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "rules", + "type" : "String", + "desc" : "Specifies which parts of the inside borders that should be visible", + "memberOf" : "" + }, + { + "name" : "scrollBody", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "sortable", + "type" : "String", + "desc" : "Specifies that the table should be sortable", + "memberOf" : "" + }, + { + "name" : "striped", + "type" : "boolean", + "desc" : "Should the rows be alternative striped", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "summary", + "type" : "String", + "desc" : "Specifies a summary of the content of a table", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "Specifies the width of a table", + "memberOf" : "" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "cellclick", + "type" : "function", + "desc" : "Fires when a cell is clicked", + "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "cellcontextmenu", + "type" : "function", + "desc" : "Fires when a cell is right clicked", + "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "celldblclick", + "type" : "function", + "desc" : "Fires when a cell is double clicked", + "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "contextmenu", + "type" : "function", + "desc" : "The raw contextmenu event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "headercontextmenu", + "type" : "function", + "desc" : "Fires when a header is right clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "mouseout", + "type" : "function", + "desc" : "Fires when a mouseout occur", + "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "mouseover", + "type" : "function", + "desc" : "Fires when a mouseover occur", + "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "rowclass", + "type" : "function", + "desc" : "Fires when a row is rendered, so you can change add a style to it.", + "sig" : "function (_self, rowcfg)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "rowclick", + "type" : "function", + "desc" : "Fires when a row is clicked", + "sig" : "function (_self, el, rowIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "rowcontextmenu", + "type" : "function", + "desc" : "Fires when a row is right clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "rowdblclick", + "type" : "function", + "desc" : "Fires when a row is double clicked", + "sig" : "function (_self, el, rowIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "rowsrendered", + "type" : "function", + "desc" : "Fires when all the rows have been rendered", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "Forces a resize - used by panel.Grid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clear", + "type" : "function", + "desc" : "Remove all rows", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getGridEl", + "type" : "function", + "desc" : "Returns the grid's underlying element = used by panel.Grid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setRowVisibility", + "type" : "function", + "desc" : "Show or hide a row.", + "sig" : "(rowIndex, state)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.Table.AbstractSelectionModel" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "isLocked", + "type" : "function", + "desc" : "Returns true if the selections are locked.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "lock", + "type" : "function", + "desc" : "Locks the selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unlock", + "type" : "function", + "desc" : "Unlocks the selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.bootstrap.Table.RowSelectionModel" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "singleSelect", + "type" : "Boolean", + "desc" : "True to allow selection of only one row at a time (defaults to false)", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "afterselectionchange", + "type" : "function", + "desc" : "Fires after the selection changes (eg. by key press or clicking)", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforerowselect", + "type" : "function", + "desc" : "Fires when a row is selected being selected, return false to cancel.", + "sig" : "function (_self, rowIndex, keepExisting)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "rowdeselect", + "type" : "function", + "desc" : "Fires when a row is deselected.", + "sig" : "function (_self, rowIndex)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "rowselect", + "type" : "function", + "desc" : "Fires when a row is selected.", + "sig" : "function (_self, rowIndex, r)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "selectionchange", + "type" : "function", + "desc" : "Fires when the selection changes", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearSelections", + "type" : "function", + "desc" : "Clears all selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "deselectRange", + "type" : "function", + "desc" : "Deselects a range of rows. All rows in between startRow and endRow are also deselected.", + "sig" : "(startRow, endRow)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "deselectRow", + "type" : "function", + "desc" : "Deselects a row.", + "sig" : "(row)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getCount", + "type" : "function", + "desc" : "Gets the number of selected rows.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getSelected", + "type" : "function", + "desc" : "Returns the first selected record.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getSelections", + "type" : "function", + "desc" : "Returns the selected records", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hasSelection", + "type" : "function", + "desc" : "Returns True if there is a selection.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isIdSelected", + "type" : "function", + "desc" : "Returns True if the specified record id is selected.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isLocked", + "type" : "function", + "desc" : "Returns true if the selections are locked.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Table.AbstractSelectionModel" + }, + { + "name" : "isSelected", + "type" : "function", + "desc" : "Returns True if the specified row is selected.", + "sig" : "(record)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "lock", + "type" : "function", + "desc" : "Locks the selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Table.AbstractSelectionModel" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "selectAll", + "type" : "function", + "desc" : "Selects all rows.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectFirstRow", + "type" : "function", + "desc" : "Selects the first row in the grid.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectLastRow", + "type" : "function", + "desc" : "Select the last row.", + "sig" : "(keepExisting)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectNext", + "type" : "function", + "desc" : "Selects the row immediately following the last selected row.", + "sig" : "(keepExisting)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectPrevious", + "type" : "function", + "desc" : "Selects the row that precedes the last selected row.", + "sig" : "(keepExisting)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectRange", + "type" : "function", + "desc" : "Selects a range of rows. All rows in between startRow and endRow are also selected.", + "sig" : "(startRow, endRow, keepExisting)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectRecords", + "type" : "function", + "desc" : "Select records.", + "sig" : "(records, keepExisting)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectRow", + "type" : "function", + "desc" : "Selects a row.", + "sig" : "(row, keepExisting)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectRows", + "type" : "function", + "desc" : "Selects multiple rows.", + "sig" : "(rows, keepExisting)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unlock", + "type" : "function", + "desc" : "Unlocks the selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Table.AbstractSelectionModel" + } + ] + }, + "Roo.bootstrap.TableBody" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "align", + "type" : "String", + "desc" : "Aligns the content inside the element", + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "charoff", + "type" : "Number", + "desc" : "Sets the number of characters the content inside the element will be aligned from the character specified by the char attribute", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "element class", + "memberOf" : "" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tag", + "type" : "String", + "desc" : "element tag (thead|tbody|tfoot) default tbody", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "valign", + "type" : "String", + "desc" : "Vertical aligns the content inside the element", + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.TableCell" : { + "props" : [ + { + "name" : "abbr", + "type" : "String", + "desc" : "Specifies an abbreviated version of the content in a cell", + "memberOf" : "" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "align", + "type" : "String", + "desc" : "Aligns the content in a cell", + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "axis", + "type" : "String", + "desc" : "Categorizes cells", + "memberOf" : "" + }, + { + "name" : "bgcolor", + "type" : "String", + "desc" : "Specifies the background color of a cell", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "charoff", + "type" : "Number", + "desc" : "Sets the number of characters the content will be aligned from the character specified by the char attribute", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "cell class", + "memberOf" : "" + }, + { + "name" : "colspan", + "type" : "Number", + "desc" : "Specifies the number of columns a cell should span", + "memberOf" : "" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "headers", + "type" : "String", + "desc" : "Specifies one or more header cells a cell is related to", + "memberOf" : "" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "Sets the height of a cell", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "html", + "type" : "String", + "desc" : "cell contain text", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "nowrap", + "type" : "String", + "desc" : "Specifies that the content inside a cell should not wrap", + "memberOf" : "" + }, + { + "name" : "rowspan", + "type" : "Number", + "desc" : "Sets the number of rows a cell should span", + "memberOf" : "" + }, + { + "name" : "scope", + "type" : "String", + "desc" : "Defines a way to associate header cells and data cells in a table", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tag", + "type" : "String", + "desc" : "cell tag (td|th) default td", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "valign", + "type" : "String", + "desc" : "Vertical aligns the content in a cell", + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "Specifies the width of a cell", + "memberOf" : "" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.TableRow" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "align", + "type" : "String", + "desc" : "Aligns the content in a table row", + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "bgcolor", + "type" : "String", + "desc" : "Specifies a background color for a table row", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "charoff", + "type" : "Number", + "desc" : "Sets the number of characters the content will be aligned from the character specified by the char attribute", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "row class", + "memberOf" : "" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "valign", + "type" : "String", + "desc" : "Vertical aligns the content in a table row", + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.TextArea" : { + "props" : [ + { + "name" : "accept", + "type" : "String", + "desc" : [ + "(image", + "video", + "audio)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "center", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "capture", + "type" : "String", + "desc" : [ + "(user", + "camera)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cols", + "type" : "Number", + "desc" : "Specifies the visible width of a text area", + "memberOf" : "" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "html", + "type" : "string", + "desc" : "text", + "memberOf" : "" + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : [ + "(top", + "left)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "resize", + "type" : "string", + "desc" : [ + "(none", + "both", + "horizontal", + "vertical", + "inherit", + "initial)" + ], + "memberOf" : "" + }, + { + "name" : "rows", + "type" : "Number", + "desc" : "Specifies the visible number of lines in a text area", + "memberOf" : "" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "wrap", + "type" : "string", + "desc" : [ + "(soft", + "hard)" + ], + "memberOf" : "" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "inputEl", + "type" : "function", + "desc" : "return the real textarea element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "markValid", + "type" : "function", + "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + } + ] + }, + "Roo.bootstrap.TimeField" : { + "props" : [ + { + "name" : "accept", + "type" : "String", + "desc" : [ + "(image", + "video", + "audio)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "center", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "capture", + "type" : "String", + "desc" : [ + "(user", + "camera)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "format", + "type" : "String", + "desc" : "The default time format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'H:i').", + "memberOf" : "" + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : [ + "(top", + "left)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Fires when select a date.", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires when this field show.", + "sig" : "function (thisthis, date)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "inputEl", + "type" : "function", + "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "markValid", + "type" : "function", + "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + } + ] + }, + "Roo.bootstrap.Tooltip" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "currentEl", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "" + } + ] + }, + "Roo.bootstrap.TriggerField" : { + "props" : [ + { + "name" : "accept", + "type" : "String", + "desc" : [ + "(image", + "video", + "audio)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "align", + "type" : "String", + "desc" : [ + "(left", + "center", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "capture", + "type" : "String", + "desc" : [ + "(user", + "camera)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "caret", + "type" : "String", + "desc" : [ + "(search", + "calendar)" + ], + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "" + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : [ + "(left", + "right)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : [ + "(top", + "left)" + ], + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "removable", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be appended if specified.", + "memberOf" : "" + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Input" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "inputEl", + "type" : "function", + "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "markValid", + "type" : "function", + "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onTriggerClick", + "type" : "function", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input" + } + ] + }, + "Roo.bootstrap.UploadCropbox" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "buttons", + "type" : "Array", + "desc" : "default ['rotateLeft', 'pictureBtn', 'rotateRight']", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "show when image has been loaded", + "memberOf" : "" + }, + { + "name" : "errorTimeout", + "type" : "Number", + "desc" : "default 3000", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "isDocument", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadMask", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "loadingText", + "type" : "Boolean", + "desc" : "default 'Loading...'", + "memberOf" : "" + }, + { + "name" : "method", + "type" : "String", + "desc" : "default POST", + "memberOf" : "" + }, + { + "name" : "minHeight", + "type" : "Number", + "desc" : "default 300", + "memberOf" : "" + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "default 300", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "paramName", + "type" : "String", + "desc" : "default 'imageUpload'", + "memberOf" : "" + }, + { + "name" : "rotateNotify", + "type" : "String", + "desc" : "show when image too small to rotate", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "url", + "type" : "String", + "desc" : "action url", + "memberOf" : "" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "arrange", + "type" : "function", + "desc" : "Fire when arrange the file data", + "sig" : "function (_self, formData)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeloadcanvas", + "type" : "function", + "desc" : "Fire before load the canvas", + "sig" : "function (_self, src)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeselectfile", + "type" : "function", + "desc" : "Fire before select file", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "crop", + "type" : "function", + "desc" : "Fire after initEvent", + "sig" : "function (_self, data)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "download", + "type" : "function", + "desc" : "Fire when download the image", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "exception", + "type" : "function", + "desc" : "Fire when get exception", + "sig" : "function (_self, xhr)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "footerbuttonclick", + "type" : "function", + "desc" : "Fire when footerbuttonclick", + "sig" : "function (_self, type)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "initial", + "type" : "function", + "desc" : "Fire after initEvent", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "inspect", + "type" : "function", + "desc" : "Fire when inspect the file", + "sig" : "function (_self, file)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "prepare", + "type" : "function", + "desc" : "Fire when preparing the file data", + "sig" : "function (_self, file)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fire when resize", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "rotate", + "type" : "function", + "desc" : "Fire when rotate the image", + "sig" : "function (_self, pos)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "trash", + "type" : "function", + "desc" : "Fire when trash image", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "upload", + "type" : "function", + "desc" : "Fire when xhr upload the file", + "sig" : "function (_self, data)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.dash" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.bootstrap.dash.NumberBox" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "content", + "type" : "String", + "desc" : "Box content", + "memberOf" : "" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "fhref", + "type" : "String", + "desc" : "Footer href", + "memberOf" : "" + }, + { + "name" : "footer", + "type" : "String", + "desc" : "Footer text", + "memberOf" : "" + }, + { + "name" : "headline", + "type" : "String", + "desc" : "Box headline", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "icon", + "type" : "String", + "desc" : "Box icon", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.dash.TabBox" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "icon", + "type" : "String", + "desc" : "Icon of the TabBox", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "showtabs", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tabScrollable", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "title", + "type" : "String", + "desc" : "Title of the TabBox", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "activatepane", + "type" : "function", + "desc" : "When a pane is activated", + "sig" : "function (pane)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "addpane", + "type" : "function", + "desc" : "When a pane is added", + "sig" : "function (pane)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setTitle", + "type" : "function", + "desc" : "Updates the box title", + "sig" : "(html)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.dash.TabPane" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : [ + "(false", + "true)" + ], + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "title", + "type" : "String", + "desc" : "title of panel", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "When a pane is activated", + "sig" : "function (pane)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setTitle", + "type" : "function", + "desc" : "Updates the tab title", + "sig" : "(html)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.htmleditor" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.bootstrap.htmleditor.ToolbarStandard" : { + "props" : [ + { + "name" : "btns", + "type" : "Array", + "desc" : "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }", + "memberOf" : "" + }, + { + "name" : "disable", + "type" : "Object", + "desc" : "List of elements to disable..", + "memberOf" : "" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "updateToolbar", + "type" : "function", + "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.bootstrap.layout" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.bootstrap.layout.Basic" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "mgr", + "type" : "Roo.bootstrap.layout.Manager", + "desc" : "The manager", + "memberOf" : "" + }, + { + "name" : "region", + "type" : "string", + "desc" : "the region that it inhabits..", + "memberOf" : "" + }, + { + "name" : "skipConfig", + "type" : "bool", + "desc" : "skip config?", + "memberOf" : "" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Add the passed ContentPanel(s)", + "sig" : "(panel)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getActivePanel", + "type" : "function", + "desc" : "Get the active panel for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the container element for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getPanel", + "type" : "function", + "desc" : "Returns the panel specified or null if it's not in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Returns this regions position (north/south/east/west/center).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hasPanel", + "type" : "function", + "desc" : "Returns true if the panel is in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this region is currently visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", + "sig" : "(panel, preservePanel)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "resizeTo", + "type" : "function", + "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", + "sig" : "(newSize)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "showPanel", + "type" : "function", + "desc" : "Show the specified panel.", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.layout.Border" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "layout", + "type" : "function", + "desc" : "Fires when a layout is performed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.layout.Manager" + }, + { + "name" : "regioncollapsed", + "type" : "function", + "desc" : "Fires when a region is collapsed.", + "sig" : "function (region)\n{\n\n}", + "memberOf" : "Roo.bootstrap.layout.Manager" + }, + { + "name" : "regionexpanded", + "type" : "function", + "desc" : "Fires when a region is expanded.", + "sig" : "function (region)\n{\n\n}", + "memberOf" : "Roo.bootstrap.layout.Manager" + }, + { + "name" : "regionresized", + "type" : "function", + "desc" : "Fires when the user resizes a region.", + "sig" : "function (region, newSize)\n{\n\n}", + "memberOf" : "Roo.bootstrap.layout.Manager" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Adds a ContentPanel (or subclass) to this layout.", + "sig" : "(target, panel)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addRegion", + "type" : "function", + "desc" : "Creates and adds a new region if it doesn't already exist.", + "sig" : "(target, config)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addxtype", + "type" : "function", + "desc" : "Adds a xtype elements to the layout.\n
\n\nlayout.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\nlayout.addxtype({\n        xtype : 'NestedLayoutPanel',\n        region: 'west',\n        layout: {\n           center: { },\n           west: { }   \n        },\n        items : [ ... list of content panels or nested layout panels.. ]\n   }\n);\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "beginUpdate", + "type" : "function", + "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Manager" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "endUpdate", + "type" : "function", + "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout", + "sig" : "(noLayout)", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Manager" + }, + { + "name" : "findPanel", + "type" : "function", + "desc" : "Searches all regions for a panel with the specified id", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the Element this layout is bound to.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Manager" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getRegion", + "type" : "function", + "desc" : "Returns the specified region.", + "sig" : "(target)", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Manager" + }, + { + "name" : "getViewSize", + "type" : "function", + "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Manager" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isUpdating", + "type" : "function", + "desc" : "Returns true if this layout is currently being updated", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Manager" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "layout", + "type" : "function", + "desc" : "Performs a layout update.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Remove a ContentPanel (or subclass) to this layout.", + "sig" : "(target, panel)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "showPanel", + "type" : "function", + "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.layout.Manager" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "layout", + "type" : "function", + "desc" : "Fires when a layout is performed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "regioncollapsed", + "type" : "function", + "desc" : "Fires when a region is collapsed.", + "sig" : "function (region)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "regionexpanded", + "type" : "function", + "desc" : "Fires when a region is expanded.", + "sig" : "function (region)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "regionresized", + "type" : "function", + "desc" : "Fires when the user resizes a region.", + "sig" : "function (region, newSize)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "beginUpdate", + "type" : "function", + "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "endUpdate", + "type" : "function", + "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout", + "sig" : "(noLayout)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the Element this layout is bound to.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getRegion", + "type" : "function", + "desc" : "Returns the specified region.", + "sig" : "(target)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getViewSize", + "type" : "function", + "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isUpdating", + "type" : "function", + "desc" : "Returns true if this layout is currently being updated", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.layout.Region" : { + "props" : [ + { + "name" : "alwaysShowTabs", + "type" : "Boolean", + "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)", + "memberOf" : "" + }, + { + "name" : "animate", + "type" : "Boolean", + "desc" : "True to animate expand/collapse (defaults to false)", + "memberOf" : "" + }, + { + "name" : "autoHide", + "type" : "Boolean", + "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)", + "memberOf" : "" + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to enable overflow scrolling (defaults to false)", + "memberOf" : "" + }, + { + "name" : "closeOnTab", + "type" : "Boolean", + "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "string", + "desc" : "Extra CSS classes to add to region", + "memberOf" : "" + }, + { + "name" : "cmargins", + "type" : "Object", + "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})", + "memberOf" : "" + }, + { + "name" : "disableTabTips", + "type" : "Boolean", + "desc" : "True to disable tab tooltips", + "memberOf" : "" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "For North/South panels", + "memberOf" : "" + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to start the region hidden (defaults to false)", + "memberOf" : "" + }, + { + "name" : "hideTabs", + "type" : "Boolean", + "desc" : "True to hide the tab strip (defaults to false)", + "memberOf" : "" + }, + { + "name" : "hideWhenEmpty", + "type" : "Boolean", + "desc" : "True to hide the region when it has no panels", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "margins", + "type" : "Object", + "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})", + "memberOf" : "" + }, + { + "name" : "mgr", + "type" : "Roo.bootstrap.layout.Manager", + "desc" : "The manager", + "memberOf" : "" + }, + { + "name" : "minTabWidth", + "type" : "Number", + "desc" : "The minimum tab width (defaults to 40)", + "memberOf" : "" + }, + { + "name" : "overflow", + "type" : "String", + "desc" : [ + "(hidden", + "visible)" + ], + "memberOf" : "" + }, + { + "name" : "preferredTabWidth", + "type" : "Number", + "desc" : "The preferred tab width (defaults to 150)", + "memberOf" : "" + }, + { + "name" : "preservePanels", + "type" : "Boolean", + "desc" : "True to preserve removed panels so they can be readded later (defaults to false)", + "memberOf" : "" + }, + { + "name" : "region", + "type" : "string", + "desc" : "the region that it inhabits..", + "memberOf" : "" + }, + { + "name" : "resizeTabs", + "type" : "Boolean", + "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)", + "memberOf" : "" + }, + { + "name" : "skipConfig", + "type" : "bool", + "desc" : "skip config?", + "memberOf" : "Roo.bootstrap.layout.Basic" + }, + { + "name" : "split", + "type" : "Boolean", + "desc" : "To show the splitter", + "memberOf" : "" + }, + { + "name" : "tabPosition", + "type" : "String", + "desc" : [ + "(top", + "bottom)" + ], + "memberOf" : "" + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title for the region (overrides panel titles)", + "memberOf" : "" + }, + { + "name" : "titlebar", + "type" : "Boolean", + "desc" : "True to display a title bar (defaults to true)", + "memberOf" : "" + }, + { + "name" : "toolbar", + "type" : "Boolean", + "desc" : "xtype configuration for a toolbar - shows on right of tabbar", + "memberOf" : "" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "For East/West panels", + "memberOf" : "" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Adds the passed ContentPanel(s) to this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "animateCollapse", + "type" : "function", + "desc" : "Collapses this region.", + "sig" : "(skipAnim)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "animateExpand", + "type" : "function", + "desc" : "Expands this region if it was previously collapsed.", + "sig" : "(e, skipAnim)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getActivePanel", + "type" : "function", + "desc" : "Get the active panel for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)", + "sig" : "(title)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the container element for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getPanel", + "type" : "function", + "desc" : "Returns the panel specified or null if it's not in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Basic" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Returns this regions position (north/south/east/west/center).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Basic" + }, + { + "name" : "getTabs", + "type" : "function", + "desc" : "Returns the TabPanel component used by this region", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hasPanel", + "type" : "function", + "desc" : "Returns true if the panel is in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Basic" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hides this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hidePanel", + "type" : "function", + "desc" : "Hides the tab for the specified panel.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this region is currently visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", + "sig" : "(panel, preservePanel)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "resizeTo", + "type" : "function", + "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", + "sig" : "(newSize)", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Basic" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Shows this region if it was previously hidden.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "showPanel", + "type" : "function", + "desc" : "Shows the specified panel.", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unhidePanel", + "type" : "function", + "desc" : "Unhides the tab for a previously hidden panel.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.bootstrap.layout.Split" : { + "props" : [ + { + "name" : "alwaysShowTabs", + "type" : "Boolean", + "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "animate", + "type" : "Boolean", + "desc" : "True to animate expand/collapse (defaults to false)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "autoHide", + "type" : "Boolean", + "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to enable overflow scrolling (defaults to false)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "closeOnTab", + "type" : "Boolean", + "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "cmargins", + "type" : "Object", + "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "collapsed", + "type" : "Boolean", + "desc" : "True to set the initial display to collapsed (defaults to false)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "collapsedTitle", + "type" : "String", + "desc" : "Optional string message to display in the collapsed block of a north or south region", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "collapsible", + "type" : "Boolean", + "desc" : "False to disable collapsing (defaults to true)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "disableTabTips", + "type" : "Boolean", + "desc" : "True to disable tab tooltips", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "floatable", + "type" : "Boolean", + "desc" : "False to disable floating (defaults to true)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "For North/South panels", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to start the region hidden (defaults to false)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "hideTabs", + "type" : "Boolean", + "desc" : "True to hide the tab strip (defaults to false)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "hideWhenEmpty", + "type" : "Boolean", + "desc" : "True to hide the region when it has no panels", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "margins", + "type" : "Object", + "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "minTabWidth", + "type" : "Number", + "desc" : "The minimum tab width (defaults to 40)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "preferredTabWidth", + "type" : "Number", + "desc" : "The preferred tab width (defaults to 150)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "preservePanels", + "type" : "Boolean", + "desc" : "True to preserve removed panels so they can be readded later (defaults to false)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "resizeTabs", + "type" : "Boolean", + "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "showPin", + "type" : "Boolean", + "desc" : "True to show a pin button", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "split", + "type" : "Boolean", + "desc" : "To show the splitter", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "tabPosition", + "type" : "String", + "desc" : [ + "(top", + "bottom)" + ], + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title for the region (overrides panel titles)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "titlebar", + "type" : "Boolean", + "desc" : "True to display a title bar (defaults to true)", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "toolbar", + "type" : "Boolean", + "desc" : "xtype configuration for a toolbar - shows on right of tabbar", + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "For East/West panels", + "memberOf" : "Roo.LayoutRegion" + } + ], + "events" : [ + { + "name" : "beforecollapse", + "type" : "function", + "desc" : "Fires when this region before collapse.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "beforeremove", + "type" : "function", + "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.", + "sig" : "function (_self, panel, e)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "collapsed", + "type" : "function", + "desc" : "Fires when this region is collapsed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "expanded", + "type" : "function", + "desc" : "Fires when this region is expanded.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "invalidated", + "type" : "function", + "desc" : "Fires when the layout for this region is changed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "panelactivated", + "type" : "function", + "desc" : "Fires when a panel is activated.", + "sig" : "function (_self, panel)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "paneladded", + "type" : "function", + "desc" : "Fires when a panel is added.", + "sig" : "function (_self, panel)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "panelremoved", + "type" : "function", + "desc" : "Fires when a panel is removed.", + "sig" : "function (_self, panel)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "resized", + "type" : "function", + "desc" : "Fires when the user resizes this region.", + "sig" : "function (_self, newSize)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "slidehide", + "type" : "function", + "desc" : "Fires when this region slides out of view.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "slideshow", + "type" : "function", + "desc" : "Fires when this region is slid into view.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "visibilitychange", + "type" : "function", + "desc" : "Fires when this region is shown or hidden", + "sig" : "function (_self, visibility)\n{\n\n}", + "memberOf" : "Roo.BasicLayoutRegion" + } + ], + "methods" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Adds the passed ContentPanel(s) to this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "collapse", + "type" : "function", + "desc" : "Collapses this region.", + "sig" : "(skipAnim)", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Expands this region if it was previously collapsed.", + "sig" : "(e, skipAnim)", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getActivePanel", + "type" : "function", + "desc" : "Get the active panel for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the container element for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "getPanel", + "type" : "function", + "desc" : "Returns the panel specified or null if it's not in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Returns this regions position (north/south/east/west/center).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "getSplitBar", + "type" : "function", + "desc" : "Returns the {@link Roo.SplitBar} for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getTabs", + "type" : "function", + "desc" : "Returns the TabPanel component used by this region", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hasPanel", + "type" : "function", + "desc" : "Returns true if the panel is in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hides this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "hidePanel", + "type" : "function", + "desc" : "Hides the tab for the specified panel.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this region is currently visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", + "sig" : "(panel, preservePanel)", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "resizeTo", + "type" : "function", + "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", + "sig" : "(newSize)", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion" + }, + { + "name" : "setCollapsedTitle", + "type" : "function", + "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)", + "sig" : "(title)", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Shows this region if it was previously hidden.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "showPanel", + "type" : "function", + "desc" : "Shows the specified panel.", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unhidePanel", + "type" : "function", + "desc" : "Unhides the tab for a previously hidden panel.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.LayoutRegion" + } + ] + }, + "Roo.bootstrap.menu" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.bootstrap.menu.Item" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disable", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "href", + "type" : "String", + "desc" : "the link", + "memberOf" : "" + }, + { + "name" : "html", + "type" : "String", + "desc" : "text of the item", + "memberOf" : "" + }, + { + "name" : "icon", + "type" : "String", + "desc" : "Font awesome icon", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "pos", + "type" : "String", + "desc" : "Submenu align to (left | right) default right", + "memberOf" : "" + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "submenu", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "The raw click event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "mouseout", + "type" : "function", + "desc" : "Fires when the mouse exits this menu", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "mouseover", + "type" : "function", + "desc" : "Fires when the mouse is hovering over this menu", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.menu.Menu" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "html", + "type" : "String", + "desc" : "Text of the menu", + "memberOf" : "" + }, + { + "name" : "icon", + "type" : "String", + "desc" : "Font awesome icon", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "pos", + "type" : "String", + "desc" : "Menu align to (top | bottom) default bottom", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "weight", + "type" : "String", + "desc" : [ + "(default", + "primary", + "success", + "info", + "warning", + "danger", + "inverse)" + ], + "memberOf" : "" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before this menu is hidden", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before this menu is displayed", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after this menu is hidden", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after this menu is displayed", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.menu.Separator" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : [ + "(el", + "parent)" + ], + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getVisibilityEl", + "type" : "function", + "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisibilityEl", + "type" : "function", + "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.panel" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.bootstrap.panel.Content" : { + "props" : [ + { + "name" : "adjustments", + "type" : "Array", + "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", + "memberOf" : "" + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", + "memberOf" : "" + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", + "memberOf" : "" + }, + { + "name" : "background", + "type" : "Boolean", + "desc" : "True if the panel should not be activated when it is added (defaults to false)", + "memberOf" : "" + }, + { + "name" : "badges", + "type" : "Boolean", + "desc" : "render the badges", + "memberOf" : "" + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "True if the panel can be closed/removed", + "memberOf" : "" + }, + { + "name" : "content", + "type" : "String", + "desc" : "Raw content to fill content panel with (uses setContent on construction.)", + "memberOf" : "" + }, + { + "name" : "fitContainer", + "type" : "Boolean", + "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", + "memberOf" : "" + }, + { + "name" : "fitToFrame", + "type" : "Boolean", + "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "" + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "" + }, + { + "name" : "region", + "type" : "String", + "desc" : [ + "(center", + "north", + "south", + "east", + "west)" + ], + "memberOf" : "" + }, + { + "name" : "resizeEl", + "type" : "String/HTMLElement/Element", + "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", + "memberOf" : "" + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title for this panel", + "memberOf" : "" + }, + { + "name" : "toolbar", + "type" : "Toolbar", + "desc" : "A toolbar for this panel", + "memberOf" : "" + }, + { + "name" : "url", + "type" : "String", + "desc" : "Calls {@link #setUrl} with this value", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Fires when this panel is activated.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "deactivate", + "type" : "function", + "desc" : "Fires when this panel is activated.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires when this tab is created", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires when this panel is resized if fitToFrame is true.", + "sig" : "function (_self, width, height)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this panel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns this panel's element - used by regiosn to add.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns this panel's id", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getTitle", + "type" : "function", + "desc" : "Returns this panel's title", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getToolbar", + "type" : "function", + "desc" : "Returns the toolbar for this Panel if one was configured.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getUpdateManager", + "type" : "function", + "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "isClosable", + "type" : "function", + "desc" : "Returns true is this panel was configured to be closable", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.", + "sig" : "(url, params, callback, discardUrl)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "refresh", + "type" : "function", + "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "setContent", + "type" : "function", + "desc" : "Updates this panel's element", + "sig" : "(content, loadScripts)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setTitle", + "type" : "function", + "desc" : "Set this panel's title", + "sig" : "(title)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setUrl", + "type" : "function", + "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "sig" : "(url, params, loadOnce)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.panel.Grid" : { + "props" : [ + { + "name" : "adjustments", + "type" : "Array", + "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "background", + "type" : "Boolean", + "desc" : "True if the panel should not be activated when it is added (defaults to false)", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "badges", + "type" : "Boolean", + "desc" : "render the badges", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "True if the panel can be closed/removed", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "content", + "type" : "String", + "desc" : "Raw content to fill content panel with (uses setContent on construction.)", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "fitContainer", + "type" : "Boolean", + "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "fitToFrame", + "type" : "Boolean", + "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "grid", + "type" : "Roo.bootstrap.Table", + "desc" : "The grid for this panel", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "region", + "type" : "String", + "desc" : [ + "(center", + "north", + "south", + "east", + "west)" + ], + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "resizeEl", + "type" : "String/HTMLElement/Element", + "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title for this panel", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "toolbar", + "type" : "Toolbar", + "desc" : "A toolbar for this panel", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "url", + "type" : "String", + "desc" : "Calls {@link #setUrl} with this value", + "memberOf" : "Roo.bootstrap.panel.Content" + } + ], + "events" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Fires when this panel is activated.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "deactivate", + "type" : "function", + "desc" : "Fires when this panel is activated.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires when this tab is created", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires when this panel is resized if fitToFrame is true.", + "sig" : "function (_self, width, height)\n{\n\n}", + "memberOf" : "Roo.bootstrap.panel.Content" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this panel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns this panel's element - used by regiosn to add.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "getGrid", + "type" : "function", + "desc" : "Returns the grid for this panel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns this panel's id", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "getTitle", + "type" : "function", + "desc" : "Returns this panel's title", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "getToolbar", + "type" : "function", + "desc" : "Returns the toolbar for this Panel if one was configured.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "getUpdateManager", + "type" : "function", + "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "isClosable", + "type" : "function", + "desc" : "Returns true is this panel was configured to be closable", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.", + "sig" : "(url, params, callback, discardUrl)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "refresh", + "type" : "function", + "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "setContent", + "type" : "function", + "desc" : "Updates this panel's element", + "sig" : "(content, loadScripts)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "setTitle", + "type" : "function", + "desc" : "Set this panel's title", + "sig" : "(title)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "setUrl", + "type" : "function", + "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "sig" : "(url, params, loadOnce)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.panel.Nest" : { + "props" : [ + { + "name" : "adjustments", + "type" : "Array", + "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "background", + "type" : "Boolean", + "desc" : "True if the panel should not be activated when it is added (defaults to false)", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "badges", + "type" : "Boolean", + "desc" : "render the badges", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "True if the panel can be closed/removed", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "content", + "type" : "String", + "desc" : "Raw content to fill content panel with (uses setContent on construction.)", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "fitContainer", + "type" : "Boolean", + "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "fitToFrame", + "type" : "Boolean", + "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "region", + "type" : "String", + "desc" : [ + "(center", + "north", + "south", + "east", + "west)" + ], + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "resizeEl", + "type" : "String/HTMLElement/Element", + "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title for this panel", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "toolbar", + "type" : "Toolbar", + "desc" : "A toolbar for this panel", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "url", + "type" : "String", + "desc" : "Calls {@link #setUrl} with this value", + "memberOf" : "Roo.bootstrap.panel.Content" + } + ], + "events" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Fires when this panel is activated.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "deactivate", + "type" : "function", + "desc" : "Fires when this panel is activated.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires when this tab is created", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires when this panel is resized if fitToFrame is true.", + "sig" : "function (_self, width, height)\n{\n\n}", + "memberOf" : "Roo.bootstrap.panel.Content" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addxtype", + "type" : "function", + "desc" : "Adds a xtype elements to the layout of the nested panel\n
\n\npanel.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\npanel.addxtype({\n        xtype : 'NestedLayoutPanel',\n        region: 'west',\n        layout: {\n           center: { },\n           west: { }   \n        },\n        items : [ ... list of content panels or nested layout panels.. ]\n   }\n);\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this panel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns this panel's element - used by regiosn to add.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns this panel's id", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "getLayout", + "type" : "function", + "desc" : "Returns the nested BorderLayout for this panel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getTitle", + "type" : "function", + "desc" : "Returns this panel's title", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "getToolbar", + "type" : "function", + "desc" : "Returns the toolbar for this Panel if one was configured.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "getUpdateManager", + "type" : "function", + "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "isClosable", + "type" : "function", + "desc" : "Returns true is this panel was configured to be closable", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.", + "sig" : "(url, params, callback, discardUrl)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "refresh", + "type" : "function", + "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "setContent", + "type" : "function", + "desc" : "Updates this panel's element", + "sig" : "(content, loadScripts)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "setTitle", + "type" : "function", + "desc" : "Set this panel's title", + "sig" : "(title)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "setUrl", + "type" : "function", + "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "sig" : "(url, params, loadOnce)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.panel.TabItem" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Fires when this tab becomes the active tab.", + "sig" : "function (tabPanel, _self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeclose", + "type" : "function", + "desc" : "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "close", + "type" : "function", + "desc" : "Fires when this tab is closed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "deactivate", + "type" : "function", + "desc" : "Fires when this tab is no longer the active tab.", + "sig" : "function (tabPanel, _self)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Activates this TabPanelItem -- this does deactivate the currently active TabPanelItem.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enables this TabPanelItem if it was previously disabled.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getText", + "type" : "function", + "desc" : "Returns the text for this tab", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getUpdateManager", + "type" : "function", + "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isActive", + "type" : "function", + "desc" : "Returns true if this tab is the active tab.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isHidden", + "type" : "function", + "desc" : "Returns true if this tab is \"hidden\"", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "refresh", + "type" : "function", + "desc" : "Forces a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the setUrl method has not been called.\n This does not activate the panel, just updates its content.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "setContent", + "type" : "function", + "desc" : "Sets the content for this TabPanelItem.", + "sig" : "(content, loadScripts)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setHidden", + "type" : "function", + "desc" : "Show or hide the tab", + "sig" : "(hidden)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setText", + "type" : "function", + "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)", + "sig" : "(text)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setTooltip", + "type" : "function", + "desc" : "Set the tooltip for the tab.", + "sig" : "(tooltip)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setUrl", + "type" : "function", + "desc" : "Set a URL to be used to load the content for this TabPanelItem.", + "sig" : "(url, params, loadOnce)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Shows this TabPanelItem -- this does not deactivate the currently active TabPanelItem.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.bootstrap.panel.Tabs" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "beforetabchange", + "type" : "function", + "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change", + "sig" : "function (_self, e, tab)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "tabchange", + "type" : "function", + "desc" : "Fires when the active tab changes", + "sig" : "function (_self, activePanel)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addTab", + "type" : "function", + "desc" : "Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.", + "sig" : "(id, text, content, closable)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addTabItem", + "type" : "function", + "desc" : "Adds an existing {@link Roo.TabPanelItem}.", + "sig" : "(item)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "autoSizeTabs", + "type" : "function", + "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "beginUpdate", + "type" : "function", + "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this TabPanel", + "sig" : "(removeEl)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "disableTab", + "type" : "function", + "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "enableTab", + "type" : "function", + "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "endUpdate", + "type" : "function", + "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getActiveTab", + "type" : "function", + "desc" : "Gets the active {@link Roo.TabPanelItem}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getCount", + "type" : "function", + "desc" : "Returns the number of tabs in this TabPanel.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getTab", + "type" : "function", + "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hideTab", + "type" : "function", + "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeTab", + "type" : "function", + "desc" : "Removes a {@link Roo.TabPanelItem}.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setTabWidth", + "type" : "function", + "desc" : "Resizes all the tabs to the passed width", + "sig" : "(The)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "syncHeight", + "type" : "function", + "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling", + "sig" : "(targetHeight)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unhideTab", + "type" : "function", + "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.data" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.data.ArrayReader" : { + "props" : [ + { + "name" : "fields", + "type" : "Array", + "desc" : "Array of field definition objects", + "memberOf" : "" + }, + { + "name" : "id", + "type" : "String", + "desc" : "(optional) The subscript within row Array that provides an ID for the Record", + "memberOf" : "" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "newRow", + "type" : "function", + "desc" : "Create an empty record", + "sig" : "(data)", + "static" : false, + "memberOf" : "Roo.data.DataReader" + }, + { + "name" : "readRecords", + "type" : "function", + "desc" : "Create a data block containing Roo.data.Records from an XML document.", + "sig" : "(o)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.data.Connection" : { + "props" : [ + { + "name" : "autoAbort", + "type" : "Boolean", + "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)", + "memberOf" : "" + }, + { + "name" : "defaultHeaders", + "type" : "Object", + "desc" : "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)", + "memberOf" : "" + }, + { + "name" : "disableCaching", + "type" : "Boolean", + "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)", + "memberOf" : "" + }, + { + "name" : "extraParams", + "type" : "Object", + "desc" : "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "method", + "type" : "String", + "desc" : "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)", + "memberOf" : "" + }, + { + "name" : "timeout", + "type" : "Number", + "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)", + "memberOf" : "" + }, + { + "name" : "url", + "type" : "String", + "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "beforerequest", + "type" : "function", + "desc" : "Fires before a network request is made to retrieve a data object.", + "sig" : "function (conn, options)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "requestcomplete", + "type" : "function", + "desc" : "Fires if the request was successfully completed.", + "sig" : "function (conn, response, options)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "requestexception", + "type" : "function", + "desc" : "Fires if an error HTTP status was returned from the server.\nSee {@link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html} for details of HTTP status codes.", + "sig" : "function (conn, response, options)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "abort", + "type" : "function", + "desc" : "Aborts any outstanding request.", + "sig" : "(transactionId)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "isLoading", + "type" : "function", + "desc" : "Determine whether this object has a request outstanding.", + "sig" : "(transactionId)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "request", + "type" : "function", + "desc" : "Sends an HTTP request to a remote server.", + "sig" : "(options)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.data.DataProxy" : { + "props" : [ + ], + "events" : [ + { + "name" : "beforeload", + "type" : "function", + "desc" : "Fires before a network request is made to retrieve a data object.", + "sig" : "function (This, params)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Fires before the load method's callback is called.", + "sig" : "function (This, o, arg)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "loadexception", + "type" : "function", + "desc" : "Fires if an Exception occurs during data retrieval.", + "sig" : "function (This, o, arg, e)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + ] + }, + "Roo.data.DataReader" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "newRow", + "type" : "function", + "desc" : "Create an empty record", + "sig" : "(data)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.data.HttpProxy" : { + "props" : [ + { + "name" : "autoAbort", + "type" : "Boolean", + "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)", + "memberOf" : "" + }, + { + "name" : "defaultHeaders", + "type" : "Object", + "desc" : "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)", + "memberOf" : "" + }, + { + "name" : "disableCaching", + "type" : "Boolean", + "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)", + "memberOf" : "" + }, + { + "name" : "extraParams", + "type" : "Object", + "desc" : "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)", + "memberOf" : "" + }, + { + "name" : "method", + "type" : "String", + "desc" : "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)", + "memberOf" : "" + }, + { + "name" : "timeout", + "type" : "Number", + "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)", + "memberOf" : "" + }, + { + "name" : "url", + "type" : "String", + "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "beforeload", + "type" : "function", + "desc" : "Fires before a network request is made to retrieve a data object.", + "sig" : "function (This, params)\n{\n\n}", + "memberOf" : "Roo.data.DataProxy" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Fires before the load method's callback is called.", + "sig" : "function (This, o, arg)\n{\n\n}", + "memberOf" : "Roo.data.DataProxy" + }, + { + "name" : "loadexception", + "type" : "function", + "desc" : "Fires if an Exception occurs during data retrieval.", + "sig" : "function (This, o, arg, e)\n{\n\n}", + "memberOf" : "Roo.data.DataProxy" + } + ], + "methods" : [ + { + "name" : "getConnection", + "type" : "function", + "desc" : "Return the {@link Roo.data.Connection} object being used by this Proxy.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Load data from the configured {@link Roo.data.Connection}, read the data object into\na block of Roo.data.Records using the passed {@link Roo.data.DataReader} implementation, and\nprocess that block using the passed callback.", + "sig" : "(params, reader, callback, scope, arg)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.data.JsonReader" : { + "props" : [ + { + "name" : "fields", + "type" : "Array", + "desc" : "Array of field definition objects", + "memberOf" : "" + }, + { + "name" : "id", + "type" : "String", + "desc" : "Name of the property within a row object that contains a record identifier value.", + "memberOf" : "" + }, + { + "name" : "root", + "type" : "String", + "desc" : "name of the property which contains the Array of row objects.", + "memberOf" : "" + }, + { + "name" : "successProperty", + "type" : "String", + "desc" : "Name of the property from which to retrieve the success attribute used by forms.", + "memberOf" : "" + }, + { + "name" : "totalProperty", + "type" : "String", + "desc" : "Name of the property from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.", + "memberOf" : "" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "newRow", + "type" : "function", + "desc" : "Create an empty record", + "sig" : "(data)", + "static" : false, + "memberOf" : "Roo.data.DataReader" + }, + { + "name" : "read", + "type" : "function", + "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.", + "sig" : "(response)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "readRecords", + "type" : "function", + "desc" : "Create a data block containing Roo.data.Records from an XML document.", + "sig" : "(o)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.data.JsonStore" : { + "props" : [ + { + "name" : "baseParams", + "type" : "Object", + "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "data", + "type" : "Array", + "desc" : "Inline data to be loaded when the store is initialized.", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "fields", + "type" : "Array", + "desc" : "An array of field definition objects, or field name strings.", + "memberOf" : "" + }, + { + "name" : "isLocal", + "type" : "boolean", + "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "multiSort", + "type" : "Boolean", + "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "proxy", + "type" : "Roo.data.DataProxy", + "desc" : "The Proxy object which provides access to a data object.", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "pruneModifiedRecords", + "type" : "boolean", + "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "reader", + "type" : "Roo.data.Reader", + "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their id property.", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "remoteSort", + "type" : "boolean", + "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "sortInfo", + "type" : "Object", + "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}", + "memberOf" : "Roo.data.Store" + } + ], + "events" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Fires when Records have been added to the Store", + "sig" : "function (_self, records, index)\n{\n\n}", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "beforeload", + "type" : "function", + "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.", + "sig" : "function (_self, options)\n{\n\n}", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "beforeloadadd", + "type" : "function", + "desc" : "Fires after a new set of Records has been loaded.", + "sig" : "function (_self, records, options)\n{\n\n}", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "clear", + "type" : "function", + "desc" : "Fires when the data cache has been cleared.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "datachanged", + "type" : "function", + "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.", + "sig" : "function (_self, records, options)\n{\n\n}", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "loadexception", + "type" : "function", + "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args", + "sig" : "function (, return, load, jsonData)\n{\n\n}", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "metachange", + "type" : "function", + "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.", + "sig" : "function (_self, meta)\n{\n\n}", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Fires when a Record has been removed from the Store", + "sig" : "function (_self, record, index)\n{\n\n}", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "update", + "type" : "function", + "desc" : "Fires when a Record has been updated", + "sig" : "function (_self, record, operation)\n{\n\n}", + "memberOf" : "Roo.data.Store" + } + ], + "methods" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Add Records to the Store and fires the add event.", + "sig" : "(records)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearFilter", + "type" : "function", + "desc" : "Revert to a view of the Record cache with no filtering applied.", + "sig" : "(suppressEvent)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "collect", + "type" : "function", + "desc" : "Collects unique values for a particular dataIndex from this store.", + "sig" : "(dataIndex, allowNull, bypassFilter)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "commitChanges", + "type" : "function", + "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "each", + "type" : "function", + "desc" : "Calls the specified function for each of the Records in the cache.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "filter", + "type" : "function", + "desc" : "Filter the records by a specified property.", + "sig" : "(field, value, anyMatch)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "filterBy", + "type" : "function", + "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getAt", + "type" : "function", + "desc" : "Get the Record at the specified index.", + "sig" : "(index)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "getById", + "type" : "function", + "desc" : "Get the Record with the specified id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "getCount", + "type" : "function", + "desc" : "Gets the number of cached records.\n

\nIf using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "getModifiedRecords", + "type" : "function", + "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "getRange", + "type" : "function", + "desc" : "Returns a range of Records between specified indices.", + "sig" : "(startIndex, endIndex)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "getSortState", + "type" : "function", + "desc" : "Returns the sort state of the Store as an object with two properties:\n

\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n
", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "getTotalCount", + "type" : "function", + "desc" : "Gets the total number of records in the dataset as returned by the server.\n

\nIf using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "indexOf", + "type" : "function", + "desc" : "Get the index within the cache of the passed Record.", + "sig" : "(record)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "indexOfId", + "type" : "function", + "desc" : "Get the index within the cache of the Record with the passed id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "insert", + "type" : "function", + "desc" : "Inserts Records to the Store at the given index and fires the add event.", + "sig" : "(index, records)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n

\nIf using remote paging, then the first load call must specify the start\nand limit properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n

\nIt is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.\n

", + "sig" : "(options)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "loadData", + "type" : "function", + "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.", + "sig" : "(data, append)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "query", + "type" : "function", + "desc" : "Query the records by a specified property.", + "sig" : "(field, value, anyMatch)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "queryBy", + "type" : "function", + "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "rejectChanges", + "type" : "function", + "desc" : "Cancel outstanding changes on all changed records.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "reload", + "type" : "function", + "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.", + "sig" : "(options)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Remove a Record from the Store and fires the remove event.", + "sig" : "(record)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "removeAll", + "type" : "function", + "desc" : "Remove all Records from the Store and fires the clear event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "setDefaultSort", + "type" : "function", + "desc" : "Sets the default sort column and order to be used by the next load operation.", + "sig" : "(fieldName, dir)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "sort", + "type" : "function", + "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.", + "sig" : "(fieldName, dir)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "sum", + "type" : "function", + "desc" : "Sums the value of property for each record between start and end and returns the result.", + "sig" : "(property, start, end)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.data.MemoryProxy" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "load", + "type" : "function", + "desc" : "Load data from the requested source (in this case an in-memory\ndata object passed to the constructor), read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.", + "sig" : "(params, reader, callback, scope, arg)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.data.Node" : { + "props" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id for this node. If one is not specified, one is generated.", + "memberOf" : "" + }, + { + "name" : "leaf", + "type" : "Boolean", + "desc" : "true if this node is a leaf and does not have children", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n

\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "append", + "type" : "function", + "desc" : "Fires when a new child node is appended", + "sig" : "function (tree, _self, node, index)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeappend", + "type" : "function", + "desc" : "Fires before a new child is appended, return false to cancel the append.", + "sig" : "function (tree, _self, node)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeinsert", + "type" : "function", + "desc" : "Fires before a new child is inserted, return false to cancel the insert.", + "sig" : "function (tree, _self, node, refNode)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforemove", + "type" : "function", + "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.", + "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeremove", + "type" : "function", + "desc" : "Fires before a child is removed, return false to cancel the remove.", + "sig" : "function (tree, _self, node)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "insert", + "type" : "function", + "desc" : "Fires when a new child node is inserted.", + "sig" : "function (tree, _self, node, refNode)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires when this node is moved to a new location in the tree", + "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Fires when a child node is removed", + "sig" : "function (tree, _self, node)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "appendChild", + "type" : "function", + "desc" : "Insert node(s) as the last child node of this node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "bubble", + "type" : "function", + "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.", + "sig" : "(fn, scope, args)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "cascade", + "type" : "function", + "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.", + "sig" : "(fn, scope, args)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "contains", + "type" : "function", + "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "eachChild", + "type" : "function", + "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.", + "sig" : "(fn, scope, args)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "findChild", + "type" : "function", + "desc" : "Finds the first child that has the attribute with the specified value.", + "sig" : "(attribute, value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "findChildBy", + "type" : "function", + "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getDepth", + "type" : "function", + "desc" : "Returns depth of this node (the root node has a depth of 0)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getOwnerTree", + "type" : "function", + "desc" : "Returns the tree this node is in.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getPath", + "type" : "function", + "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.", + "sig" : "(attr)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "indexOf", + "type" : "function", + "desc" : "Returns the index of a child node", + "sig" : "(node)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "insertBefore", + "type" : "function", + "desc" : "Inserts the first node before the second node in this nodes childNodes collection.", + "sig" : "(node, refNode)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isAncestor", + "type" : "function", + "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isFirst", + "type" : "function", + "desc" : "Returns true if this node is the first child of its parent", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isLast", + "type" : "function", + "desc" : "Returns true if this node is the last child of its parent", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isLeaf", + "type" : "function", + "desc" : "Returns true if this node is a leaf", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "item", + "type" : "function", + "desc" : "Returns the child node at the specified index.", + "sig" : "(index)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeChild", + "type" : "function", + "desc" : "Removes a child node from this node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "replaceChild", + "type" : "function", + "desc" : "Replaces one child node in this node with another.", + "sig" : "(newChild, oldChild)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "sort", + "type" : "function", + "desc" : "Sorts this nodes children using the supplied sort function", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.data.Record" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "commit", + "type" : "function", + "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nCommits all changes made to the Record since either creation, or the last commit operation.\n

\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof commit operations.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "copy", + "type" : "function", + "desc" : "Creates a copy of this record.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "create", + "type" : "function", + "desc" : "Generate a constructor for a specific record layout.", + "sig" : "(o)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "get", + "type" : "function", + "desc" : "Get the value of the named field.", + "sig" : "(name)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "reject", + "type" : "function", + "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nRejects all changes made to the Record since either creation, or the last commit operation.\nModified fields are reverted to their original values.\n

\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof reject operations.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "set", + "type" : "function", + "desc" : "Set the named field to the specified value.", + "sig" : "(name, value)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.data.ScriptTagProxy" : { + "props" : [ + { + "name" : "callbackParam", + "type" : "String", + "desc" : "(Optional) The name of the parameter to pass to the server which tells\nthe server the name of the callback function set up by the load call to process the returned data object.\nDefaults to \"callback\".

The server-side processing must read this parameter value, and generate\njavascript output which calls this named function passing the data object as its only parameter.", + "memberOf" : "" + }, + { + "name" : "nocache", + "type" : "Boolean", + "desc" : "(Optional) Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.", + "memberOf" : "" + }, + { + "name" : "timeout", + "type" : "Number", + "desc" : "(Optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.", + "memberOf" : "" + }, + { + "name" : "url", + "type" : "String", + "desc" : "The URL from which to request the data object.", + "memberOf" : "" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "abort", + "type" : "function", + "desc" : "Abort the current server request.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Load data from the configured URL, read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.", + "sig" : "(params, reader, callback, scope, arg)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.data.SimpleStore" : { + "props" : [ + { + "name" : "baseParams", + "type" : "Object", + "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "data", + "type" : "Array", + "desc" : "The multi-dimensional array of data", + "memberOf" : "" + }, + { + "name" : "fields", + "type" : "Array", + "desc" : "An array of field definition objects, or field name strings.", + "memberOf" : "" + }, + { + "name" : "id", + "type" : "Number", + "desc" : "The array index of the record id. Leave blank to auto generate ids.", + "memberOf" : "" + }, + { + "name" : "isLocal", + "type" : "boolean", + "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n

\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "multiSort", + "type" : "Boolean", + "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "proxy", + "type" : "Roo.data.DataProxy", + "desc" : "The Proxy object which provides access to a data object.", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "pruneModifiedRecords", + "type" : "boolean", + "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "reader", + "type" : "Roo.data.Reader", + "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their id property.", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "remoteSort", + "type" : "boolean", + "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "sortInfo", + "type" : "Object", + "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}", + "memberOf" : "Roo.data.Store" + } + ], + "events" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Fires when Records have been added to the Store", + "sig" : "function (_self, records, index)\n{\n\n}", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "beforeload", + "type" : "function", + "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.", + "sig" : "function (_self, options)\n{\n\n}", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "beforeloadadd", + "type" : "function", + "desc" : "Fires after a new set of Records has been loaded.", + "sig" : "function (_self, records, options)\n{\n\n}", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "clear", + "type" : "function", + "desc" : "Fires when the data cache has been cleared.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "datachanged", + "type" : "function", + "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.", + "sig" : "function (_self, records, options)\n{\n\n}", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "loadexception", + "type" : "function", + "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args", + "sig" : "function (, return, load, jsonData)\n{\n\n}", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "metachange", + "type" : "function", + "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.", + "sig" : "function (_self, meta)\n{\n\n}", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Fires when a Record has been removed from the Store", + "sig" : "function (_self, record, index)\n{\n\n}", + "memberOf" : "Roo.data.Store" + }, + { + "name" : "update", + "type" : "function", + "desc" : "Fires when a Record has been updated", + "sig" : "function (_self, record, operation)\n{\n\n}", + "memberOf" : "Roo.data.Store" + } + ], + "methods" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Add Records to the Store and fires the add event.", + "sig" : "(records)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearFilter", + "type" : "function", + "desc" : "Revert to a view of the Record cache with no filtering applied.", + "sig" : "(suppressEvent)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "collect", + "type" : "function", + "desc" : "Collects unique values for a particular dataIndex from this store.", + "sig" : "(dataIndex, allowNull, bypassFilter)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "commitChanges", + "type" : "function", + "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "each", + "type" : "function", + "desc" : "Calls the specified function for each of the Records in the cache.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "filter", + "type" : "function", + "desc" : "Filter the records by a specified property.", + "sig" : "(field, value, anyMatch)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "filterBy", + "type" : "function", + "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getAt", + "type" : "function", + "desc" : "Get the Record at the specified index.", + "sig" : "(index)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "getById", + "type" : "function", + "desc" : "Get the Record with the specified id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "getCount", + "type" : "function", + "desc" : "Gets the number of cached records.\n

\nIf using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "getModifiedRecords", + "type" : "function", + "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "getRange", + "type" : "function", + "desc" : "Returns a range of Records between specified indices.", + "sig" : "(startIndex, endIndex)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "getSortState", + "type" : "function", + "desc" : "Returns the sort state of the Store as an object with two properties:\n

\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n
", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "getTotalCount", + "type" : "function", + "desc" : "Gets the total number of records in the dataset as returned by the server.\n

\nIf using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "indexOf", + "type" : "function", + "desc" : "Get the index within the cache of the passed Record.", + "sig" : "(record)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "indexOfId", + "type" : "function", + "desc" : "Get the index within the cache of the Record with the passed id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "insert", + "type" : "function", + "desc" : "Inserts Records to the Store at the given index and fires the add event.", + "sig" : "(index, records)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n

\nIf using remote paging, then the first load call must specify the start\nand limit properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n

\nIt is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.\n

", + "sig" : "(options)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "loadData", + "type" : "function", + "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.", + "sig" : "(data, append)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "query", + "type" : "function", + "desc" : "Query the records by a specified property.", + "sig" : "(field, value, anyMatch)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "queryBy", + "type" : "function", + "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "rejectChanges", + "type" : "function", + "desc" : "Cancel outstanding changes on all changed records.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "reload", + "type" : "function", + "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.", + "sig" : "(options)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Remove a Record from the Store and fires the remove event.", + "sig" : "(record)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "removeAll", + "type" : "function", + "desc" : "Remove all Records from the Store and fires the clear event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "setDefaultSort", + "type" : "function", + "desc" : "Sets the default sort column and order to be used by the next load operation.", + "sig" : "(fieldName, dir)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "sort", + "type" : "function", + "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.", + "sig" : "(fieldName, dir)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "sum", + "type" : "function", + "desc" : "Sums the value of property for each record between start and end and returns the result.", + "sig" : "(property, start, end)", + "static" : false, + "memberOf" : "Roo.data.Store" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.data.SortTypes" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "asDate", + "type" : "function", + "desc" : "Date sorting", + "sig" : "(s)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "asFloat", + "type" : "function", + "desc" : "Float sorting", + "sig" : "(s)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "asInt", + "type" : "function", + "desc" : "Integer sorting", + "sig" : "(s)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "asText", + "type" : "function", + "desc" : "Strips all HTML tags to sort on text only", + "sig" : "(s)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "asUCString", + "type" : "function", + "desc" : "Case insensitive string", + "sig" : "(s)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "asUCText", + "type" : "function", + "desc" : "Strips all HTML tags to sort on text only - Case insensitive", + "sig" : "(s)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "none", + "type" : "function", + "desc" : "Default sort that does nothing", + "sig" : "(s)", + "static" : true, + "memberOf" : "" + } + ] + }, + "Roo.data.Store" : { + "props" : [ + { + "name" : "baseParams", + "type" : "Object", + "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request", + "memberOf" : "" + }, + { + "name" : "data", + "type" : "Array", + "desc" : "Inline data to be loaded when the store is initialized.", + "memberOf" : "" + }, + { + "name" : "isLocal", + "type" : "boolean", + "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n

\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "multiSort", + "type" : "Boolean", + "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)", + "memberOf" : "" + }, + { + "name" : "proxy", + "type" : "Roo.data.DataProxy", + "desc" : "The Proxy object which provides access to a data object.", + "memberOf" : "" + }, + { + "name" : "pruneModifiedRecords", + "type" : "boolean", + "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).", + "memberOf" : "" + }, + { + "name" : "reader", + "type" : "Roo.data.Reader", + "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their id property.", + "memberOf" : "" + }, + { + "name" : "remoteSort", + "type" : "boolean", + "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).", + "memberOf" : "" + }, + { + "name" : "sortInfo", + "type" : "Object", + "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Fires when Records have been added to the Store", + "sig" : "function (_self, records, index)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeload", + "type" : "function", + "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.", + "sig" : "function (_self, options)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeloadadd", + "type" : "function", + "desc" : "Fires after a new set of Records has been loaded.", + "sig" : "function (_self, records, options)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "clear", + "type" : "function", + "desc" : "Fires when the data cache has been cleared.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "datachanged", + "type" : "function", + "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.", + "sig" : "function (_self, records, options)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "loadexception", + "type" : "function", + "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args", + "sig" : "function (, return, load, jsonData)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "metachange", + "type" : "function", + "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.", + "sig" : "function (_self, meta)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Fires when a Record has been removed from the Store", + "sig" : "function (_self, record, index)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "update", + "type" : "function", + "desc" : "Fires when a Record has been updated", + "sig" : "function (_self, record, operation)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Add Records to the Store and fires the add event.", + "sig" : "(records)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearFilter", + "type" : "function", + "desc" : "Revert to a view of the Record cache with no filtering applied.", + "sig" : "(suppressEvent)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "collect", + "type" : "function", + "desc" : "Collects unique values for a particular dataIndex from this store.", + "sig" : "(dataIndex, allowNull, bypassFilter)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "commitChanges", + "type" : "function", + "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "each", + "type" : "function", + "desc" : "Calls the specified function for each of the Records in the cache.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "filter", + "type" : "function", + "desc" : "Filter the records by a specified property.", + "sig" : "(field, value, anyMatch)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "filterBy", + "type" : "function", + "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getAt", + "type" : "function", + "desc" : "Get the Record at the specified index.", + "sig" : "(index)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getById", + "type" : "function", + "desc" : "Get the Record with the specified id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getCount", + "type" : "function", + "desc" : "Gets the number of cached records.\n

\nIf using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getModifiedRecords", + "type" : "function", + "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getRange", + "type" : "function", + "desc" : "Returns a range of Records between specified indices.", + "sig" : "(startIndex, endIndex)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getSortState", + "type" : "function", + "desc" : "Returns the sort state of the Store as an object with two properties:\n

\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n
", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getTotalCount", + "type" : "function", + "desc" : "Gets the total number of records in the dataset as returned by the server.\n

\nIf using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "indexOf", + "type" : "function", + "desc" : "Get the index within the cache of the passed Record.", + "sig" : "(record)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "indexOfId", + "type" : "function", + "desc" : "Get the index within the cache of the Record with the passed id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "insert", + "type" : "function", + "desc" : "Inserts Records to the Store at the given index and fires the add event.", + "sig" : "(index, records)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n

\nIf using remote paging, then the first load call must specify the start\nand limit properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n

\nIt is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.\n

", + "sig" : "(options)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "loadData", + "type" : "function", + "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.", + "sig" : "(data, append)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "query", + "type" : "function", + "desc" : "Query the records by a specified property.", + "sig" : "(field, value, anyMatch)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "queryBy", + "type" : "function", + "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "rejectChanges", + "type" : "function", + "desc" : "Cancel outstanding changes on all changed records.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "reload", + "type" : "function", + "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.", + "sig" : "(options)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Remove a Record from the Store and fires the remove event.", + "sig" : "(record)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeAll", + "type" : "function", + "desc" : "Remove all Records from the Store and fires the clear event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "setDefaultSort", + "type" : "function", + "desc" : "Sets the default sort column and order to be used by the next load operation.", + "sig" : "(fieldName, dir)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "sort", + "type" : "function", + "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.", + "sig" : "(fieldName, dir)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "sum", + "type" : "function", + "desc" : "Sums the value of property for each record between start and end and returns the result.", + "sig" : "(property, start, end)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.data.Tree" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n

\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "append", + "type" : "function", + "desc" : "Fires when a new child node is appended to a node in this tree.", + "sig" : "function (tree, parent, node, index)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeappend", + "type" : "function", + "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.", + "sig" : "function (tree, parent, node)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeinsert", + "type" : "function", + "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.", + "sig" : "function (tree, parent, node, refNode)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforemove", + "type" : "function", + "desc" : "Fires before a node is moved to a new location in the tree. Return false to cancel the move.", + "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeremove", + "type" : "function", + "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.", + "sig" : "function (tree, parent, node)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "insert", + "type" : "function", + "desc" : "Fires when a new child node is inserted in a node in this tree.", + "sig" : "function (tree, parent, node, refNode)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires when a node is moved to a new location in the tree", + "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Fires when a child node is removed from a node in this tree.", + "sig" : "function (tree, parent, node)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getNodeById", + "type" : "function", + "desc" : "Gets a node in this tree by its id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getRootNode", + "type" : "function", + "desc" : "Returns the root node for this tree.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "setRootNode", + "type" : "function", + "desc" : "Sets the root node for this tree.", + "sig" : "(node)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.data.XmlReader" : { + "props" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The DomQuery path relative from the record element to the element that contains\na record identifier value.", + "memberOf" : "" + }, + { + "name" : "record", + "type" : "String", + "desc" : "The DomQuery path to the repeated element which contains record information.", + "memberOf" : "" + }, + { + "name" : "success", + "type" : "String", + "desc" : "The DomQuery path to the success attribute used by forms.", + "memberOf" : "" + }, + { + "name" : "totalRecords", + "type" : "String", + "desc" : "The DomQuery path from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.", + "memberOf" : "" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "newRow", + "type" : "function", + "desc" : "Create an empty record", + "sig" : "(data)", + "static" : false, + "memberOf" : "Roo.data.DataReader" + }, + { + "name" : "read", + "type" : "function", + "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.", + "sig" : "(response)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "readRecords", + "type" : "function", + "desc" : "Create a data block containing Roo.data.Records from an XML document.", + "sig" : "(doc)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.dd" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.dd.DD" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addInvalidHandleClass", + "type" : "function", + "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addInvalidHandleId", + "type" : "function", + "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addInvalidHandleType", + "type" : "function", + "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addToGroup", + "type" : "function", + "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "alignElWithMouse", + "type" : "function", + "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "sig" : "(el, iPageX, iPageY)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "applyConfig", + "type" : "function", + "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "autoOffset", + "type" : "function", + "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "cachePosition", + "type" : "function", + "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearConstraints", + "type" : "function", + "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "clearTicks", + "type" : "function", + "desc" : "Clears any tick interval defined for this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "endDrag", + "type" : "function", + "desc" : "Fired when we are done dragging the object", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getDragEl", + "type" : "function", + "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns a reference to the linked element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "init", + "type" : "function", + "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "initTarget", + "type" : "function", + "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isLocked", + "type" : "function", + "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isTarget", + "type" : "function", + "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isValidHandleChild", + "type" : "function", + "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "lock", + "type" : "function", + "desc" : "Lock this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onAvailable", + "type" : "function", + "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDrag", + "type" : "function", + "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragDrop", + "type" : "function", + "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragEnter", + "type" : "function", + "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragOut", + "type" : "function", + "desc" : "Abstract method called when we are no longer hovering over an element", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragOver", + "type" : "function", + "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onInvalidDrop", + "type" : "function", + "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onMouseDown", + "type" : "function", + "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onMouseUp", + "type" : "function", + "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "padding", + "type" : "function", + "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeFromGroup", + "type" : "function", + "desc" : "Remove's this instance from the supplied interaction group", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleClass", + "type" : "function", + "desc" : "Unsets an invalid css class", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleId", + "type" : "function", + "desc" : "Unsets an invalid handle id", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleType", + "type" : "function", + "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "resetConstraints", + "type" : "function", + "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "sig" : "(maintainOffset)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setDelta", + "type" : "function", + "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)", + "sig" : "(iDeltaX, iDeltaY)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setDragElId", + "type" : "function", + "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setDragElPos", + "type" : "function", + "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setHandleElId", + "type" : "function", + "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setInitPosition", + "type" : "function", + "desc" : "Stores the initial placement of the linked element.", + "sig" : "(diffX, diffY)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setOuterHandleElId", + "type" : "function", + "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setPadding", + "type" : "function", + "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "sig" : "(iTop, iRight, iBot, iLeft)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setXConstraint", + "type" : "function", + "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "sig" : "(iLeft, iRight, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setYConstraint", + "type" : "function", + "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "sig" : "(iUp, iDown, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "startDrag", + "type" : "function", + "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "sig" : "(X, Y)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "toString", + "type" : "function", + "desc" : "toString method", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unlock", + "type" : "function", + "desc" : "Unlock this instace", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "unreg", + "type" : "function", + "desc" : "Remove all drag and drop hooks for this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + } + ] + }, + "Roo.dd.DDProxy" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addInvalidHandleClass", + "type" : "function", + "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addInvalidHandleId", + "type" : "function", + "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addInvalidHandleType", + "type" : "function", + "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addToGroup", + "type" : "function", + "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "alignElWithMouse", + "type" : "function", + "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "sig" : "(el, iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD" + }, + { + "name" : "applyConfig", + "type" : "function", + "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "autoOffset", + "type" : "function", + "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD" + }, + { + "name" : "cachePosition", + "type" : "function", + "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearConstraints", + "type" : "function", + "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "clearTicks", + "type" : "function", + "desc" : "Clears any tick interval defined for this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "createFrame", + "type" : "function", + "desc" : "Creates the proxy element if it does not yet exist", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "endDrag", + "type" : "function", + "desc" : "Fired when we are done dragging the object", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getDragEl", + "type" : "function", + "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns a reference to the linked element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "init", + "type" : "function", + "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "initFrame", + "type" : "function", + "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "initTarget", + "type" : "function", + "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isLocked", + "type" : "function", + "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isTarget", + "type" : "function", + "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isValidHandleChild", + "type" : "function", + "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "lock", + "type" : "function", + "desc" : "Lock this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onAvailable", + "type" : "function", + "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDrag", + "type" : "function", + "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragDrop", + "type" : "function", + "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragEnter", + "type" : "function", + "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragOut", + "type" : "function", + "desc" : "Abstract method called when we are no longer hovering over an element", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragOver", + "type" : "function", + "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onInvalidDrop", + "type" : "function", + "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onMouseDown", + "type" : "function", + "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onMouseUp", + "type" : "function", + "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "padding", + "type" : "function", + "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeFromGroup", + "type" : "function", + "desc" : "Remove's this instance from the supplied interaction group", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleClass", + "type" : "function", + "desc" : "Unsets an invalid css class", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleId", + "type" : "function", + "desc" : "Unsets an invalid handle id", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleType", + "type" : "function", + "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "resetConstraints", + "type" : "function", + "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "sig" : "(maintainOffset)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setDelta", + "type" : "function", + "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)", + "sig" : "(iDeltaX, iDeltaY)", + "static" : false, + "memberOf" : "Roo.dd.DD" + }, + { + "name" : "setDragElId", + "type" : "function", + "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setDragElPos", + "type" : "function", + "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD" + }, + { + "name" : "setHandleElId", + "type" : "function", + "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setInitPosition", + "type" : "function", + "desc" : "Stores the initial placement of the linked element.", + "sig" : "(diffX, diffY)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setOuterHandleElId", + "type" : "function", + "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setPadding", + "type" : "function", + "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "sig" : "(iTop, iRight, iBot, iLeft)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setXConstraint", + "type" : "function", + "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "sig" : "(iLeft, iRight, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setYConstraint", + "type" : "function", + "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "sig" : "(iUp, iDown, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "startDrag", + "type" : "function", + "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "sig" : "(X, Y)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "toString", + "type" : "function", + "desc" : "toString method", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unlock", + "type" : "function", + "desc" : "Unlock this instace", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "unreg", + "type" : "function", + "desc" : "Remove all drag and drop hooks for this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + } + ] + }, + "Roo.dd.DDTarget" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addInvalidHandleClass", + "type" : "function", + "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addInvalidHandleId", + "type" : "function", + "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addInvalidHandleType", + "type" : "function", + "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addToGroup", + "type" : "function", + "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "applyConfig", + "type" : "function", + "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearConstraints", + "type" : "function", + "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "clearTicks", + "type" : "function", + "desc" : "Clears any tick interval defined for this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "endDrag", + "type" : "function", + "desc" : "Fired when we are done dragging the object", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getDragEl", + "type" : "function", + "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns a reference to the linked element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "init", + "type" : "function", + "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "initTarget", + "type" : "function", + "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isLocked", + "type" : "function", + "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isTarget", + "type" : "function", + "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isValidHandleChild", + "type" : "function", + "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "lock", + "type" : "function", + "desc" : "Lock this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onAvailable", + "type" : "function", + "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDrag", + "type" : "function", + "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragDrop", + "type" : "function", + "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragEnter", + "type" : "function", + "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragOut", + "type" : "function", + "desc" : "Abstract method called when we are no longer hovering over an element", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragOver", + "type" : "function", + "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onInvalidDrop", + "type" : "function", + "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onMouseDown", + "type" : "function", + "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onMouseUp", + "type" : "function", + "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "padding", + "type" : "function", + "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeFromGroup", + "type" : "function", + "desc" : "Remove's this instance from the supplied interaction group", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleClass", + "type" : "function", + "desc" : "Unsets an invalid css class", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleId", + "type" : "function", + "desc" : "Unsets an invalid handle id", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleType", + "type" : "function", + "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "resetConstraints", + "type" : "function", + "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "sig" : "(maintainOffset)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setDragElId", + "type" : "function", + "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setHandleElId", + "type" : "function", + "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setInitPosition", + "type" : "function", + "desc" : "Stores the initial placement of the linked element.", + "sig" : "(diffX, diffY)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setOuterHandleElId", + "type" : "function", + "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setPadding", + "type" : "function", + "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "sig" : "(iTop, iRight, iBot, iLeft)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setXConstraint", + "type" : "function", + "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "sig" : "(iLeft, iRight, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setYConstraint", + "type" : "function", + "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "sig" : "(iUp, iDown, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "startDrag", + "type" : "function", + "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "sig" : "(X, Y)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "toString", + "type" : "function", + "desc" : "toString method", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unlock", + "type" : "function", + "desc" : "Unlock this instace", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "unreg", + "type" : "function", + "desc" : "Remove all drag and drop hooks for this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + } + ] + }, + "Roo.dd.DragDrop" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addInvalidHandleClass", + "type" : "function", + "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addInvalidHandleId", + "type" : "function", + "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addInvalidHandleType", + "type" : "function", + "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addToGroup", + "type" : "function", + "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "applyConfig", + "type" : "function", + "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearConstraints", + "type" : "function", + "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "clearTicks", + "type" : "function", + "desc" : "Clears any tick interval defined for this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "endDrag", + "type" : "function", + "desc" : "Fired when we are done dragging the object", + "sig" : "(e)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getDragEl", + "type" : "function", + "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns a reference to the linked element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "init", + "type" : "function", + "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "initTarget", + "type" : "function", + "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isLocked", + "type" : "function", + "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isTarget", + "type" : "function", + "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isValidHandleChild", + "type" : "function", + "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "sig" : "(node)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "lock", + "type" : "function", + "desc" : "Lock this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onAvailable", + "type" : "function", + "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "onDrag", + "type" : "function", + "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "sig" : "(e)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "onDragDrop", + "type" : "function", + "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "onDragEnter", + "type" : "function", + "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "onDragOut", + "type" : "function", + "desc" : "Abstract method called when we are no longer hovering over an element", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "onDragOver", + "type" : "function", + "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "onInvalidDrop", + "type" : "function", + "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "sig" : "(e)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "onMouseDown", + "type" : "function", + "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "sig" : "(e)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "onMouseUp", + "type" : "function", + "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "sig" : "(e)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "padding", + "type" : "function", + "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeFromGroup", + "type" : "function", + "desc" : "Remove's this instance from the supplied interaction group", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeInvalidHandleClass", + "type" : "function", + "desc" : "Unsets an invalid css class", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeInvalidHandleId", + "type" : "function", + "desc" : "Unsets an invalid handle id", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeInvalidHandleType", + "type" : "function", + "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "resetConstraints", + "type" : "function", + "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "sig" : "(maintainOffset)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setDragElId", + "type" : "function", + "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setHandleElId", + "type" : "function", + "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setInitPosition", + "type" : "function", + "desc" : "Stores the initial placement of the linked element.", + "sig" : "(diffX, diffY)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setOuterHandleElId", + "type" : "function", + "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setPadding", + "type" : "function", + "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "sig" : "(iTop, iRight, iBot, iLeft)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setXConstraint", + "type" : "function", + "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "sig" : "(iLeft, iRight, iTickSize)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setYConstraint", + "type" : "function", + "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "sig" : "(iUp, iDown, iTickSize)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "startDrag", + "type" : "function", + "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "sig" : "(X, Y)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "toString", + "type" : "function", + "desc" : "toString method", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unlock", + "type" : "function", + "desc" : "Unlock this instace", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "unreg", + "type" : "function", + "desc" : "Remove all drag and drop hooks for this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.dd.DragDropMgr" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "getBestMatch", + "type" : "function", + "desc" : "Helper function for getting the best match from the list of drag\nand drop objects returned by the drag and drop events when we are\nin INTERSECT mode. It returns either the first object that the\ncursor is over, or the object that has the greatest overlap with\nthe dragged element.", + "sig" : "(dds)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getCss", + "type" : "function", + "desc" : "Returns the style property for the DOM element (i.e.,\ndocument.getElById(id).style)", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getDDById", + "type" : "function", + "desc" : "Returns the DragDrop instance for a given id", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getElement", + "type" : "function", + "desc" : "Returns the actual DOM element", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getLocation", + "type" : "function", + "desc" : "Returns a Region object containing the drag and drop element's position\nand size, including the padding configured for it", + "sig" : "(oDD)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getPosX", + "type" : "function", + "desc" : "Returns the X position of an html element", + "sig" : "(el)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getPosY", + "type" : "function", + "desc" : "Returns the Y position of an html element", + "sig" : "(el)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getRelated", + "type" : "function", + "desc" : "Returns the drag and drop instances that are in all groups the\npassed in instance belongs to.", + "sig" : "(p_oDD, bTargetsOnly)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getScrollLeft", + "type" : "function", + "desc" : "Gets the scrollLeft", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getScrollTop", + "type" : "function", + "desc" : "Gets the scrollTop", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getStyle", + "type" : "function", + "desc" : "Returns the specified element style property", + "sig" : "(el, styleProp)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "handleWasClicked", + "type" : "function", + "desc" : "Recursively searches the immediate parent and all child nodes for\nthe handle element in order to determine wheter or not it was\nclicked.", + "sig" : "(node)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isDragDrop", + "type" : "function", + "desc" : "Utility function to determine if a given element has been\nregistered as a drag drop item.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isHandle", + "type" : "function", + "desc" : "Utility function to determine if a given element has been\nregistered as a drag drop handle for the given Drag Drop object.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isLegalTarget", + "type" : "function", + "desc" : "Returns true if the specified dd target is a legal target for\nthe specifice drag obj", + "sig" : "(the, the)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isLocked", + "type" : "function", + "desc" : "Is drag and drop locked?", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isTypeOfDD", + "type" : "function", + "desc" : "My goal is to be able to transparently determine if an object is\ntypeof DragDrop, and the exact subclass of DragDrop. typeof\nreturns \"object\", oDD.constructor.toString() always returns\n\"DragDrop\" and not the name of the subclass. So for now it just\nevaluates a well-known variable in DragDrop.", + "sig" : "(the)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "lock", + "type" : "function", + "desc" : "Lock all drag and drop functionality", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "moveToEl", + "type" : "function", + "desc" : "Sets the x/y position of an element to the location of the\ntarget element.", + "sig" : "(moveEl, targetEl)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "numericSort", + "type" : "function", + "desc" : "Numeric array sort function", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "refreshCache", + "type" : "function", + "desc" : "Refreshes the cache of the top-left and bottom-right points of the\ndrag and drop objects in the specified group(s). This is in the\nformat that is stored in the drag and drop instance, so typical\nusage is:\n\nRoo.dd.DragDropMgr.refreshCache(ddinstance.groups);\n\nAlternatively:\n\nRoo.dd.DragDropMgr.refreshCache({group1:true, group2:true});\n", + "sig" : "(groups)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "regDragDrop", + "type" : "function", + "desc" : "Each DragDrop instance must be registered with the DragDropMgr.\nThis is executed in DragDrop.init()", + "sig" : "(oDD, sGroup)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "regHandle", + "type" : "function", + "desc" : "Each DragDrop handle element must be registered. This is done\nautomatically when executing DragDrop.setHandleElId()", + "sig" : "(sDDId, sHandleId)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "startDrag", + "type" : "function", + "desc" : "Fired when either the drag pixel threshol or the mousedown hold\ntime threshold has been met.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "stopEvent", + "type" : "function", + "desc" : "Utility to stop event propagation and event default, if these\nfeatures are turned on.", + "sig" : "(e)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "swapNode", + "type" : "function", + "desc" : "Swap two nodes. In IE, we use the native method, for others we\nemulate the IE behavior", + "sig" : "(n1, n2)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "unlock", + "type" : "function", + "desc" : "Unlock all drag and drop functionality", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "verifyEl", + "type" : "function", + "desc" : "This checks to make sure an element exists and is in the DOM. The\nmain purpose is to handle cases where innerHTML is used to remove\ndrag and drop objects from the DOM. IE provides an 'unspecified\nerror' when trying to access the offsetParent of such an element", + "sig" : "(el)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.dd.DragSource" : { + "props" : [ + { + "name" : "dropAllowed", + "type" : "String", + "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").", + "memberOf" : "" + }, + { + "name" : "dropNotAllowed", + "type" : "String", + "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addInvalidHandleClass", + "type" : "function", + "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addInvalidHandleId", + "type" : "function", + "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addInvalidHandleType", + "type" : "function", + "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addToGroup", + "type" : "function", + "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "alignElWithMouse", + "type" : "function", + "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "sig" : "(el, iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD" + }, + { + "name" : "applyConfig", + "type" : "function", + "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "autoOffset", + "type" : "function", + "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD" + }, + { + "name" : "beforeDragDrop", + "type" : "function", + "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "beforeDragEnter", + "type" : "function", + "desc" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "beforeDragOut", + "type" : "function", + "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "beforeDragOver", + "type" : "function", + "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "beforeInvalidDrop", + "type" : "function", + "desc" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "cachePosition", + "type" : "function", + "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearConstraints", + "type" : "function", + "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "clearTicks", + "type" : "function", + "desc" : "Clears any tick interval defined for this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "createFrame", + "type" : "function", + "desc" : "Creates the proxy element if it does not yet exist", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DDProxy" + }, + { + "name" : "endDrag", + "type" : "function", + "desc" : "Fired when we are done dragging the object", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getDragData", + "type" : "function", + "desc" : "Returns the data object associated with this drag source", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getDragEl", + "type" : "function", + "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns a reference to the linked element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "getProxy", + "type" : "function", + "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hideProxy", + "type" : "function", + "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "init", + "type" : "function", + "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "initFrame", + "type" : "function", + "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DDProxy" + }, + { + "name" : "initTarget", + "type" : "function", + "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isLocked", + "type" : "function", + "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isTarget", + "type" : "function", + "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isValidHandleChild", + "type" : "function", + "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "lock", + "type" : "function", + "desc" : "Lock this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onAvailable", + "type" : "function", + "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onBeforeDrag", + "type" : "function", + "desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.", + "sig" : "(data, e)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "onDrag", + "type" : "function", + "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragDrop", + "type" : "function", + "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragEnter", + "type" : "function", + "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragOut", + "type" : "function", + "desc" : "Abstract method called when we are no longer hovering over an element", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragOver", + "type" : "function", + "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onInvalidDrop", + "type" : "function", + "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onMouseDown", + "type" : "function", + "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onMouseUp", + "type" : "function", + "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onStartDrag", + "type" : "function", + "desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun. The drag cannot be canceled from this function.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "padding", + "type" : "function", + "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeFromGroup", + "type" : "function", + "desc" : "Remove's this instance from the supplied interaction group", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleClass", + "type" : "function", + "desc" : "Unsets an invalid css class", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleId", + "type" : "function", + "desc" : "Unsets an invalid handle id", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleType", + "type" : "function", + "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "resetConstraints", + "type" : "function", + "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "sig" : "(maintainOffset)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setDelta", + "type" : "function", + "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)", + "sig" : "(iDeltaX, iDeltaY)", + "static" : false, + "memberOf" : "Roo.dd.DD" + }, + { + "name" : "setDragElId", + "type" : "function", + "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setDragElPos", + "type" : "function", + "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD" + }, + { + "name" : "setHandleElId", + "type" : "function", + "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setInitPosition", + "type" : "function", + "desc" : "Stores the initial placement of the linked element.", + "sig" : "(diffX, diffY)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setOuterHandleElId", + "type" : "function", + "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setPadding", + "type" : "function", + "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "sig" : "(iTop, iRight, iBot, iLeft)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setXConstraint", + "type" : "function", + "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "sig" : "(iLeft, iRight, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setYConstraint", + "type" : "function", + "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "sig" : "(iUp, iDown, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "startDrag", + "type" : "function", + "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "sig" : "(X, Y)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "toString", + "type" : "function", + "desc" : "toString method", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unlock", + "type" : "function", + "desc" : "Unlock this instace", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "unreg", + "type" : "function", + "desc" : "Remove all drag and drop hooks for this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + } + ] + }, + "Roo.dd.DragZone" : { + "props" : [ + { + "name" : "containerScroll", + "type" : "Boolean", + "desc" : "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.", + "memberOf" : "" + }, + { + "name" : "dropAllowed", + "type" : "String", + "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").", + "memberOf" : "Roo.dd.DragSource" + }, + { + "name" : "dropNotAllowed", + "type" : "String", + "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").", + "memberOf" : "Roo.dd.DragSource" + }, + { + "name" : "hlColor", + "type" : "String", + "desc" : "The color to use when visually highlighting the drag source in the afterRepair\nmethod after a failed drop (defaults to \"c3daf9\" - light blue)", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addInvalidHandleClass", + "type" : "function", + "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addInvalidHandleId", + "type" : "function", + "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addInvalidHandleType", + "type" : "function", + "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addToGroup", + "type" : "function", + "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "afterRepair", + "type" : "function", + "desc" : "Called after a repair of an invalid drop. By default, highlights this.dragData.ddel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "alignElWithMouse", + "type" : "function", + "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "sig" : "(el, iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD" + }, + { + "name" : "applyConfig", + "type" : "function", + "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "autoOffset", + "type" : "function", + "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD" + }, + { + "name" : "beforeDragDrop", + "type" : "function", + "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragSource" + }, + { + "name" : "beforeDragEnter", + "type" : "function", + "desc" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragSource" + }, + { + "name" : "beforeDragOut", + "type" : "function", + "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragSource" + }, + { + "name" : "beforeDragOver", + "type" : "function", + "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragSource" + }, + { + "name" : "beforeInvalidDrop", + "type" : "function", + "desc" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragSource" + }, + { + "name" : "cachePosition", + "type" : "function", + "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearConstraints", + "type" : "function", + "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "clearTicks", + "type" : "function", + "desc" : "Clears any tick interval defined for this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "createFrame", + "type" : "function", + "desc" : "Creates the proxy element if it does not yet exist", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DDProxy" + }, + { + "name" : "endDrag", + "type" : "function", + "desc" : "Fired when we are done dragging the object", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getDragData", + "type" : "function", + "desc" : "Called when a mousedown occurs in this container. Looks in {@link Roo.dd.Registry}\nfor a valid target to drag based on the mouse down. Override this method\nto provide your own lookup logic (e.g. finding a child by class name). Make sure your returned\nobject has a \"ddel\" attribute (with an HTML Element) for other functions to work.", + "sig" : "(e)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getDragEl", + "type" : "function", + "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns a reference to the linked element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "getProxy", + "type" : "function", + "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragSource" + }, + { + "name" : "getRepairXY", + "type" : "function", + "desc" : "Called before a repair of an invalid drop to get the XY to animate to. By default returns\nthe XY of this.dragData.ddel", + "sig" : "(e)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hideProxy", + "type" : "function", + "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragSource" + }, + { + "name" : "init", + "type" : "function", + "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "initFrame", + "type" : "function", + "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DDProxy" + }, + { + "name" : "initTarget", + "type" : "function", + "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isLocked", + "type" : "function", + "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isTarget", + "type" : "function", + "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isValidHandleChild", + "type" : "function", + "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "lock", + "type" : "function", + "desc" : "Lock this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onAvailable", + "type" : "function", + "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onBeforeDrag", + "type" : "function", + "desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.", + "sig" : "(data, e)", + "static" : false, + "memberOf" : "Roo.dd.DragSource" + }, + { + "name" : "onDrag", + "type" : "function", + "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragDrop", + "type" : "function", + "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragEnter", + "type" : "function", + "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragOut", + "type" : "function", + "desc" : "Abstract method called when we are no longer hovering over an element", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragOver", + "type" : "function", + "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onInitDrag", + "type" : "function", + "desc" : "Called once drag threshold has been reached to initialize the proxy element. By default, it clones the\nthis.dragData.ddel", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "onInvalidDrop", + "type" : "function", + "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onMouseDown", + "type" : "function", + "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onMouseUp", + "type" : "function", + "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onStartDrag", + "type" : "function", + "desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun. The drag cannot be canceled from this function.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.dd.DragSource" + }, + { + "name" : "padding", + "type" : "function", + "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeFromGroup", + "type" : "function", + "desc" : "Remove's this instance from the supplied interaction group", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleClass", + "type" : "function", + "desc" : "Unsets an invalid css class", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleId", + "type" : "function", + "desc" : "Unsets an invalid handle id", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleType", + "type" : "function", + "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "resetConstraints", + "type" : "function", + "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "sig" : "(maintainOffset)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setDelta", + "type" : "function", + "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)", + "sig" : "(iDeltaX, iDeltaY)", + "static" : false, + "memberOf" : "Roo.dd.DD" + }, + { + "name" : "setDragElId", + "type" : "function", + "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setDragElPos", + "type" : "function", + "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD" + }, + { + "name" : "setHandleElId", + "type" : "function", + "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setInitPosition", + "type" : "function", + "desc" : "Stores the initial placement of the linked element.", + "sig" : "(diffX, diffY)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setOuterHandleElId", + "type" : "function", + "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setPadding", + "type" : "function", + "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "sig" : "(iTop, iRight, iBot, iLeft)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setXConstraint", + "type" : "function", + "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "sig" : "(iLeft, iRight, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setYConstraint", + "type" : "function", + "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "sig" : "(iUp, iDown, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "startDrag", + "type" : "function", + "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "sig" : "(X, Y)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "toString", + "type" : "function", + "desc" : "toString method", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unlock", + "type" : "function", + "desc" : "Unlock this instace", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "unreg", + "type" : "function", + "desc" : "Remove all drag and drop hooks for this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + } + ] + }, + "Roo.dd.DropTarget" : { + "props" : [ + { + "name" : "ddGroup", + "type" : "String", + "desc" : "The drag drop group to handle drop events for", + "memberOf" : "" + }, + { + "name" : "dropAllowed", + "type" : "String", + "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").", + "memberOf" : "" + }, + { + "name" : "dropNotAllowed", + "type" : "String", + "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "overClass", + "type" : "String", + "desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").", + "memberOf" : "" + }, + { + "name" : "success", + "type" : "boolean", + "desc" : "set this after drop listener..", + "memberOf" : "" + }, + { + "name" : "valid", + "type" : "boolean|String", + "desc" : "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "drop", + "type" : "function", + "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has\nbeen dropped on it. This method has no default implementation and returns false, so you must provide an\nimplementation that does something to process the drop event and returns true so that the drag source's\nrepair action does not run.\n\nIMPORTANT : it should set this.success", + "sig" : "function (source, e, data)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "enter", + "type" : "function", + "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.overClass and this.dropAllowed", + "sig" : "function (source, e, data)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "out", + "type" : "function", + "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged\nout of the target without dropping. This default implementation simply removes the CSS class specified by\noverClass (if any) from the drop element.", + "sig" : "function (source, e, data)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "over", + "type" : "function", + "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.dropAllowed", + "sig" : "function (source, e, data)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addInvalidHandleClass", + "type" : "function", + "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addInvalidHandleId", + "type" : "function", + "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addInvalidHandleType", + "type" : "function", + "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addToGroup", + "type" : "function", + "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "applyConfig", + "type" : "function", + "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearConstraints", + "type" : "function", + "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "clearTicks", + "type" : "function", + "desc" : "Clears any tick interval defined for this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "endDrag", + "type" : "function", + "desc" : "Fired when we are done dragging the object", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getDragEl", + "type" : "function", + "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns a reference to the linked element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "init", + "type" : "function", + "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "initTarget", + "type" : "function", + "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isLocked", + "type" : "function", + "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isTarget", + "type" : "function", + "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isValidHandleChild", + "type" : "function", + "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "lock", + "type" : "function", + "desc" : "Lock this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "notifyDrop", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "notifyEnter", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "notifyOut", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "notifyOver", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onAvailable", + "type" : "function", + "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDrag", + "type" : "function", + "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragDrop", + "type" : "function", + "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragEnter", + "type" : "function", + "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragOut", + "type" : "function", + "desc" : "Abstract method called when we are no longer hovering over an element", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragOver", + "type" : "function", + "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onInvalidDrop", + "type" : "function", + "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onMouseDown", + "type" : "function", + "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onMouseUp", + "type" : "function", + "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "padding", + "type" : "function", + "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeFromGroup", + "type" : "function", + "desc" : "Remove's this instance from the supplied interaction group", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleClass", + "type" : "function", + "desc" : "Unsets an invalid css class", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleId", + "type" : "function", + "desc" : "Unsets an invalid handle id", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleType", + "type" : "function", + "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "resetConstraints", + "type" : "function", + "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "sig" : "(maintainOffset)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setDragElId", + "type" : "function", + "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setHandleElId", + "type" : "function", + "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setInitPosition", + "type" : "function", + "desc" : "Stores the initial placement of the linked element.", + "sig" : "(diffX, diffY)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setOuterHandleElId", + "type" : "function", + "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setPadding", + "type" : "function", + "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "sig" : "(iTop, iRight, iBot, iLeft)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setXConstraint", + "type" : "function", + "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "sig" : "(iLeft, iRight, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setYConstraint", + "type" : "function", + "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "sig" : "(iUp, iDown, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "startDrag", + "type" : "function", + "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "sig" : "(X, Y)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "toString", + "type" : "function", + "desc" : "toString method", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unlock", + "type" : "function", + "desc" : "Unlock this instace", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "unreg", + "type" : "function", + "desc" : "Remove all drag and drop hooks for this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + } + ] + }, + "Roo.dd.DropZone" : { + "props" : [ + { + "name" : "ddGroup", + "type" : "String", + "desc" : "The drag drop group to handle drop events for", + "memberOf" : "Roo.dd.DropTarget" + }, + { + "name" : "dropAllowed", + "type" : "String", + "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").", + "memberOf" : "Roo.dd.DropTarget" + }, + { + "name" : "dropNotAllowed", + "type" : "String", + "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").", + "memberOf" : "Roo.dd.DropTarget" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "overClass", + "type" : "String", + "desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").", + "memberOf" : "Roo.dd.DropTarget" + }, + { + "name" : "success", + "type" : "boolean", + "desc" : "set this after drop listener..", + "memberOf" : "Roo.dd.DropTarget" + }, + { + "name" : "valid", + "type" : "boolean|String", + "desc" : "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..", + "memberOf" : "Roo.dd.DropTarget" + } + ], + "events" : [ + { + "name" : "drop", + "type" : "function", + "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has\nbeen dropped on it. This method has no default implementation and returns false, so you must provide an\nimplementation that does something to process the drop event and returns true so that the drag source's\nrepair action does not run.\n\nIMPORTANT : it should set this.success", + "sig" : "function (source, e, data)\n{\n\n}", + "memberOf" : "Roo.dd.DropTarget" + }, + { + "name" : "enter", + "type" : "function", + "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.overClass and this.dropAllowed", + "sig" : "function (source, e, data)\n{\n\n}", + "memberOf" : "Roo.dd.DropTarget" + }, + { + "name" : "out", + "type" : "function", + "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged\nout of the target without dropping. This default implementation simply removes the CSS class specified by\noverClass (if any) from the drop element.", + "sig" : "function (source, e, data)\n{\n\n}", + "memberOf" : "Roo.dd.DropTarget" + }, + { + "name" : "over", + "type" : "function", + "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.dropAllowed", + "sig" : "function (source, e, data)\n{\n\n}", + "memberOf" : "Roo.dd.DropTarget" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addInvalidHandleClass", + "type" : "function", + "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addInvalidHandleId", + "type" : "function", + "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addInvalidHandleType", + "type" : "function", + "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addToGroup", + "type" : "function", + "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "applyConfig", + "type" : "function", + "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearConstraints", + "type" : "function", + "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "clearTicks", + "type" : "function", + "desc" : "Clears any tick interval defined for this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "endDrag", + "type" : "function", + "desc" : "Fired when we are done dragging the object", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getDragEl", + "type" : "function", + "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns a reference to the linked element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "getTargetFromEvent", + "type" : "function", + "desc" : "Returns a custom data object associated with the DOM node that is the target of the event. By default\nthis looks up the event target in the {@link Roo.dd.Registry}, although you can override this method to\nprovide your own custom lookup.", + "sig" : "(e)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "init", + "type" : "function", + "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "initTarget", + "type" : "function", + "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isLocked", + "type" : "function", + "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isTarget", + "type" : "function", + "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "isValidHandleChild", + "type" : "function", + "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "lock", + "type" : "function", + "desc" : "Lock this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "notifyDrop", + "type" : "function", + "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the dragged item has\nbeen dropped on it. The drag zone will look up the target node based on the event passed in, and if there\nis a node registered for that event, it will delegate to {@link #onNodeDrop} for node-specific handling,\notherwise it will call {@link #onContainerDrop}.", + "sig" : "(source, e, data)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "notifyEnter", + "type" : "function", + "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source is now over\nthe zone. The default implementation returns this.dropNotAllowed and expects that only registered drop\nnodes can process drag drop operations, so if you need the drop zone itself to be able to process drops\nyou should override this method and provide a custom implementation.", + "sig" : "(source, e, data)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "notifyOut", + "type" : "function", + "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source has been dragged\nout of the zone without dropping. If the drag source is currently over a registered node, the notification\nwill be delegated to {@link #onNodeOut} for node-specific handling, otherwise it will be ignored.", + "sig" : "(source, e, data)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "notifyOver", + "type" : "function", + "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the drop zone.\nThis method will be called on every mouse movement while the drag source is over the drop zone.\nIt will call {@link #onNodeOver} while the drag source is over a registered node, and will also automatically\ndelegate to the appropriate node-specific methods as necessary when the drag source enters and exits\nregistered nodes ({@link #onNodeEnter}, {@link #onNodeOut}). If the drag source is not currently over a\nregistered node, it will call {@link #onContainerOver}.", + "sig" : "(source, e, data)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onAvailable", + "type" : "function", + "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onContainerDrop", + "type" : "function", + "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped on it,\nbut not on any of its registered drop nodes. The default implementation returns false, so it should be\noverridden to provide the appropriate processing of the drop event if you need the drop zone itself to\nbe able to accept drops. It should return true when valid so that the drag source's repair action does not run.", + "sig" : "(source, e, data)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "onContainerOver", + "type" : "function", + "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is being dragged over it,\nbut not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so\nit should be overridden to provide the proper feedback if necessary.", + "sig" : "(source, e, data)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "onDrag", + "type" : "function", + "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragDrop", + "type" : "function", + "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragEnter", + "type" : "function", + "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragOut", + "type" : "function", + "desc" : "Abstract method called when we are no longer hovering over an element", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onDragOver", + "type" : "function", + "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onInvalidDrop", + "type" : "function", + "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onMouseDown", + "type" : "function", + "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onMouseUp", + "type" : "function", + "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "onNodeDrop", + "type" : "function", + "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped onto\nthe drop node. The default implementation returns false, so it should be overridden to provide the\nappropriate processing of the drop event and return true so that the drag source's repair action does not run.", + "sig" : "(nodeData, source, e, data)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "onNodeEnter", + "type" : "function", + "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has entered a drop node\nthat it has registered. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.", + "sig" : "(nodeData, source, e, data)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "onNodeOut", + "type" : "function", + "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dragged out of\nthe drop node without dropping. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.", + "sig" : "(nodeData, source, e, data)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "onNodeOver", + "type" : "function", + "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is over a drop node\nthat it has registered. The default implementation returns this.dropNotAllowed, so it should be\noverridden to provide the proper feedback.", + "sig" : "(nodeData, source, e, data)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "padding", + "type" : "function", + "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeFromGroup", + "type" : "function", + "desc" : "Remove's this instance from the supplied interaction group", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleClass", + "type" : "function", + "desc" : "Unsets an invalid css class", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleId", + "type" : "function", + "desc" : "Unsets an invalid handle id", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeInvalidHandleType", + "type" : "function", + "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "resetConstraints", + "type" : "function", + "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "sig" : "(maintainOffset)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setDragElId", + "type" : "function", + "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setHandleElId", + "type" : "function", + "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setInitPosition", + "type" : "function", + "desc" : "Stores the initial placement of the linked element.", + "sig" : "(diffX, diffY)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setOuterHandleElId", + "type" : "function", + "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setPadding", + "type" : "function", + "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "sig" : "(iTop, iRight, iBot, iLeft)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setXConstraint", + "type" : "function", + "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "sig" : "(iLeft, iRight, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "setYConstraint", + "type" : "function", + "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "sig" : "(iUp, iDown, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "startDrag", + "type" : "function", + "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "sig" : "(X, Y)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "toString", + "type" : "function", + "desc" : "toString method", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unlock", + "type" : "function", + "desc" : "Unlock this instace", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + }, + { + "name" : "unreg", + "type" : "function", + "desc" : "Remove all drag and drop hooks for this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop" + } + ] + }, + "Roo.dd.Registry" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "getHandle", + "type" : "function", + "desc" : "Returns the handle registered for a DOM Node by id", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getHandleFromEvent", + "type" : "function", + "desc" : "Returns the handle that is registered for the DOM node that is the target of the event", + "sig" : "(e)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getTarget", + "type" : "function", + "desc" : "Returns a custom data object that is registered for a DOM node by id", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getTargetFromEvent", + "type" : "function", + "desc" : "Returns a custom data object that is registered for the DOM node that is the target of the event", + "sig" : "(e)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "register", + "type" : "function", + "desc" : "Register a drag drop element", + "sig" : "(element, data)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "unregister", + "type" : "function", + "desc" : "Unregister a drag drop element", + "sig" : "(element)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.dd.ScrollManager" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "refreshCache", + "type" : "function", + "desc" : "Manually trigger a cache refresh.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "register", + "type" : "function", + "desc" : "Registers new overflow element(s) to auto scroll", + "sig" : "(el)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "unregister", + "type" : "function", + "desc" : "Unregisters overflow element(s) so they are no longer scrolled", + "sig" : "(el)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.dd.StatusProxy" : { + "props" : [ + { + "name" : "dropAllowed", + "type" : "String", + "desc" : "The CSS class to apply to the status element when drop is allowed (defaults to \"x-dd-drop-ok\").", + "memberOf" : "" + }, + { + "name" : "dropNotAllowed", + "type" : "String", + "desc" : "The CSS class to apply to the status element when drop is not allowed (defaults to \"x-dd-drop-nodrop\").", + "memberOf" : "" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying proxy {@link Roo.Layer}", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getGhost", + "type" : "function", + "desc" : "Returns the ghost element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hides the proxy", + "sig" : "(clear)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "repair", + "type" : "function", + "desc" : "Causes the proxy to return to its position of origin via an animation. Should be called after an\ninvalid drop operation by the item being dragged.", + "sig" : "(xy, callback, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the status indicator to the default dropNotAllowed value", + "sig" : "(clearGhost)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setStatus", + "type" : "function", + "desc" : "Updates the proxy's visual element to indicate the status of whether or not drop is allowed\nover the current target element.", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Displays this proxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "stop", + "type" : "function", + "desc" : "Stops the repair animation if it's currently running", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "sync", + "type" : "function", + "desc" : "Force the Layer to sync its shadow and shim positions to the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "update", + "type" : "function", + "desc" : "Updates the contents of the ghost element", + "sig" : "(html)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.form" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.form.Action" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.form.BasicForm" : { + "props" : [ + { + "name" : "baseParams", + "type" : "Object", + "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.", + "memberOf" : "" + }, + { + "name" : "errorReader", + "type" : "DataReader", + "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.", + "memberOf" : "" + }, + { + "name" : "fileUpload", + "type" : "Boolean", + "desc" : "Set to true if this form is a file upload.", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "method", + "type" : "String", + "desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.", + "memberOf" : "" + }, + { + "name" : "reader", + "type" : "DataReader", + "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.", + "memberOf" : "" + }, + { + "name" : "timeout", + "type" : "Number", + "desc" : "Timeout for form actions in seconds (default is 30 seconds).", + "memberOf" : "" + }, + { + "name" : "trackResetOnLoad", + "type" : "Boolean", + "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.", + "memberOf" : "" + }, + { + "name" : "url", + "type" : "String", + "desc" : "The URL to use for form actions if one isn't supplied in the action options.", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "actioncomplete", + "type" : "function", + "desc" : "Fires when an action is completed.", + "sig" : "function (_self, action)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "actionfailed", + "type" : "function", + "desc" : "Fires when an action fails.", + "sig" : "function (_self, action)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeaction", + "type" : "function", + "desc" : "Fires before any action is performed. Return false to cancel the action.", + "sig" : "function (_self, action)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Add Roo.form components to this form.", + "sig" : "(field1, field2, etc)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addForm", + "type" : "function", + "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.", + "sig" : "(form)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyIfToFields", + "type" : "function", + "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.", + "sig" : "(values)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "applyToFields", + "type" : "function", + "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.", + "sig" : "(values)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clears all invalid messages in this form.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "doAction", + "type" : "function", + "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.", + "sig" : "(actionName, options)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "findField", + "type" : "function", + "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getFieldValues", + "type" : "function", + "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getValues", + "type" : "function", + "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.", + "sig" : "(asString)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "Returns true if any fields in this form have changed since their original load. (New version)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns true if client-side validation on the form is successful.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Shortcut to do a load action.", + "sig" : "(options)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "loadRecord", + "type" : "function", + "desc" : "Loads an Roo.data.Record into this form.", + "sig" : "(record)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark fields in this form invalid in bulk.", + "sig" : "(errors)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Removes a field from the items collection (does NOT remove its markup).", + "sig" : "(field)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Looks at the fields in this form, checks them for an id attribute,\nand calls applyTo on the existing dom element with that id.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets this form.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setValues", + "type" : "function", + "desc" : "Set values for fields in this form in bulk.", + "sig" : "(values)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "submit", + "type" : "function", + "desc" : "Shortcut to do a submit action.", + "sig" : "(options)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateRecord", + "type" : "function", + "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.", + "sig" : "(record)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.form.Checkbox" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})", + "memberOf" : "" + }, + { + "name" : "boxLabel", + "type" : "String", + "desc" : "The text that appears beside the checkbox", + "memberOf" : "" + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "True if the the checkbox should render already checked (defaults to false)", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")", + "memberOf" : "" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)", + "memberOf" : "" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "inputValue", + "type" : "String", + "desc" : "The value that should go into the generated input element's value attribute", + "memberOf" : "" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valueOff", + "type" : "String", + "desc" : "The value that should go into the generated input element's value when unchecked.", + "memberOf" : "" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "check", + "type" : "function", + "desc" : "Fires when the checkbox is checked or unchecked.", + "sig" : "function (_self, checked)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the checked state of the checkbox.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.", + "sig" : "(value, suppressEvent)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + } + ] + }, + "Roo.form.Column" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec used to autocreate the column (defaults to {tag: 'div', cls: 'x-form-ct x-form-column'})", + "memberOf" : "" + }, + { + "name" : "clear", + "type" : "Boolean", + "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)", + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideLabels", + "type" : "Boolean", + "desc" : "True to suppress the display of field labels in this layout (defaults to false)", + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")", + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "labelSeparator", + "type" : "String", + "desc" : "The separator to use after field labels (defaults to ':')", + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "Fixed width in pixels of all field labels (defaults to undefined)", + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "style", + "type" : "String/Object/Function", + "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.", + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "width", + "type" : "Number/String", + "desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addxtype", + "type" : "function", + "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column", + "sig" : "(config)", + "static" : false, + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.form.ComboBox" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allQuery", + "type" : "String", + "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')", + "memberOf" : "" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "alwaysQuery", + "type" : "Boolean", + "desc" : "Disable caching of results, and always send query", + "memberOf" : "" + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})", + "memberOf" : "" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "blockFocus", + "type" : "Boolean", + "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableClear", + "type" : "Boolean", + "desc" : "Disable showing of clear button.", + "memberOf" : "" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "displayField", + "type" : "String", + "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')", + "memberOf" : "" + }, + { + "name" : "editable", + "type" : "Boolean", + "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)", + "memberOf" : "" + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "forceSelection", + "type" : "Boolean", + "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)", + "memberOf" : "" + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "handleHeight", + "type" : "Number", + "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)", + "memberOf" : "" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hiddenName", + "type" : "String", + "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "Roo.form.TriggerField" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "lazyRender", + "type" : "Boolean", + "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)", + "memberOf" : "" + }, + { + "name" : "listAlign", + "type" : "String", + "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')", + "memberOf" : "" + }, + { + "name" : "listClass", + "type" : "String", + "desc" : "CSS class to apply to the dropdown list element (defaults to '')", + "memberOf" : "" + }, + { + "name" : "listWidth", + "type" : "Number", + "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadingText", + "type" : "String", + "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')", + "memberOf" : "" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxHeight", + "type" : "Number", + "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)", + "memberOf" : "" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minChars", + "type" : "Number", + "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)", + "memberOf" : "" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minListWidth", + "type" : "Number", + "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)", + "memberOf" : "" + }, + { + "name" : "mode", + "type" : "String", + "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)", + "memberOf" : "" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "pageSize", + "type" : "Number", + "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)", + "memberOf" : "" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "queryDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')", + "memberOf" : "" + }, + { + "name" : "queryParam", + "type" : "String", + "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')", + "memberOf" : "" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "resizable", + "type" : "Boolean", + "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)", + "memberOf" : "" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)", + "memberOf" : "" + }, + { + "name" : "selectedClass", + "type" : "String", + "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')", + "memberOf" : "" + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right", + "memberOf" : "" + }, + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "The data store to which this combo is bound (defaults to undefined)", + "memberOf" : "" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "title", + "type" : "String", + "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)", + "memberOf" : "" + }, + { + "name" : "tpl", + "type" : "String/Roo.Template", + "desc" : "The template to use to render the output", + "memberOf" : "" + }, + { + "name" : "transform", + "type" : "String/HTMLElement/Element", + "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox", + "memberOf" : "" + }, + { + "name" : "triggerAction", + "type" : "String", + "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')", + "memberOf" : "" + }, + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be appended if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).", + "memberOf" : "" + }, + { + "name" : "typeAhead", + "type" : "Boolean", + "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)", + "memberOf" : "" + }, + { + "name" : "typeAheadDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)", + "memberOf" : "" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valueField", + "type" : "String", + "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.", + "memberOf" : "" + }, + { + "name" : "valueNotFoundText", + "type" : "String", + "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)", + "memberOf" : "" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent" + } + ], + "events" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "autosize", + "type" : "function", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforequery", + "type" : "function", + "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:", + "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeselect", + "type" : "function", + "desc" : "Fires before a list item is selected. Return false to cancel the selection.", + "sig" : "function (combo, record, index)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "collapse", + "type" : "function", + "desc" : "Fires when the dropdown list is collapsed", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "edit", + "type" : "function", + "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", + "sig" : "function (combo, record)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Fires when the dropdown list is expanded", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Fires when a list item is selected", + "sig" : "function (combo, record, index)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TriggerField" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "clearValue", + "type" : "function", + "desc" : "Clears any text/value currently set in the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "collapse", + "type" : "function", + "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "doQuery", + "type" : "function", + "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", + "sig" : "(query, forceAll)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the currently selected field value or empty string if no value is set.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isExpanded", + "type" : "function", + "desc" : "Returns true if the dropdown list is expanded, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onTriggerClick", + "type" : "function", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.form.TriggerField" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(index, scrollIntoView)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectByValue", + "type" : "function", + "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(value, scrollIntoView)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectText", + "type" : "function", + "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setEditable", + "type" : "function", + "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setFromData", + "type" : "function", + "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField" + } + ] + }, + "Roo.form.ComboBoxArray" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "combo", + "type" : "Roo.form.Combo", + "desc" : "The combo box that is wrapped", + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "True if this field should automatically grow and shrink to its content", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "The maximum width to allow when grow = true (defaults to 800)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "The minimum width to allow when grow = true (defaults to 30)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hiddenName", + "type" : "String", + "desc" : "The hidden name of the field, often contains an comma seperated list of names", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The name of the visable items on this form (eg. titles not ids)", + "memberOf" : "" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The width of the box that displays the selected element", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "autosize", + "type" : "function", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeremove", + "type" : "function", + "desc" : "Fires before remove the value from the list", + "sig" : "function (_self, item)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Fires when remove the value from the list", + "sig" : "function (_self, item)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "selectText", + "type" : "function", + "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the combox array value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField" + } + ] + }, + "Roo.form.ComboBoxArray.Item" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + } + ] + }, + "Roo.form.ComboCheck" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allQuery", + "type" : "String", + "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "alwaysQuery", + "type" : "Boolean", + "desc" : "Disable caching of results, and always send query", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "blockFocus", + "type" : "Boolean", + "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableClear", + "type" : "Boolean", + "desc" : "Disable showing of clear button.", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "displayField", + "type" : "String", + "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "editable", + "type" : "Boolean", + "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "forceSelection", + "type" : "Boolean", + "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "handleHeight", + "type" : "Number", + "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hiddenName", + "type" : "String", + "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "Roo.form.TriggerField" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "lazyRender", + "type" : "Boolean", + "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "listAlign", + "type" : "String", + "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "listClass", + "type" : "String", + "desc" : "CSS class to apply to the dropdown list element (defaults to '')", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "listWidth", + "type" : "Number", + "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadingText", + "type" : "String", + "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxHeight", + "type" : "Number", + "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minChars", + "type" : "Number", + "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minListWidth", + "type" : "Number", + "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "mode", + "type" : "String", + "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "pageSize", + "type" : "Number", + "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "queryDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "queryParam", + "type" : "String", + "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "resizable", + "type" : "Boolean", + "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "selectedClass", + "type" : "String", + "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "The data store to which this combo is bound (defaults to undefined)", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "title", + "type" : "String", + "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "tpl", + "type" : "String/Roo.Template", + "desc" : "The template to use to render the output", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "transform", + "type" : "String/HTMLElement/Element", + "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "triggerAction", + "type" : "String", + "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be appended if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "typeAhead", + "type" : "Boolean", + "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "typeAheadDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valueField", + "type" : "String", + "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "valueNotFoundText", + "type" : "String", + "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent" + } + ], + "events" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "autosize", + "type" : "function", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforequery", + "type" : "function", + "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:", + "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeselect", + "type" : "function", + "desc" : "Fires before a list item is selected. Return false to cancel the selection.", + "sig" : "function (combo, record, index)\n{\n\n}", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "collapse", + "type" : "function", + "desc" : "Fires when the dropdown list is collapsed", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "edit", + "type" : "function", + "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", + "sig" : "function (combo, record)\n{\n\n}", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Fires when the dropdown list is expanded", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Fires when a list item is selected", + "sig" : "function (combo, record, index)\n{\n\n}", + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TriggerField" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "clearValue", + "type" : "function", + "desc" : "Clears any text/value currently set in the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "collapse", + "type" : "function", + "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "doQuery", + "type" : "function", + "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", + "sig" : "(query, forceAll)", + "static" : false, + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the currently selected field value or empty string if no value is set.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isExpanded", + "type" : "function", + "desc" : "Returns true if the dropdown list is expanded, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onTriggerClick", + "type" : "function", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.form.TriggerField" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(index, scrollIntoView)", + "static" : false, + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "selectByValue", + "type" : "function", + "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(value, scrollIntoView)", + "static" : false, + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "selectText", + "type" : "function", + "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setEditable", + "type" : "function", + "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "setFromData", + "type" : "function", + "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.ComboBox" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField" + } + ] + }, + "Roo.form.DateField" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "altFormats", + "type" : "String", + "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').", + "memberOf" : "" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})", + "memberOf" : "" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "disabledDates", + "type" : "Array", + "desc" : "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].", + "memberOf" : "" + }, + { + "name" : "disabledDatesText", + "type" : "String", + "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')", + "memberOf" : "" + }, + { + "name" : "disabledDays", + "type" : "Array", + "desc" : "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).", + "memberOf" : "" + }, + { + "name" : "disabledDaysText", + "type" : "String", + "desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')", + "memberOf" : "" + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "format", + "type" : "String", + "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').", + "memberOf" : "" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "Roo.form.TriggerField" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display when the date in the field is invalid (defaults to\n'{value} is not a valid date - it must be in the format {format}').", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxText", + "type" : "String", + "desc" : "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').", + "memberOf" : "" + }, + { + "name" : "maxValue", + "type" : "Date/String", + "desc" : "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).", + "memberOf" : "" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minText", + "type" : "String", + "desc" : "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').", + "memberOf" : "" + }, + { + "name" : "minValue", + "type" : "Date/String", + "desc" : "The minimum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).", + "memberOf" : "" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be appended if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).", + "memberOf" : "" + }, + { + "name" : "useIso", + "type" : "Boolean", + "desc" : "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (false)", + "memberOf" : "" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent" + } + ], + "events" : [ + { + "name" : "autosize", + "type" : "function", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Fires when a date is selected", + "sig" : "function (combo, date)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TriggerField" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the current date value of the date field.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onTriggerClick", + "type" : "function", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.form.TriggerField" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "selectText", + "type" : "function", + "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using DateField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n
Usage:\n
\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\ndateField.setValue(dt);\n\n//Pass a date string (default format):\ndateField.setValue('5/4/06');\n\n//Pass a date string (custom format):\ndateField.format = 'Y-m-d';\ndateField.setValue('2006-5-4');\n
", + "sig" : "(date)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField" + } + ] + }, + "Roo.form.DayPicker" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")", + "memberOf" : "" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)", + "memberOf" : "" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the checked state of the checkbox.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.", + "sig" : "(value, suppressEvent)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + } + ] + }, + "Roo.form.DisplayField" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})", + "memberOf" : "" + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : [ + "(true", + "false)" + ], + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")", + "memberOf" : "" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)", + "memberOf" : "" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valueRenderer", + "type" : "Function", + "desc" : "The renderer for the field (so you can reformat output). should return raw HTML", + "memberOf" : "" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "close", + "type" : "function", + "desc" : "Fires after the click the close btn", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets the checked state of the checkbox.", + "sig" : "(checked)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + } + ] + }, + "Roo.form.FCKeditor" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.TextArea" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "fck", + "type" : "Object", + "desc" : "BasePath", + "memberOf" : "" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "True if this field should automatically grow and shrink to its content", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "The maximum height to allow when grow = true (defaults to 1000)", + "memberOf" : "Roo.form.TextArea" + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "The minimum height to allow when grow = true (defaults to 60)", + "memberOf" : "Roo.form.TextArea" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "preventScrollbars", + "type" : "Boolean", + "desc" : "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)", + "memberOf" : "Roo.form.TextArea" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent" + } + ], + "events" : [ + { + "name" : "autosize", + "type" : "function", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "editorinit", + "type" : "function", + "desc" : "Fired when the editor is initialized - you can add extra handlers here..", + "sig" : "function (_self, the)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextArea" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "selectText", + "type" : "function", + "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField" + } + ] + }, + "Roo.form.Field" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.form.FieldSet" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec used to autocreate the fieldset (defaults to {tag: 'fieldset', cn: {tag:'legend'}})", + "memberOf" : "" + }, + { + "name" : "clear", + "type" : "Boolean", + "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)", + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideLabels", + "type" : "Boolean", + "desc" : "True to suppress the display of field labels in this layout (defaults to false)", + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")", + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "labelSeparator", + "type" : "String", + "desc" : "The separator to use after field labels (defaults to ':')", + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "Fixed width in pixels of all field labels (defaults to undefined)", + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "legend", + "type" : "String", + "desc" : "The text to display as the legend for the FieldSet (defaults to '')", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "style", + "type" : "String/Object/Function", + "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.", + "memberOf" : "Roo.form.Layout" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addxtype", + "type" : "function", + "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column", + "sig" : "(config)", + "static" : false, + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.form.Form" : { + "props" : [ + { + "name" : "baseParams", + "type" : "Object", + "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.", + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "buttonAlign", + "type" : "String", + "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center\")", + "memberOf" : "" + }, + { + "name" : "errorReader", + "type" : "DataReader", + "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.", + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "fileUpload", + "type" : "Boolean", + "desc" : "Set to true if this form is a file upload.", + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "formData", + "type" : "boolean|FormData", + "desc" : "- true to use new 'FormData' post, or set to a new FormData({dom form}) Object, if\nsending a formdata with extra parameters - eg uploaded elements.", + "memberOf" : "" + }, + { + "name" : "itemCls", + "type" : "String", + "desc" : "A css class to apply to the x-form-item of fields. This property cascades to child containers.", + "memberOf" : "" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\").\nThis property cascades to child containers if not set.", + "memberOf" : "" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "The width of labels. This property cascades to child containers.", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "method", + "type" : "String", + "desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.", + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "minButtonWidth", + "type" : "Number", + "desc" : "Minimum width of all buttons in pixels (defaults to 75)", + "memberOf" : "" + }, + { + "name" : "monitorPoll", + "type" : "Number", + "desc" : "The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)", + "memberOf" : "" + }, + { + "name" : "monitorValid", + "type" : "Boolean", + "desc" : "If true the form monitors its valid state client-side and\nfires a looping event with that state. This is required to bind buttons to the valid\nstate using the config value formBind:true on the button.", + "memberOf" : "" + }, + { + "name" : "progressUrl", + "type" : "String", + "desc" : "- Url to return progress data", + "memberOf" : "" + }, + { + "name" : "reader", + "type" : "DataReader", + "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.", + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "timeout", + "type" : "Number", + "desc" : "Timeout for form actions in seconds (default is 30 seconds).", + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "trackResetOnLoad", + "type" : "Boolean", + "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.", + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "url", + "type" : "String", + "desc" : "The URL to use for form actions if one isn't supplied in the action options.", + "memberOf" : "Roo.form.BasicForm" + } + ], + "events" : [ + { + "name" : "actioncomplete", + "type" : "function", + "desc" : "Fires when an action is completed.", + "sig" : "function (_self, action)\n{\n\n}", + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "actionfailed", + "type" : "function", + "desc" : "Fires when an action fails.", + "sig" : "function (_self, action)\n{\n\n}", + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "beforeaction", + "type" : "function", + "desc" : "Fires before any action is performed. Return false to cancel the action.", + "sig" : "function (_self, action)\n{\n\n}", + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "clientvalidation", + "type" : "function", + "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state", + "sig" : "function (_self, valid)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "rendered", + "type" : "function", + "desc" : "Fires when the form is rendered", + "sig" : "function (form)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Add Roo.form components to the current open container (e.g. column, fieldset, etc.). Fields added via this method\ncan also be passed with an additional property of fieldLabel, which if supplied, will provide the text to display\nas the label of the field.", + "sig" : "(field1, field2)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addButton", + "type" : "function", + "desc" : "Adds a button to the footer of the form - this must be called before the form is rendered.", + "sig" : "(config, handler, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addForm", + "type" : "function", + "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.", + "sig" : "(form)", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addxtype", + "type" : "function", + "desc" : "Adds a series of form elements (using the xtype property as the factory method.\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column, (and 'end' to close a block)", + "sig" : "(config)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "applyIfToFields", + "type" : "function", + "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.", + "sig" : "(values)", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "applyToFields", + "type" : "function", + "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.", + "sig" : "(values)", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clears all invalid messages in this form.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "column", + "type" : "function", + "desc" : "Opens a new {@link Roo.form.Column} container in the layout stack. If fields are passed after the config, the\nfields are added and the column is closed. If no fields are passed the column remains open\nuntil end() is called.", + "sig" : "(config, field1, field2, etc)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "container", + "type" : "function", + "desc" : "Opens a new {@link Roo.form.Layout} container in the layout stack. If fields are passed after the config, the\nfields are added and the container is closed. If no fields are passed the container remains open\nuntil end() is called.", + "sig" : "(config, field1, field2, etc)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "doAction", + "type" : "function", + "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.", + "sig" : "(actionName, options)", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "end", + "type" : "function", + "desc" : "Closes the current open container", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fieldset", + "type" : "function", + "desc" : "Opens a new {@link Roo.form.FieldSet} container in the layout stack. If fields are passed after the config, the\nfields are added and the fieldset is closed. If no fields are passed the fieldset remains open\nuntil end() is called.", + "sig" : "(config, field1, field2, etc)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "findField", + "type" : "function", + "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "findbyId", + "type" : "function", + "desc" : "Find any element that has been added to a form, using it's ID or name\nThis can include framesets, columns etc. along with regular fields..", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getFieldValues", + "type" : "function", + "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "getValues", + "type" : "function", + "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.", + "sig" : "(asString)", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "Returns true if any fields in this form have changed since their original load. (New version)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns true if client-side validation on the form is successful.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Shortcut to do a load action.", + "sig" : "(options)", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "loadRecord", + "type" : "function", + "desc" : "Loads an Roo.data.Record into this form.", + "sig" : "(record)", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark fields in this form invalid in bulk.", + "sig" : "(errors)", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Removes a field from the items collection (does NOT remove its markup).", + "sig" : "(field)", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Render this form into the passed container. This should only be called once!", + "sig" : "(container)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets this form.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "setValues", + "type" : "function", + "desc" : "Set values for fields in this form in bulk.", + "sig" : "(values)", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "start", + "type" : "function", + "desc" : "Opens the passed container in the layout stack. The container can be any {@link Roo.form.Layout} or subclass.", + "sig" : "(container)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "startMonitoring", + "type" : "function", + "desc" : "Starts monitoring of the valid state of this form. Usually this is done by passing the config\noption \"monitorValid\"", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "stopMonitoring", + "type" : "function", + "desc" : "Stops monitoring of the valid state of this form", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "submit", + "type" : "function", + "desc" : "Shortcut to do a submit action.", + "sig" : "(options)", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateRecord", + "type" : "function", + "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.", + "sig" : "(record)", + "static" : false, + "memberOf" : "Roo.form.BasicForm" + } + ] + }, + "Roo.form.GridField" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "addTitle", + "type" : "String", + "desc" : "Text to include for adding a title.", + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "- used to restrict height of grid..", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "- used to restrict width of grid..", + "memberOf" : "" + }, + { + "name" : "xgrid", + "type" : "Object", + "desc" : "(xtype'd description of grid) { xtype : 'Grid', dataSource: .... }\n\n}", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets the value of the item.", + "sig" : "(either)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + } + ] + }, + "Roo.form.Hidden" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "True if this field should automatically grow and shrink to its content", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "The maximum width to allow when grow = true (defaults to 800)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "The minimum width to allow when grow = true (defaults to 30)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent" + } + ], + "events" : [ + { + "name" : "autosize", + "type" : "function", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "selectText", + "type" : "function", + "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField" + } + ] + }, + "Roo.form.HtmlEditor" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "blacklist", + "type" : "Array", + "desc" : "of html tags - in addition to standard blacklist.", + "memberOf" : "" + }, + { + "name" : "clearUp", + "type" : "Boolean", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "(in pixels)", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "resizable", + "type" : "String", + "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.", + "memberOf" : "" + }, + { + "name" : "stylesheets", + "type" : "Array", + "desc" : "url of stylesheets. set to [] to disable stylesheets.", + "memberOf" : "" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "toolbars", + "type" : "Array", + "desc" : "Array of toolbars. - defaults to just the Standard one", + "memberOf" : "" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "whitelist", + "type" : "Array", + "desc" : "of html tags - in addition to statndard whitelist", + "memberOf" : "" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "(in pixels)", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "autosave", + "type" : "function", + "desc" : "Auto save the htmlEditor value as a file into Events", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforepush", + "type" : "function", + "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforesync", + "type" : "function", + "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "", + "sig" : "function ()\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "change", + "type" : "function", + "desc" : "", + "sig" : "function ()\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "editmodechange", + "type" : "function", + "desc" : "Fires when the editor switches edit modes", + "sig" : "function (_self, sourceEdit)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "editorevent", + "type" : "function", + "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "firstfocus", + "type" : "function", + "desc" : "Fires when on first focus - needed by toolbars..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "", + "sig" : "function ()\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "initialize", + "type" : "function", + "desc" : "Fires when the editor is fully initialized (including the iframe)", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "push", + "type" : "function", + "desc" : "Fires when the iframe editor is updated with content from the textarea.", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "savedpreview", + "type" : "function", + "desc" : "preview the saved version of htmlEditor", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "", + "sig" : "function ()\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "stylesheetsclick", + "type" : "function", + "desc" : "Fires when press the Sytlesheets button", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "sync", + "type" : "function", + "desc" : "Fires when the textarea is updated with content from the editor iframe.", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "createToolbar", + "type" : "function", + "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.", + "sig" : "(editor)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "toggleSourceEdit", + "type" : "function", + "desc" : "Toggles the editor between standard and source edit mode.", + "sig" : "(sourceEdit)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + } + ] + }, + "Roo.form.HtmlEditor.ToolbarContext" : { + "props" : [ + { + "name" : "disable", + "type" : "Object", + "desc" : "List of toolbar elements to disable", + "memberOf" : "" + }, + { + "name" : "styles", + "type" : "Object", + "desc" : "List of styles \n eg. { '*' : [ 'headline' ] , 'TD' : [ 'underline', 'double-underline' ] } \n\nThese must be defined in the page, so they get rendered correctly..\n.headline { }\nTD.underline { }", + "memberOf" : "" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "updateToolbar", + "type" : "function", + "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.\n\nNote you can force an update by calling on('editorevent', scope, false)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.form.HtmlEditor.ToolbarStandard" : { + "props" : [ + { + "name" : "btns", + "type" : "Array", + "desc" : "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }", + "memberOf" : "" + }, + { + "name" : "createLinkText", + "type" : "String", + "desc" : "The default text for the create link prompt", + "memberOf" : "" + }, + { + "name" : "defaultFont", + "type" : "String", + "desc" : "default font to use.", + "memberOf" : "" + }, + { + "name" : "defaultLinkValue", + "type" : "String", + "desc" : "The default value for the create link prompt (defaults to http:/ /)", + "memberOf" : "" + }, + { + "name" : "disable", + "type" : "Object", + "desc" : "List of elements to disable..", + "memberOf" : "" + }, + { + "name" : "fontFamilies", + "type" : "Array", + "desc" : "An array of available font families", + "memberOf" : "" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "updateToolbar", + "type" : "function", + "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.form.Layout" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})", + "memberOf" : "" + }, + { + "name" : "clear", + "type" : "Boolean", + "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)", + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "hideLabels", + "type" : "Boolean", + "desc" : "True to suppress the display of field labels in this layout (defaults to false)", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")", + "memberOf" : "" + }, + { + "name" : "labelSeparator", + "type" : "String", + "desc" : "The separator to use after field labels (defaults to ':')", + "memberOf" : "" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "Fixed width in pixels of all field labels (defaults to undefined)", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "style", + "type" : "String/Object/Function", + "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addxtype", + "type" : "function", + "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column", + "sig" : "(config)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.form.MonthField" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "altFormats", + "type" : "String", + "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').", + "memberOf" : "" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})", + "memberOf" : "" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "disabledDates", + "type" : "Array", + "desc" : "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].", + "memberOf" : "" + }, + { + "name" : "disabledDatesText", + "type" : "String", + "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')", + "memberOf" : "" + }, + { + "name" : "disabledDays", + "type" : "Array", + "desc" : "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).", + "memberOf" : "" + }, + { + "name" : "disabledDaysText", + "type" : "String", + "desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')", + "memberOf" : "" + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "format", + "type" : "String", + "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').", + "memberOf" : "" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "Roo.form.TriggerField" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display when the date in the field is invalid (defaults to\n'{value} is not a valid date - it must be in the format {format}').", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxTextf", + "type" : "String", + "desc" : "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').", + "memberOf" : "" + }, + { + "name" : "maxValue", + "type" : "Date/String", + "desc" : "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).", + "memberOf" : "" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minText", + "type" : "String", + "desc" : "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').", + "memberOf" : "" + }, + { + "name" : "minValue", + "type" : "Date/String", + "desc" : "The minimum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).", + "memberOf" : "" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be appended if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).", + "memberOf" : "" + }, + { + "name" : "useIso", + "type" : "Boolean", + "desc" : "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (true)", + "memberOf" : "" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent" + } + ], + "events" : [ + { + "name" : "autosize", + "type" : "function", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Fires when a date is selected", + "sig" : "function (combo, date)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TriggerField" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the current date value of the date field.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onTriggerClick", + "type" : "function", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.form.TriggerField" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "selectText", + "type" : "function", + "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using MonthField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n
Usage:\n
\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\nmonthField.setValue(dt);\n\n//Pass a date string (default format):\nmonthField.setValue('5/4/06');\n\n//Pass a date string (custom format):\nmonthField.format = 'Y-m-d';\nmonthField.setValue('2006-5-4');\n
", + "sig" : "(date)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField" + } + ] + }, + "Roo.form.NumberField" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "allowDecimals", + "type" : "Boolean", + "desc" : "False to disallow decimal values (defaults to true)", + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowNegative", + "type" : "Boolean", + "desc" : "False to prevent entering a negative sign (defaults to true)", + "memberOf" : "" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "decimalPrecision", + "type" : "Number", + "desc" : "The maximum precision to display after the decimal separator (defaults to 2)", + "memberOf" : "" + }, + { + "name" : "decimalSeparator", + "type" : "String", + "desc" : "Character(s) to allow as the decimal separator (defaults to '.')", + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field x-form-num-field\")", + "memberOf" : "" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "True if this field should automatically grow and shrink to its content", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "The maximum width to allow when grow = true (defaults to 800)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "The minimum width to allow when grow = true (defaults to 30)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxText", + "type" : "String", + "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")", + "memberOf" : "" + }, + { + "name" : "maxValue", + "type" : "Number", + "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)", + "memberOf" : "" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minText", + "type" : "String", + "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")", + "memberOf" : "" + }, + { + "name" : "minValue", + "type" : "Number", + "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)", + "memberOf" : "" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "nanText", + "type" : "String", + "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")", + "memberOf" : "" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent" + } + ], + "events" : [ + { + "name" : "autosize", + "type" : "function", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "selectText", + "type" : "function", + "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField" + } + ] + }, + "Roo.form.Radio" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.Checkbox" + }, + { + "name" : "boxLabel", + "type" : "String", + "desc" : "The text that appears beside the checkbox", + "memberOf" : "Roo.form.Checkbox" + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "True if the the checkbox should render already checked (defaults to false)", + "memberOf" : "Roo.form.Checkbox" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Checkbox" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)", + "memberOf" : "Roo.form.Checkbox" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "inputValue", + "type" : "String", + "desc" : "The value that should go into the generated input element's value attribute", + "memberOf" : "Roo.form.Checkbox" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valueOff", + "type" : "String", + "desc" : "The value that should go into the generated input element's value when unchecked.", + "memberOf" : "Roo.form.Checkbox" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "check", + "type" : "function", + "desc" : "Fires when the checkbox is checked or unchecked.", + "sig" : "function (_self, checked)\n{\n\n}", + "memberOf" : "Roo.form.Checkbox" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getGroupValue", + "type" : "function", + "desc" : "If this radio is part of a group, it will return the selected value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the checked state of the checkbox.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Checkbox" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.", + "sig" : "(value, suppressEvent)", + "static" : false, + "memberOf" : "Roo.form.Checkbox" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + } + ] + }, + "Roo.form.Row" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})", + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "clear", + "type" : "Boolean", + "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)", + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "height", + "type" : "Number/String", + "desc" : "The fixed height of the column in pixels or CSS value (defaults to \"auto\")", + "memberOf" : "" + }, + { + "name" : "hideLabels", + "type" : "Boolean", + "desc" : "True to suppress the display of field labels in this layout (defaults to false)", + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")", + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "labelSeparator", + "type" : "String", + "desc" : "The separator to use after field labels (defaults to ':')", + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "Fixed width in pixels of all field labels (defaults to undefined)", + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "style", + "type" : "String/Object/Function", + "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.", + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "width", + "type" : "Number/String", + "desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addxtype", + "type" : "function", + "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column", + "sig" : "(config)", + "static" : false, + "memberOf" : "Roo.form.Layout" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.form.Select" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allQuery", + "type" : "String", + "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')", + "memberOf" : "" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "alwaysQuery", + "type" : "Boolean", + "desc" : "Disable caching of results, and always send query", + "memberOf" : "" + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})", + "memberOf" : "" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "blockFocus", + "type" : "Boolean", + "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "defaultValue", + "type" : "String", + "desc" : "The value displayed after loading the store.", + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableClear", + "type" : "Boolean", + "desc" : "Disable showing of clear button.", + "memberOf" : "" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "displayField", + "type" : "String", + "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')", + "memberOf" : "" + }, + { + "name" : "editable", + "type" : "Boolean", + "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)", + "memberOf" : "" + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "forceSelection", + "type" : "Boolean", + "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)", + "memberOf" : "" + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "handleHeight", + "type" : "Number", + "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)", + "memberOf" : "" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hiddenName", + "type" : "String", + "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "Roo.form.TriggerField" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "lazyRender", + "type" : "Boolean", + "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)", + "memberOf" : "" + }, + { + "name" : "listAlign", + "type" : "String", + "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')", + "memberOf" : "" + }, + { + "name" : "listClass", + "type" : "String", + "desc" : "CSS class to apply to the dropdown list element (defaults to '')", + "memberOf" : "" + }, + { + "name" : "listWidth", + "type" : "Number", + "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadingText", + "type" : "String", + "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')", + "memberOf" : "" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxHeight", + "type" : "Number", + "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)", + "memberOf" : "" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minChars", + "type" : "Number", + "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)", + "memberOf" : "" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minListWidth", + "type" : "Number", + "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)", + "memberOf" : "" + }, + { + "name" : "mode", + "type" : "String", + "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)", + "memberOf" : "" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "pageSize", + "type" : "Number", + "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)", + "memberOf" : "" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "queryDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')", + "memberOf" : "" + }, + { + "name" : "queryParam", + "type" : "String", + "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')", + "memberOf" : "" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "resizable", + "type" : "Boolean", + "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)", + "memberOf" : "" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)", + "memberOf" : "" + }, + { + "name" : "selectedClass", + "type" : "String", + "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')", + "memberOf" : "" + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right", + "memberOf" : "" + }, + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "The data store to which this combo is bound (defaults to undefined)", + "memberOf" : "" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "title", + "type" : "String", + "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)", + "memberOf" : "" + }, + { + "name" : "tpl", + "type" : "String/Roo.Template", + "desc" : "The template to use to render the output", + "memberOf" : "" + }, + { + "name" : "transform", + "type" : "String/HTMLElement/Element", + "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox", + "memberOf" : "" + }, + { + "name" : "triggerAction", + "type" : "String", + "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')", + "memberOf" : "" + }, + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be appended if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).", + "memberOf" : "" + }, + { + "name" : "typeAhead", + "type" : "Boolean", + "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)", + "memberOf" : "" + }, + { + "name" : "typeAheadDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)", + "memberOf" : "" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valueField", + "type" : "String", + "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.", + "memberOf" : "" + }, + { + "name" : "valueNotFoundText", + "type" : "String", + "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)", + "memberOf" : "" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent" + } + ], + "events" : [ + { + "name" : "autosize", + "type" : "function", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TriggerField" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "clearValue", + "type" : "function", + "desc" : "Clears any text/value currently set in the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "collapse", + "type" : "function", + "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "doQuery", + "type" : "function", + "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", + "sig" : "(query, forceAll)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the currently selected field value or empty string if no value is set.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isExpanded", + "type" : "function", + "desc" : "Returns true if the dropdown list is expanded, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onTriggerClick", + "type" : "function", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.form.TriggerField" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(index, scrollIntoView)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectByValue", + "type" : "function", + "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(value, scrollIntoView)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectText", + "type" : "function", + "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setEditable", + "type" : "function", + "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setFromData", + "type" : "function", + "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setWidth", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField" + } + ] + }, + "Roo.form.Signature" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to false)", + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The signature panel height (defaults to 100)", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "labels", + "type" : "Object", + "desc" : "Label to use when rendering a form.\ndefaults to \nlabels : { \n clear : \"Clear\",\n confirm : \"Confirm\"\n }", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The signature panel width (defaults to 300)", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "confirm", + "type" : "function", + "desc" : "Fires when the 'confirm' icon is pressed (add a listener to enable add button)", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", + "sig" : "function (combo, record)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "createToolbar", + "type" : "function", + "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.", + "sig" : "(editor)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getConfirmed", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getHeight", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getImageDataURI", + "type" : "function", + "desc" : "when user is clicked confirm then show this image.....", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getWidth", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + } + ] + }, + "Roo.form.TextArea" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})", + "memberOf" : "" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "True if this field should automatically grow and shrink to its content", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "The maximum height to allow when grow = true (defaults to 1000)", + "memberOf" : "" + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "The minimum height to allow when grow = true (defaults to 60)", + "memberOf" : "" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "preventScrollbars", + "type" : "Boolean", + "desc" : "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)", + "memberOf" : "" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent" + } + ], + "events" : [ + { + "name" : "autosize", + "type" : "function", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "selectText", + "type" : "function", + "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField" + } + ] + }, + "Roo.form.TextField" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "True if this field should automatically grow and shrink to its content", + "memberOf" : "" + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "The maximum width to allow when grow = true (defaults to 800)", + "memberOf" : "" + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "The minimum width to allow when grow = true (defaults to 30)", + "memberOf" : "" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent" + } + ], + "events" : [ + { + "name" : "autosize", + "type" : "function", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "selectText", + "type" : "function", + "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.form.TriggerField" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"16\", autocomplete: \"off\"})", + "memberOf" : "" + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "" + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be appended if specified.", + "memberOf" : "" + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent" + } + ], + "events" : [ + { + "name" : "autosize", + "type" : "function", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "blur", + "type" : "function", + "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "change", + "type" : "function", + "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "invalid", + "type" : "function", + "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "keyup", + "type" : "function", + "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "resize", + "type" : "function", + "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.form.Field" + }, + { + "name" : "valid", + "type" : "function", + "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.form.Field" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "applyTo", + "type" : "function", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearInvalid", + "type" : "function", + "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getBox", + "type" : "function", + "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getName", + "type" : "function", + "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getPosition", + "type" : "function", + "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getRawValue", + "type" : "function", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "getSize", + "type" : "function", + "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasChanged", + "type" : "function", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isDirty", + "type" : "function", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isValid", + "type" : "function", + "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "markInvalid", + "type" : "function", + "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onPosition", + "type" : "function", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onResize", + "type" : "function", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "onTriggerClick", + "type" : "function", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "reset", + "type" : "function", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "resetHasChanged", + "type" : "function", + "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "selectText", + "type" : "function", + "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setPagePosition", + "type" : "function", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setPosition", + "type" : "function", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setRawValue", + "type" : "function", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "syncSize", + "type" : "function", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "updateBox", + "type" : "function", + "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent" + }, + { + "name" : "validate", + "type" : "function", + "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field" + }, + { + "name" : "validateValue", + "type" : "function", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField" + } + ] + }, + "Roo.form.VTypes" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "alpha'", + "type" : "function", + "desc" : "The function used to validate alpha values", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "alphanum'", + "type" : "function", + "desc" : "The function used to validate alphanumeric values", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "email'", + "type" : "function", + "desc" : "The function used to validate email addresses", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "url'", + "type" : "function", + "desc" : "The function used to validate URLs", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.grid" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.grid.AbstractGridView" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.grid.AbstractSelectionModel" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "isLocked", + "type" : "function", + "desc" : "Returns true if the selections are locked.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "lock", + "type" : "function", + "desc" : "Locks the selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unlock", + "type" : "function", + "desc" : "Unlocks the selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.grid.Calendar" : { + "props" : [ + { + "name" : "eventStore", + "type" : "Store", + "desc" : "The store that loads events.", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "bodyscroll", + "type" : "function", + "desc" : "Fires when the body element is scrolled", + "sig" : "function (scrollLeft, scrollTop)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "cellclick", + "type" : "function", + "desc" : "Fires when a cell is clicked", + "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "cellcontextmenu", + "type" : "function", + "desc" : "Fires when a cell is right clicked", + "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "celldblclick", + "type" : "function", + "desc" : "Fires when a cell is double clicked", + "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "click", + "type" : "function", + "desc" : "The raw click event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "columnmove", + "type" : "function", + "desc" : "Fires when the user moves a column", + "sig" : "function (oldIndex, newIndex)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "columnresize", + "type" : "function", + "desc" : "Fires when the user resizes a column", + "sig" : "function (columnIndex, newSize)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "contextmenu", + "type" : "function", + "desc" : "The raw contextmenu event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "dblclick", + "type" : "function", + "desc" : "The raw dblclick event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "dragdrop", + "type" : "function", + "desc" : "Fires when dragged row(s) are dropped on a valid DD target", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "dragenter", + "type" : "function", + "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "dragout", + "type" : "function", + "desc" : "Fires when the dragged row(s) leave another DD target while being dragged", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "dragover", + "type" : "function", + "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "enddrag", + "type" : "function", + "desc" : "Fires when a drag operation is complete", + "sig" : "function (_self, dd, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "eventclick", + "type" : "function", + "desc" : "Fires when the mouse click an", + "sig" : "function (_self, )\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "evententer", + "type" : "function", + "desc" : "Fires when mouse over an event", + "sig" : "function (_self, Event)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "eventleave", + "type" : "function", + "desc" : "Fires when the mouse leaves an", + "sig" : "function (_self, )\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "eventrender", + "type" : "function", + "desc" : "Fires before each cell is rendered, so you can modify the contents, like cls / title / qtip", + "sig" : "function (_self, data)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "headerclick", + "type" : "function", + "desc" : "Fires when a header is clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "headercontextmenu", + "type" : "function", + "desc" : "Fires when a header is right clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "headerdblclick", + "type" : "function", + "desc" : "Fires when a header cell is double clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "keydown", + "type" : "function", + "desc" : "The raw keydown event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "keypress", + "type" : "function", + "desc" : "The raw keypress event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "monthchange", + "type" : "function", + "desc" : "Fires when the displayed month changes", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "mousedown", + "type" : "function", + "desc" : "The raw mousedown event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "mouseout", + "type" : "function", + "desc" : "The raw mouseout event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "mouseover", + "type" : "function", + "desc" : "The raw mouseover event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "mouseup", + "type" : "function", + "desc" : "The raw mouseup event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires when the grid is rendered", + "sig" : "function (grid)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "rowclass", + "type" : "function", + "desc" : "Fires when a row is rendered, so you can change add a style to it.", + "sig" : "function (gridview, rowcfg)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "rowclick", + "type" : "function", + "desc" : "Fires when a row is clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "rowcontextmenu", + "type" : "function", + "desc" : "Fires when a row is right clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "rowdblclick", + "type" : "function", + "desc" : "Fires when a row is double clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Fires when a date is selected", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "startdrag", + "type" : "function", + "desc" : "Fires when row(s) start being dragged", + "sig" : "function (_self, dd, e)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "getSelectionModel", + "type" : "function", + "desc" : "Returns the grid's SelectionModel.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.grid.CellSelectionModel" : { + "props" : [ + { + "name" : "enter_is_tab", + "type" : "Boolean", + "desc" : "Enter behaves the same as tab. (eg. goes to next cell) default: false", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "beforeeditnext", + "type" : "function", + "desc" : "Fires before the next editable sell is made active\nYou can use this to skip to another cell or fire the tabend\n if you set cell to false", + "sig" : "function (eventdata)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforerowselect", + "type" : "function", + "desc" : "Fires before a cell is selected.", + "sig" : "function (_self, rowIndex, colIndex)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "cellselect", + "type" : "function", + "desc" : "Fires when a cell is selected.", + "sig" : "function (_self, rowIndex, colIndex)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "selectionchange", + "type" : "function", + "desc" : "Fires when the active selection changes.", + "sig" : "function (_self, selection)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "tabend", + "type" : "function", + "desc" : "Fires when the tab (or enter) was pressed on the last editable cell\nYou can use this to trigger add new row.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearSelections", + "type" : "function", + "desc" : "Clears all selections.", + "sig" : "(true)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getSelectedCell", + "type" : "function", + "desc" : "Returns the currently selected cell,.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hasSelection", + "type" : "function", + "desc" : "Returns true if there is a selection.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isLocked", + "type" : "function", + "desc" : "Returns true if the selections are locked.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel" + }, + { + "name" : "lock", + "type" : "function", + "desc" : "Locks the selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "onEditorKey", + "type" : "function", + "desc" : "Selects a cell.", + "sig" : "(field, e)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Selects a cell.", + "sig" : "(rowIndex, collIndex)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unlock", + "type" : "function", + "desc" : "Unlocks the selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel" + } + ] + }, + "Roo.grid.ColumnModel" : { + "props" : [ + { + "name" : "align", + "type" : "String", + "desc" : "(Optional) Set the CSS text-align property of the column. Defaults to undefined.", + "memberOf" : "" + }, + { + "name" : "cursor", + "type" : "String", + "desc" : "(Optional)", + "memberOf" : "" + }, + { + "name" : "dataIndex", + "type" : "String", + "desc" : "(Optional) The name of the field in the grid's {@link Roo.data.Store}'s\n{@link Roo.data.Record} definition from which to draw the column's value. If not\nspecified, the column's index is used as an index into the Record's data Array.", + "memberOf" : "" + }, + { + "name" : "editor", + "type" : "Roo.grid.GridEditor", + "desc" : "(Optional) For grid editors - returns the grid editor", + "memberOf" : "" + }, + { + "name" : "fixed", + "type" : "Boolean", + "desc" : "(Optional) True if the column width cannot be changed. Defaults to false.", + "memberOf" : "" + }, + { + "name" : "header", + "type" : "String", + "desc" : "The header text to display in the Grid view.", + "memberOf" : "" + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "(Optional) True to hide the column. Defaults to false.", + "memberOf" : "" + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "(Optional)", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "locked", + "type" : "Boolean", + "desc" : "(Optional) True to lock the column in place while scrolling the Grid. Defaults to false.", + "memberOf" : "" + }, + { + "name" : "md", + "type" : "Number", + "desc" : "(Optional)", + "memberOf" : "" + }, + { + "name" : "renderer", + "type" : "Function", + "desc" : "(Optional) A function used to generate HTML markup for a cell\ngiven the cell's data value. See {@link #setRenderer}. If not specified, the\ndefault renderer returns the escaped data value. If an object is returned (bootstrap only)\nthen it is treated as a Roo Component object instance, and it is rendered after the initial row is rendered", + "memberOf" : "" + }, + { + "name" : "resizable", + "type" : "Boolean", + "desc" : "(Optional) False to disable column resizing. Defaults to true.", + "memberOf" : "" + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "(Optional)", + "memberOf" : "" + }, + { + "name" : "sortable", + "type" : "Boolean", + "desc" : "(Optional) True if sorting is to be allowed on this column.\nDefaults to the value of the {@link #defaultSortable} property.\nWhether local/remote sorting is used is specified in {@link Roo.data.Store#remoteSort}.", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "String", + "desc" : "(Optional)", + "memberOf" : "" + }, + { + "name" : "valign", + "type" : "String", + "desc" : "(Optional) Set the CSS vertical-align property of the column (eg. middle, top, bottom etc). Defaults to undefined.", + "memberOf" : "" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "(Optional) The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.", + "memberOf" : "" + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "(Optional)", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "columlockchange", + "type" : "function", + "desc" : "Fires when a column's locked state is changed", + "sig" : "function (_self, colIndex, locked)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "columnmoved", + "type" : "function", + "desc" : "Fires when a column is moved.", + "sig" : "function (_self, oldIndex, newIndex)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "headerchange", + "type" : "function", + "desc" : "Fires when the text of a header changes.", + "sig" : "function (_self, columnIndex, newText)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "hiddenchange", + "type" : "function", + "desc" : "Fires when a column is hidden or \"unhidden\".", + "sig" : "function (_self, columnIndex, hidden)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "widthchange", + "type" : "function", + "desc" : "Fires when the width of a column changes.", + "sig" : "function (_self, columnIndex, newWidth)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "findColumnIndex", + "type" : "function", + "desc" : "Returns the index for a specified column dataIndex.", + "sig" : "(dataIndex)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getCellEditor", + "type" : "function", + "desc" : "Returns the editor defined for the cell/column.\nreturn false or null to disable editing.", + "sig" : "(colIndex, rowIndex)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getColumnByDataIndex", + "type" : "function", + "desc" : "Returns the column for a specified dataIndex.", + "sig" : "(dataIndex)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getColumnById", + "type" : "function", + "desc" : "Returns the column for a specified id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getColumnCount", + "type" : "function", + "desc" : "Returns the number of columns.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getColumnHeader", + "type" : "function", + "desc" : "Returns the header for the specified column.", + "sig" : "(col)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getColumnId", + "type" : "function", + "desc" : "Returns the id of the column at the specified index.", + "sig" : "(index)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getColumnTooltip", + "type" : "function", + "desc" : "Returns the tooltip for the specified column.", + "sig" : "(col)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getColumnWidth", + "type" : "function", + "desc" : "Returns the width for the specified column.", + "sig" : "(col)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getColumnsBy", + "type" : "function", + "desc" : "Returns the column configs that return true by the passed function that is called with (columnConfig, index)", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getDataIndex", + "type" : "function", + "desc" : "Returns the dataIndex for the specified column.", + "sig" : "(col)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getIndexById", + "type" : "function", + "desc" : "Returns the index for a specified column id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getRenderer", + "type" : "function", + "desc" : "Returns the rendering (formatting) function defined for the column.", + "sig" : "(col)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getTotalWidth", + "type" : "function", + "desc" : "Returns the total width of all columns.", + "sig" : "(includeHidden)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "isCellEditable", + "type" : "function", + "desc" : "Returns true if the cell is editable.", + "sig" : "(colIndex, rowIndex)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isFixed", + "type" : "function", + "desc" : "Returns true if the column width cannot be changed", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isHidden", + "type" : "function", + "desc" : "Returns true if the column is hidden.", + "sig" : "(colIndex)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isResizable", + "type" : "function", + "desc" : "Returns true if the column can be resized", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isSortable", + "type" : "function", + "desc" : "Returns true if the specified column is sortable.", + "sig" : "(col)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "setColumnHeader", + "type" : "function", + "desc" : "Sets the header for a column.", + "sig" : "(col, header)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setColumnTooltip", + "type" : "function", + "desc" : "Sets the tooltip for a column.", + "sig" : "(col, tooltip)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setColumnWidth", + "type" : "function", + "desc" : "Sets the width for a column.", + "sig" : "(col, width)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setDataIndex", + "type" : "function", + "desc" : "Sets the dataIndex for a column.", + "sig" : "(col, dataIndex)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setEditable", + "type" : "function", + "desc" : "Sets if a column is editable.", + "sig" : "(col, editable)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setEditor", + "type" : "function", + "desc" : "Sets the editor for a column.", + "sig" : "(col, editor)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setHidden", + "type" : "function", + "desc" : "Sets if a column is hidden.", + "sig" : "(colIndex, hidden)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setRenderer", + "type" : "function", + "desc" : "Sets the rendering (formatting) function for a column.", + "sig" : "(col, fn)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.grid.EditorGrid" : { + "props" : [ + { + "name" : "autoExpandColumn", + "type" : "String", + "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "autoExpandMax", + "type" : "Number", + "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "autoExpandMin", + "type" : "Number", + "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "autoHeight", + "type" : "Boolean", + "desc" : "True to fit the height of the grid container to the height of the data. Default is false.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "autoSizeColumns", + "type" : "Boolean", + "desc" : "True to automatically resize the columns to fit their content\non initial render. It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "autoSizeHeaders", + "type" : "Boolean", + "desc" : "True to measure headers with column data when auto sizing columns. Default is true.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "autoWidth", + "type" : "Boolean", + "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "clicksToEdit", + "type" : "Number", + "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)", + "memberOf" : "" + }, + { + "name" : "ddGroup", + "type" : "String", + "desc" : "- drag drop group.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "dropTarget", + "type" : "Roo.dd.DropTarget", + "desc" : "An {@link Roo.dd.DropTarget} config", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "enableColumnHide", + "type" : "Boolean", + "desc" : "True to enable hiding of columns with the header context menu. Default is true.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "enableColumnMove", + "type" : "Boolean", + "desc" : "True to enable drag and drop reorder of columns. Default is true.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "enableDrag", + "type" : "Boolean", + "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "enableDragDrop", + "type" : "Boolean", + "desc" : "True to enable drag and drop of rows. Default is false.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "enableRowHeightSync", + "type" : "Boolean", + "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadMask", + "type" : "Object", + "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "maxHeight", + "type" : "Number", + "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "maxRowsToMeasure", + "type" : "Boolean", + "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "minColumnWidth", + "type" : "Number", + "desc" : "The minimum width a column can be resized to. Default is 25.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "monitorWindowResize", + "type" : "Boolean", + "desc" : "True to autoSize the grid when the window resizes. Default is true.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "stripeRows", + "type" : "Boolean", + "desc" : "True to stripe the rows. Default is true.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "trackMouseOver", + "type" : "Boolean", + "desc" : "True to highlight rows when the mouse is over. Default is true.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "view", + "type" : "Object", + "desc" : "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().", + "memberOf" : "Roo.grid.Grid" + } + ], + "events" : [ + { + "name" : "afteredit", + "type" : "function", + "desc" : "Fires after a cell is edited.
\n", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeedit", + "type" : "function", + "desc" : "Fires before cell editing is triggered. The edit event object has the following properties
\n", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "bodyscroll", + "type" : "function", + "desc" : "Fires when the body element is scrolled", + "sig" : "function (scrollLeft, scrollTop)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "cellclick", + "type" : "function", + "desc" : "Fires when a cell is clicked", + "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "cellcontextmenu", + "type" : "function", + "desc" : "Fires when a cell is right clicked", + "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "celldblclick", + "type" : "function", + "desc" : "Fires when a cell is double clicked", + "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "click", + "type" : "function", + "desc" : "The raw click event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "columnmove", + "type" : "function", + "desc" : "Fires when the user moves a column", + "sig" : "function (oldIndex, newIndex)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "columnresize", + "type" : "function", + "desc" : "Fires when the user resizes a column", + "sig" : "function (columnIndex, newSize)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "contextmenu", + "type" : "function", + "desc" : "The raw contextmenu event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "dblclick", + "type" : "function", + "desc" : "The raw dblclick event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "dragdrop", + "type" : "function", + "desc" : "Fires when dragged row(s) are dropped on a valid DD target", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "dragenter", + "type" : "function", + "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "dragout", + "type" : "function", + "desc" : "Fires when the dragged row(s) leave another DD target while being dragged", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "dragover", + "type" : "function", + "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "enddrag", + "type" : "function", + "desc" : "Fires when a drag operation is complete", + "sig" : "function (_self, dd, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "headerclick", + "type" : "function", + "desc" : "Fires when a header is clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "headercontextmenu", + "type" : "function", + "desc" : "Fires when a header is right clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "headerdblclick", + "type" : "function", + "desc" : "Fires when a header cell is double clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "keydown", + "type" : "function", + "desc" : "The raw keydown event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "keypress", + "type" : "function", + "desc" : "The raw keypress event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "mousedown", + "type" : "function", + "desc" : "The raw mousedown event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "mouseout", + "type" : "function", + "desc" : "The raw mouseout event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "mouseover", + "type" : "function", + "desc" : "The raw mouseover event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "mouseup", + "type" : "function", + "desc" : "The raw mouseup event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires when the grid is rendered", + "sig" : "function (grid)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "rowclass", + "type" : "function", + "desc" : "Fires when a row is rendered, so you can change add a style to it.", + "sig" : "function (gridview, rowcfg)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "rowclick", + "type" : "function", + "desc" : "Fires when a row is clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "rowcontextmenu", + "type" : "function", + "desc" : "Fires when a row is right clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "rowdblclick", + "type" : "function", + "desc" : "Fires when a row is double clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "startdrag", + "type" : "function", + "desc" : "Fires when row(s) start being dragged", + "sig" : "function (_self, dd, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "validateedit", + "type" : "function", + "desc" : "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties
\n", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroy this grid.", + "sig" : "(removeEl)", + "static" : false, + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getColumnModel", + "type" : "function", + "desc" : "Returns the grid's ColumnModel.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "getDataSource", + "type" : "function", + "desc" : "Returns the grid's DataSource.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "getDragDropText", + "type" : "function", + "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getGridEl", + "type" : "function", + "desc" : "Returns the grid's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "getSelectionModel", + "type" : "function", + "desc" : "Returns the grid's SelectionModel.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "getView", + "type" : "function", + "desc" : "Returns the grid's GridView object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "reconfigure", + "type" : "function", + "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.", + "sig" : "(dataSource, The)", + "static" : false, + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "startEditing", + "type" : "function", + "desc" : "Starts editing the specified for the specified row/column", + "sig" : "(rowIndex, colIndex)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "stopEditing", + "type" : "function", + "desc" : "Stops any active editing", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.grid.Grid" : { + "props" : [ + { + "name" : "autoExpandColumn", + "type" : "String", + "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.", + "memberOf" : "" + }, + { + "name" : "autoExpandMax", + "type" : "Number", + "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.", + "memberOf" : "" + }, + { + "name" : "autoExpandMin", + "type" : "Number", + "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.", + "memberOf" : "" + }, + { + "name" : "autoHeight", + "type" : "Boolean", + "desc" : "True to fit the height of the grid container to the height of the data. Default is false.", + "memberOf" : "" + }, + { + "name" : "autoSizeColumns", + "type" : "Boolean", + "desc" : "True to automatically resize the columns to fit their content\non initial render. It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.", + "memberOf" : "" + }, + { + "name" : "autoSizeHeaders", + "type" : "Boolean", + "desc" : "True to measure headers with column data when auto sizing columns. Default is true.", + "memberOf" : "" + }, + { + "name" : "autoWidth", + "type" : "Boolean", + "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.", + "memberOf" : "" + }, + { + "name" : "ddGroup", + "type" : "String", + "desc" : "- drag drop group.", + "memberOf" : "" + }, + { + "name" : "dropTarget", + "type" : "Roo.dd.DropTarget", + "desc" : "An {@link Roo.dd.DropTarget} config", + "memberOf" : "" + }, + { + "name" : "enableColumnHide", + "type" : "Boolean", + "desc" : "True to enable hiding of columns with the header context menu. Default is true.", + "memberOf" : "" + }, + { + "name" : "enableColumnMove", + "type" : "Boolean", + "desc" : "True to enable drag and drop reorder of columns. Default is true.", + "memberOf" : "" + }, + { + "name" : "enableDrag", + "type" : "Boolean", + "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)", + "memberOf" : "" + }, + { + "name" : "enableDragDrop", + "type" : "Boolean", + "desc" : "True to enable drag and drop of rows. Default is false.", + "memberOf" : "" + }, + { + "name" : "enableRowHeightSync", + "type" : "Boolean", + "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadMask", + "type" : "Object", + "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.", + "memberOf" : "" + }, + { + "name" : "maxHeight", + "type" : "Number", + "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.", + "memberOf" : "" + }, + { + "name" : "maxRowsToMeasure", + "type" : "Boolean", + "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).", + "memberOf" : "" + }, + { + "name" : "minColumnWidth", + "type" : "Number", + "desc" : "The minimum width a column can be resized to. Default is 25.", + "memberOf" : "" + }, + { + "name" : "monitorWindowResize", + "type" : "Boolean", + "desc" : "True to autoSize the grid when the window resizes. Default is true.", + "memberOf" : "" + }, + { + "name" : "stripeRows", + "type" : "Boolean", + "desc" : "True to stripe the rows. Default is true.", + "memberOf" : "" + }, + { + "name" : "trackMouseOver", + "type" : "Boolean", + "desc" : "True to highlight rows when the mouse is over. Default is true.", + "memberOf" : "" + }, + { + "name" : "view", + "type" : "Object", + "desc" : "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "bodyscroll", + "type" : "function", + "desc" : "Fires when the body element is scrolled", + "sig" : "function (scrollLeft, scrollTop)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "cellclick", + "type" : "function", + "desc" : "Fires when a cell is clicked", + "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "cellcontextmenu", + "type" : "function", + "desc" : "Fires when a cell is right clicked", + "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "celldblclick", + "type" : "function", + "desc" : "Fires when a cell is double clicked", + "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "click", + "type" : "function", + "desc" : "The raw click event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "columnmove", + "type" : "function", + "desc" : "Fires when the user moves a column", + "sig" : "function (oldIndex, newIndex)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "columnresize", + "type" : "function", + "desc" : "Fires when the user resizes a column", + "sig" : "function (columnIndex, newSize)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "contextmenu", + "type" : "function", + "desc" : "The raw contextmenu event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "dblclick", + "type" : "function", + "desc" : "The raw dblclick event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "dragdrop", + "type" : "function", + "desc" : "Fires when dragged row(s) are dropped on a valid DD target", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "dragenter", + "type" : "function", + "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "dragout", + "type" : "function", + "desc" : "Fires when the dragged row(s) leave another DD target while being dragged", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "dragover", + "type" : "function", + "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "enddrag", + "type" : "function", + "desc" : "Fires when a drag operation is complete", + "sig" : "function (_self, dd, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "headerclick", + "type" : "function", + "desc" : "Fires when a header is clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "headercontextmenu", + "type" : "function", + "desc" : "Fires when a header is right clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "headerdblclick", + "type" : "function", + "desc" : "Fires when a header cell is double clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "keydown", + "type" : "function", + "desc" : "The raw keydown event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "keypress", + "type" : "function", + "desc" : "The raw keypress event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "mousedown", + "type" : "function", + "desc" : "The raw mousedown event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "mouseout", + "type" : "function", + "desc" : "The raw mouseout event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "mouseover", + "type" : "function", + "desc" : "The raw mouseover event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "mouseup", + "type" : "function", + "desc" : "The raw mouseup event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires when the grid is rendered", + "sig" : "function (grid)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "rowclass", + "type" : "function", + "desc" : "Fires when a row is rendered, so you can change add a style to it.", + "sig" : "function (gridview, rowcfg)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "rowclick", + "type" : "function", + "desc" : "Fires when a row is clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "rowcontextmenu", + "type" : "function", + "desc" : "Fires when a row is right clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "rowdblclick", + "type" : "function", + "desc" : "Fires when a row is double clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "startdrag", + "type" : "function", + "desc" : "Fires when row(s) start being dragged", + "sig" : "function (_self, dd, e)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroy this grid.", + "sig" : "(removeEl)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getColumnModel", + "type" : "function", + "desc" : "Returns the grid's ColumnModel.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getDataSource", + "type" : "function", + "desc" : "Returns the grid's DataSource.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getDragDropText", + "type" : "function", + "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getGridEl", + "type" : "function", + "desc" : "Returns the grid's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getSelectionModel", + "type" : "function", + "desc" : "Returns the grid's SelectionModel.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getView", + "type" : "function", + "desc" : "Returns the grid's GridView object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "reconfigure", + "type" : "function", + "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.", + "sig" : "(dataSource, The)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.grid.GridEditor" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "alignment", + "type" : "String", + "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"c-c?\").", + "memberOf" : "Roo.Editor" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autosize", + "type" : "Boolean/String", + "desc" : "True for the editor to automatically adopt the size of the underlying field, \"width\" to adopt the width only,\nor \"height\" to adopt the height only (defaults to false)", + "memberOf" : "Roo.Editor" + }, + { + "name" : "cancelOnEsc", + "type" : "Boolean", + "desc" : "True to cancel the edit when the escape key is pressed (defaults to false)", + "memberOf" : "Roo.Editor" + }, + { + "name" : "completeOnEnter", + "type" : "Boolean", + "desc" : "True to complete the edit when the enter key is pressed (defaults to false)", + "memberOf" : "Roo.Editor" + }, + { + "name" : "constrain", + "type" : "Boolean", + "desc" : "True to constrain the editor to the viewport", + "memberOf" : "Roo.Editor" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "field", + "type" : "Roo.form.Field", + "desc" : "Field to wrap (or xtyped)", + "memberOf" : "" + }, + { + "name" : "hideEl", + "type" : "Boolean", + "desc" : "False to keep the bound element visible while the editor is displayed (defaults to true)", + "memberOf" : "Roo.Editor" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "ignoreNoChange", + "type" : "Boolean", + "desc" : "True to skip the the edit completion process (no save, no events fired) if the user completes an edit and\nthe value has not changed (defaults to false). Applies only to string values - edits for other data types\nwill never be ignored.", + "memberOf" : "Roo.Editor" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "revertInvalid", + "type" : "Boolean", + "desc" : "True to automatically revert the field value and cancel the edit when the user completes an edit and the field\nvalidation fails (defaults to true)", + "memberOf" : "Roo.Editor" + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "\"sides\" for sides/bottom only, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"frame\")", + "memberOf" : "Roo.Editor" + }, + { + "name" : "updateEl", + "type" : "Boolean", + "desc" : "True to update the innerHTML of the bound element when the update completes (defaults to false)", + "memberOf" : "Roo.Editor" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The data value of the underlying field (defaults to \"\")", + "memberOf" : "Roo.Editor" + } + ], + "events" : [ + { + "name" : "beforecomplete", + "type" : "function", + "desc" : "Fires after a change has been made to the field, but before the change is reflected in the underlying\nfield. Saving the change to the field can be canceled by returning false from the handler of this event.\nNote that if the value has not changed and ignoreNoChange = true, the editing will still end but this\nevent will not fire since no edit actually occurred.", + "sig" : "function (_self, value, startValue)\n{\n\n}", + "memberOf" : "Roo.Editor" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforestartedit", + "type" : "function", + "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.", + "sig" : "function (_self, boundEl, value)\n{\n\n}", + "memberOf" : "Roo.Editor" + }, + { + "name" : "complete", + "type" : "function", + "desc" : "Fires after editing is complete and any changed value has been written to the underlying field.", + "sig" : "function (_self, value, startValue)\n{\n\n}", + "memberOf" : "Roo.Editor" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.Editor" + }, + { + "name" : "startedit", + "type" : "function", + "desc" : "Fires when this editor is displayed", + "sig" : "function (boundEl, value)\n{\n\n}", + "memberOf" : "Roo.Editor" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "cancelEdit", + "type" : "function", + "desc" : "Cancels the editing process and hides the editor without persisting any changes. The field value will be\nreverted to the original starting value.", + "sig" : "(remainVisible)", + "static" : false, + "memberOf" : "Roo.Editor" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "completeEdit", + "type" : "function", + "desc" : "Ends the editing process, persists the changed value to the underlying field, and hides the editor.", + "sig" : "(remainVisible)", + "static" : false, + "memberOf" : "Roo.Editor" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Gets the data value of the editor", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Editor" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "realign", + "type" : "function", + "desc" : "Realigns the editor to the bound field based on the current alignment config value.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Editor" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the height and width of this editor.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.Editor" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets the data value of the editor", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.Editor" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "startEdit", + "type" : "function", + "desc" : "Starts the editing process and shows the editor.", + "sig" : "(el, value)", + "static" : false, + "memberOf" : "Roo.Editor" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.grid.GridView" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "autoSizeColumn", + "type" : "function", + "desc" : "Autofit a column to its content.", + "sig" : "(colIndex, forceMinSize)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "autoSizeColumns", + "type" : "function", + "desc" : "Autofits all columns to their content and then expands to fit any extra space in the grid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "ensureVisible", + "type" : "function", + "desc" : "Scrolls the specified cell into view", + "sig" : "(row, col, hscroll)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "fitColumns", + "type" : "function", + "desc" : "Autofits all columns to the grid's width proportionate with their current size", + "sig" : "(reserveScrollSpace)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "focusCell", + "type" : "function", + "desc" : "Focuses the specified cell.", + "sig" : "(row, col, hscroll)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "focusRow", + "type" : "function", + "desc" : "Focuses the specified row.", + "sig" : "(row)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getCell", + "type" : "function", + "desc" : "Gets the 'td' of the cell", + "sig" : "(rowIndex, colIndex)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getFooterPanel", + "type" : "function", + "desc" : "Gets a panel in the footer of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.", + "sig" : "(doShow)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getHeaderPanel", + "type" : "function", + "desc" : "Gets a panel in the header of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.", + "sig" : "(doShow)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "refresh", + "type" : "function", + "desc" : "Refreshes the grid", + "sig" : "(headersToo)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "scrollToTop", + "type" : "function", + "desc" : "Scrolls the grid to the top", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.grid.PropertyGrid" : { + "props" : [ + { + "name" : "autoExpandColumn", + "type" : "String", + "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "autoExpandMax", + "type" : "Number", + "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "autoExpandMin", + "type" : "Number", + "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "autoHeight", + "type" : "Boolean", + "desc" : "True to fit the height of the grid container to the height of the data. Default is false.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "autoSizeColumns", + "type" : "Boolean", + "desc" : "True to automatically resize the columns to fit their content\non initial render. It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "autoSizeHeaders", + "type" : "Boolean", + "desc" : "True to measure headers with column data when auto sizing columns. Default is true.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "autoWidth", + "type" : "Boolean", + "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "clicksToEdit", + "type" : "Number", + "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)", + "memberOf" : "Roo.grid.EditorGrid" + }, + { + "name" : "customEditors", + "type" : "Object", + "desc" : "map of colnames=> custom editors.\nthe custom editor can be one of the standard ones (date|string|number|int|boolean), or a\ngrid editor eg. Roo.grid.GridEditor(new Roo.form.TextArea({selectOnFocus:true})),\nfalse disables editing of the field.", + "memberOf" : "" + }, + { + "name" : "ddGroup", + "type" : "String", + "desc" : "- drag drop group.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "dropTarget", + "type" : "Roo.dd.DropTarget", + "desc" : "An {@link Roo.dd.DropTarget} config", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "enableColumnHide", + "type" : "Boolean", + "desc" : "True to enable hiding of columns with the header context menu. Default is true.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "enableColumnMove", + "type" : "Boolean", + "desc" : "True to enable drag and drop reorder of columns. Default is true.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "enableDrag", + "type" : "Boolean", + "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "enableDragDrop", + "type" : "Boolean", + "desc" : "True to enable drag and drop of rows. Default is false.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "enableRowHeightSync", + "type" : "Boolean", + "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loadMask", + "type" : "Object", + "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "maxHeight", + "type" : "Number", + "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "maxRowsToMeasure", + "type" : "Boolean", + "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "minColumnWidth", + "type" : "Number", + "desc" : "The minimum width a column can be resized to. Default is 25.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "monitorWindowResize", + "type" : "Boolean", + "desc" : "True to autoSize the grid when the window resizes. Default is true.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "propertyNames", + "type" : "Object", + "desc" : "map of property Names to their displayed value", + "memberOf" : "" + }, + { + "name" : "stripeRows", + "type" : "Boolean", + "desc" : "True to stripe the rows. Default is true.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "trackMouseOver", + "type" : "Boolean", + "desc" : "True to highlight rows when the mouse is over. Default is true.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "view", + "type" : "Object", + "desc" : "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().", + "memberOf" : "Roo.grid.Grid" + } + ], + "events" : [ + { + "name" : "afteredit", + "type" : "function", + "desc" : "Fires after a cell is edited.
\n", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.EditorGrid" + }, + { + "name" : "beforeedit", + "type" : "function", + "desc" : "Fires before cell editing is triggered. The edit event object has the following properties
\n", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.EditorGrid" + }, + { + "name" : "beforepropertychange", + "type" : "function", + "desc" : "Fires before a property changes (return false to stop?)", + "sig" : "function (grid, id, newval, oldval)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "bodyscroll", + "type" : "function", + "desc" : "Fires when the body element is scrolled", + "sig" : "function (scrollLeft, scrollTop)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "cellclick", + "type" : "function", + "desc" : "Fires when a cell is clicked", + "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "cellcontextmenu", + "type" : "function", + "desc" : "Fires when a cell is right clicked", + "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "celldblclick", + "type" : "function", + "desc" : "Fires when a cell is double clicked", + "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "click", + "type" : "function", + "desc" : "The raw click event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "columnmove", + "type" : "function", + "desc" : "Fires when the user moves a column", + "sig" : "function (oldIndex, newIndex)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "columnresize", + "type" : "function", + "desc" : "Fires when the user resizes a column", + "sig" : "function (columnIndex, newSize)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "contextmenu", + "type" : "function", + "desc" : "The raw contextmenu event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "dblclick", + "type" : "function", + "desc" : "The raw dblclick event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "dragdrop", + "type" : "function", + "desc" : "Fires when dragged row(s) are dropped on a valid DD target", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "dragenter", + "type" : "function", + "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "dragout", + "type" : "function", + "desc" : "Fires when the dragged row(s) leave another DD target while being dragged", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "dragover", + "type" : "function", + "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "enddrag", + "type" : "function", + "desc" : "Fires when a drag operation is complete", + "sig" : "function (_self, dd, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "headerclick", + "type" : "function", + "desc" : "Fires when a header is clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "headercontextmenu", + "type" : "function", + "desc" : "Fires when a header is right clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "headerdblclick", + "type" : "function", + "desc" : "Fires when a header cell is double clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "keydown", + "type" : "function", + "desc" : "The raw keydown event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "keypress", + "type" : "function", + "desc" : "The raw keypress event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "mousedown", + "type" : "function", + "desc" : "The raw mousedown event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "mouseout", + "type" : "function", + "desc" : "The raw mouseout event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "mouseover", + "type" : "function", + "desc" : "The raw mouseover event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "mouseup", + "type" : "function", + "desc" : "The raw mouseup event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "propertychange", + "type" : "function", + "desc" : "Fires after a property changes", + "sig" : "function (grid, id, newval, oldval)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires when the grid is rendered", + "sig" : "function (grid)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "rowclass", + "type" : "function", + "desc" : "Fires when a row is rendered, so you can change add a style to it.", + "sig" : "function (gridview, rowcfg)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "rowclick", + "type" : "function", + "desc" : "Fires when a row is clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "rowcontextmenu", + "type" : "function", + "desc" : "Fires when a row is right clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "rowdblclick", + "type" : "function", + "desc" : "Fires when a row is double clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "startdrag", + "type" : "function", + "desc" : "Fires when row(s) start being dragged", + "sig" : "function (_self, dd, e)\n{\n\n}", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "validateedit", + "type" : "function", + "desc" : "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties
\n", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.grid.EditorGrid" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "autoSize", + "type" : "function", + "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroy this grid.", + "sig" : "(removeEl)", + "static" : false, + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getColumnModel", + "type" : "function", + "desc" : "Returns the grid's ColumnModel.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "getDataSource", + "type" : "function", + "desc" : "Returns the grid's DataSource.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "getDragDropText", + "type" : "function", + "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.EditorGrid" + }, + { + "name" : "getGridEl", + "type" : "function", + "desc" : "Returns the grid's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "getSelectionModel", + "type" : "function", + "desc" : "Returns the grid's SelectionModel.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "getSource", + "type" : "function", + "desc" : "Gets all the data from the grid.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getView", + "type" : "function", + "desc" : "Returns the grid's GridView object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "reconfigure", + "type" : "function", + "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.", + "sig" : "(dataSource, The)", + "static" : false, + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "setSource", + "type" : "function", + "desc" : "Sets the data for the Grid\naccepts a Key => Value object of all the elements avaiable.", + "sig" : "(data)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "startEditing", + "type" : "function", + "desc" : "Starts editing the specified for the specified row/column", + "sig" : "(rowIndex, colIndex)", + "static" : false, + "memberOf" : "Roo.grid.EditorGrid" + }, + { + "name" : "stopEditing", + "type" : "function", + "desc" : "Stops any active editing", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.EditorGrid" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.grid.RowSelectionModel" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "singleSelect", + "type" : "Boolean", + "desc" : "True to allow selection of only one row at a time (defaults to false)", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "afterselectionchange", + "type" : "function", + "desc" : "Fires after the selection changes (eg. by key press or clicking)", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforerowselect", + "type" : "function", + "desc" : "Fires when a row is selected being selected, return false to cancel.", + "sig" : "function (_self, rowIndex, keepExisting)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "rowdeselect", + "type" : "function", + "desc" : "Fires when a row is deselected.", + "sig" : "function (_self, rowIndex)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "rowselect", + "type" : "function", + "desc" : "Fires when a row is selected.", + "sig" : "function (_self, rowIndex, r)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "selectionchange", + "type" : "function", + "desc" : "Fires when the selection changes", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearSelections", + "type" : "function", + "desc" : "Clears all selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "deselectRange", + "type" : "function", + "desc" : "Deselects a range of rows. All rows in between startRow and endRow are also deselected.", + "sig" : "(startRow, endRow)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "deselectRow", + "type" : "function", + "desc" : "Deselects a row.", + "sig" : "(row)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getCount", + "type" : "function", + "desc" : "Gets the number of selected rows.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getSelected", + "type" : "function", + "desc" : "Returns the first selected record.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getSelections", + "type" : "function", + "desc" : "Returns the selected records", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hasSelection", + "type" : "function", + "desc" : "Returns True if there is a selection.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isIdSelected", + "type" : "function", + "desc" : "Returns True if the specified record id is selected.", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isLocked", + "type" : "function", + "desc" : "Returns true if the selections are locked.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel" + }, + { + "name" : "isSelected", + "type" : "function", + "desc" : "Returns True if the specified row is selected.", + "sig" : "(record)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "lock", + "type" : "function", + "desc" : "Locks the selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "selectAll", + "type" : "function", + "desc" : "Selects all rows.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectFirstRow", + "type" : "function", + "desc" : "Selects the first row in the grid.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectLastRow", + "type" : "function", + "desc" : "Select the last row.", + "sig" : "(keepExisting)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectNext", + "type" : "function", + "desc" : "Selects the row immediately following the last selected row.", + "sig" : "(keepExisting)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectPrevious", + "type" : "function", + "desc" : "Selects the row that precedes the last selected row.", + "sig" : "(keepExisting)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectRange", + "type" : "function", + "desc" : "Selects a range of rows. All rows in between startRow and endRow are also selected.", + "sig" : "(startRow, endRow, keepExisting)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectRecords", + "type" : "function", + "desc" : "Select records.", + "sig" : "(records, keepExisting)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectRow", + "type" : "function", + "desc" : "Selects a row.", + "sig" : "(row, keepExisting)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectRows", + "type" : "function", + "desc" : "Selects multiple rows.", + "sig" : "(rows, keepExisting)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unlock", + "type" : "function", + "desc" : "Unlocks the selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel" + } + ] + }, + "Roo.lib" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.lib.Ajax" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "request", + "type" : "function", + "desc" : "", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "" + } + ] + }, + "Roo.lib.Dom" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.menu" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.menu.Adapter" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "activeClass", + "type" : "String", + "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "canActivate", + "type" : "Boolean", + "desc" : "True if this item can be visually activated (defaults to false)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to prevent creation of this menu item (defaults to false)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hideDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hideOnClick", + "type" : "Boolean", + "desc" : "True to hide the containing menu after this item is clicked (defaults to true)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Fires when this item is activated", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when this item is clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "deactivate", + "type" : "function", + "desc" : "Fires when this item is deactivated", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.menu.BaseItem" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "activeClass", + "type" : "String", + "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "canActivate", + "type" : "Boolean", + "desc" : "True if this item can be visually activated (defaults to false)", + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", + "memberOf" : "" + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to prevent creation of this menu item (defaults to false)", + "memberOf" : "" + }, + { + "name" : "hideDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hideOnClick", + "type" : "Boolean", + "desc" : "True to hide the containing menu after this item is clicked (defaults to true)", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Fires when this item is activated", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when this item is clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "deactivate", + "type" : "function", + "desc" : "Fires when this item is deactivated", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.menu.CheckItem" : { + "props" : [ + { + "name" : "HTML", + "type" : "String", + "desc" : "to render in menu\nThe text to show on the menu item (HTML version).", + "memberOf" : "Roo.menu.Item" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "activeClass", + "type" : "String", + "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "canActivate", + "type" : "Boolean", + "desc" : "True if this item can be visually activated (defaults to true)", + "memberOf" : "Roo.menu.Item" + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "True to initialize this checkbox as checked (defaults to false). Note that\nif this checkbox is part of a radio group (group = true) only the last item in the group that is\ninitialized with checked = true will be rendered as checked.", + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "group", + "type" : "String", + "desc" : "All check items with the same group name will automatically be grouped into a single-select\nradio button group (defaults to '')", + "memberOf" : "" + }, + { + "name" : "groupClass", + "type" : "String", + "desc" : "The default CSS class to use for radio group check items (defaults to \"x-menu-group-item\")", + "memberOf" : "" + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to prevent creation of this menu item (defaults to false)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hideDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hideOnClick", + "type" : "Boolean", + "desc" : "True to hide the containing menu after this item is clicked (defaults to true)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "icon", + "type" : "String", + "desc" : "The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)", + "memberOf" : "Roo.menu.Item" + }, + { + "name" : "itemCls", + "type" : "String", + "desc" : "The default CSS class to use for check items (defaults to \"x-menu-item x-menu-check-item\")", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "showDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before showing this item (defaults to 200)", + "memberOf" : "Roo.menu.Item" + }, + { + "name" : "text", + "type" : "String", + "desc" : "The text to show on the menu item.", + "memberOf" : "Roo.menu.Item" + } + ], + "events" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Fires when this item is activated", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "beforecheckchange", + "type" : "function", + "desc" : "Fires before the checked value is set, providing an opportunity to cancel if needed", + "sig" : "function (_self, checked)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "checkchange", + "type" : "function", + "desc" : "Fires after the checked value has been set", + "sig" : "function (_self, checked)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when this item is clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "deactivate", + "type" : "function", + "desc" : "Fires when this item is deactivated", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setChecked", + "type" : "function", + "desc" : "Set the checked state of this item", + "sig" : "(checked, suppressEvent)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setText", + "type" : "function", + "desc" : "Sets the text to display in this menu item", + "sig" : "(text, isHTML)", + "static" : false, + "memberOf" : "Roo.menu.Item" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.menu.ColorItem" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "activeClass", + "type" : "String", + "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "canActivate", + "type" : "Boolean", + "desc" : "True if this item can be visually activated (defaults to false)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to prevent creation of this menu item (defaults to false)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hideDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hideOnClick", + "type" : "Boolean", + "desc" : "True to hide the containing menu after this item is clicked (defaults to true)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Fires when this item is activated", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when this item is clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "deactivate", + "type" : "function", + "desc" : "Fires when this item is deactivated", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.menu.ColorMenu" : { + "props" : [ + { + "name" : "allowOtherMenus", + "type" : "Boolean", + "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "defaultAlign", + "type" : "String", + "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum width of the menu in pixels (defaults to 120)", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "registerMenu", + "type" : "Boolean", + "desc" : "True (default) - means that clicking on screen etc. hides it.", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "subMenuAlign", + "type" : "String", + "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")", + "memberOf" : "Roo.menu.Menu" + } + ], + "events" : [ + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before this menu is hidden", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before this menu is displayed", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", + "sig" : "function (_self, menuItem, e)\n{\n\n}", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after this menu is hidden", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "itemclick", + "type" : "function", + "desc" : "Fires when a menu item contained in this menu is clicked", + "sig" : "function (baseItem, e)\n{\n\n}", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "mouseout", + "type" : "function", + "desc" : "Fires when the mouse exits this menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "mouseover", + "type" : "function", + "desc" : "Fires when the mouse is hovering over this menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "select", + "type" : "function", + "desc" : "", + "sig" : "function (palette, color)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after this menu is displayed", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.Menu" + } + ], + "methods" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n\nUsage:\n
\n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n    menuItem,                // add existing item by ref\n    'Dynamic Item',          // new TextItem\n    '-',                     // new separator\n    { text: 'Config Item' }  // new item by config\n);\n
", + "sig" : "(args)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "addElement", + "type" : "function", + "desc" : "Adds an {@link Roo.Element} object to the menu", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addItem", + "type" : "function", + "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu", + "sig" : "(item)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addMenuItem", + "type" : "function", + "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu", + "sig" : "(config)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "addSeparator", + "type" : "function", + "desc" : "Adds a separator bar to the menu", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "addText", + "type" : "function", + "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu", + "sig" : "(text)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns this menu's underlying {@link Roo.Element} object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hides this menu and optionally all parent menus", + "sig" : "(deep)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "insert", + "type" : "function", + "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index", + "sig" : "(index, item)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Read-only. Returns true if the menu is currently displayed, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object", + "sig" : "(item)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "removeAll", + "type" : "function", + "desc" : "Removes and destroys all items in the menu", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Displays this menu relative to another element", + "sig" : "(element, position, parentMenu)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "showAt", + "type" : "function", + "desc" : "Displays this menu at a specific xy position", + "sig" : "(xyPosition, parentMenu)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.menu.DateItem" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "activeClass", + "type" : "String", + "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "canActivate", + "type" : "Boolean", + "desc" : "True if this item can be visually activated (defaults to false)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to prevent creation of this menu item (defaults to false)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hideDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hideOnClick", + "type" : "Boolean", + "desc" : "True to hide the containing menu after this item is clicked (defaults to true)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Fires when this item is activated", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when this item is clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "deactivate", + "type" : "function", + "desc" : "Fires when this item is deactivated", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.menu.DateMenu" : { + "props" : [ + { + "name" : "allowOtherMenus", + "type" : "Boolean", + "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "defaultAlign", + "type" : "String", + "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum width of the menu in pixels (defaults to 120)", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "registerMenu", + "type" : "Boolean", + "desc" : "True (default) - means that clicking on screen etc. hides it.", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "subMenuAlign", + "type" : "String", + "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")", + "memberOf" : "Roo.menu.Menu" + } + ], + "events" : [ + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before this menu is hidden", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before this menu is displayed", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", + "sig" : "function (_self, menuItem, e)\n{\n\n}", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after this menu is hidden", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "itemclick", + "type" : "function", + "desc" : "Fires when a menu item contained in this menu is clicked", + "sig" : "function (baseItem, e)\n{\n\n}", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "mouseout", + "type" : "function", + "desc" : "Fires when the mouse exits this menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "mouseover", + "type" : "function", + "desc" : "Fires when the mouse is hovering over this menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "select", + "type" : "function", + "desc" : "", + "sig" : "function (picker, date)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after this menu is displayed", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.Menu" + } + ], + "methods" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n\nUsage:\n
\n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n    menuItem,                // add existing item by ref\n    'Dynamic Item',          // new TextItem\n    '-',                     // new separator\n    { text: 'Config Item' }  // new item by config\n);\n
", + "sig" : "(args)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "addElement", + "type" : "function", + "desc" : "Adds an {@link Roo.Element} object to the menu", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addItem", + "type" : "function", + "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu", + "sig" : "(item)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addMenuItem", + "type" : "function", + "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu", + "sig" : "(config)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "addSeparator", + "type" : "function", + "desc" : "Adds a separator bar to the menu", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "addText", + "type" : "function", + "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu", + "sig" : "(text)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns this menu's underlying {@link Roo.Element} object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hides this menu and optionally all parent menus", + "sig" : "(deep)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "insert", + "type" : "function", + "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index", + "sig" : "(index, item)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Read-only. Returns true if the menu is currently displayed, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object", + "sig" : "(item)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "removeAll", + "type" : "function", + "desc" : "Removes and destroys all items in the menu", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Displays this menu relative to another element", + "sig" : "(element, position, parentMenu)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "showAt", + "type" : "function", + "desc" : "Displays this menu at a specific xy position", + "sig" : "(xyPosition, parentMenu)", + "static" : false, + "memberOf" : "Roo.menu.Menu" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.menu.Item" : { + "props" : [ + { + "name" : "HTML", + "type" : "String", + "desc" : "to render in menu\nThe text to show on the menu item (HTML version).", + "memberOf" : "" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "activeClass", + "type" : "String", + "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "canActivate", + "type" : "Boolean", + "desc" : "True if this item can be visually activated (defaults to true)", + "memberOf" : "" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to prevent creation of this menu item (defaults to false)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hideDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hideOnClick", + "type" : "Boolean", + "desc" : "True to hide the containing menu after this item is clicked (defaults to true)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "icon", + "type" : "String", + "desc" : "The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)", + "memberOf" : "" + }, + { + "name" : "itemCls", + "type" : "String", + "desc" : "The default CSS class to use for menu items (defaults to \"x-menu-item\")", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "showDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before showing this item (defaults to 200)", + "memberOf" : "" + }, + { + "name" : "text", + "type" : "String", + "desc" : "The text to show on the menu item.", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Fires when this item is activated", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when this item is clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "deactivate", + "type" : "function", + "desc" : "Fires when this item is deactivated", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setText", + "type" : "function", + "desc" : "Sets the text to display in this menu item", + "sig" : "(text, isHTML)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.menu.Menu" : { + "props" : [ + { + "name" : "allowOtherMenus", + "type" : "Boolean", + "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)", + "memberOf" : "" + }, + { + "name" : "defaultAlign", + "type" : "String", + "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum width of the menu in pixels (defaults to 120)", + "memberOf" : "" + }, + { + "name" : "registerMenu", + "type" : "Boolean", + "desc" : "True (default) - means that clicking on screen etc. hides it.", + "memberOf" : "" + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")", + "memberOf" : "" + }, + { + "name" : "subMenuAlign", + "type" : "String", + "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before this menu is hidden", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before this menu is displayed", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", + "sig" : "function (_self, menuItem, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after this menu is hidden", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "itemclick", + "type" : "function", + "desc" : "Fires when a menu item contained in this menu is clicked", + "sig" : "function (baseItem, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "mouseout", + "type" : "function", + "desc" : "Fires when the mouse exits this menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "mouseover", + "type" : "function", + "desc" : "Fires when the mouse is hovering over this menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after this menu is displayed", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n\nUsage:\n
\n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n    menuItem,                // add existing item by ref\n    'Dynamic Item',          // new TextItem\n    '-',                     // new separator\n    { text: 'Config Item' }  // new item by config\n);\n
", + "sig" : "(args)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addElement", + "type" : "function", + "desc" : "Adds an {@link Roo.Element} object to the menu", + "sig" : "(el)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addItem", + "type" : "function", + "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu", + "sig" : "(item)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addMenuItem", + "type" : "function", + "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu", + "sig" : "(config)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addSeparator", + "type" : "function", + "desc" : "Adds a separator bar to the menu", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addText", + "type" : "function", + "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu", + "sig" : "(text)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns this menu's underlying {@link Roo.Element} object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hides this menu and optionally all parent menus", + "sig" : "(deep)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "insert", + "type" : "function", + "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index", + "sig" : "(index, item)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Read-only. Returns true if the menu is currently displayed, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object", + "sig" : "(item)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeAll", + "type" : "function", + "desc" : "Removes and destroys all items in the menu", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Displays this menu relative to another element", + "sig" : "(element, position, parentMenu)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "showAt", + "type" : "function", + "desc" : "Displays this menu at a specific xy position", + "sig" : "(xyPosition, parentMenu)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.menu.MenuMgr" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "get", + "type" : "function", + "desc" : "Returns a {@link Roo.menu.Menu} object", + "sig" : "(menu)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hideAll", + "type" : "function", + "desc" : "Hides all menus that are currently visible", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.menu.Separator" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "activeClass", + "type" : "String", + "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "canActivate", + "type" : "Boolean", + "desc" : "True if this item can be visually activated (defaults to false)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to prevent creation of this menu item (defaults to false)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hideDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hideOnClick", + "type" : "Boolean", + "desc" : "True to hide the containing menu after this item is clicked (defaults to false)", + "memberOf" : "" + }, + { + "name" : "itemCls", + "type" : "String", + "desc" : "The default CSS class to use for separators (defaults to \"x-menu-sep\")", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Fires when this item is activated", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when this item is clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "deactivate", + "type" : "function", + "desc" : "Fires when this item is deactivated", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.menu.TextItem" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "activeClass", + "type" : "String", + "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "canActivate", + "type" : "Boolean", + "desc" : "True if this item can be visually activated (defaults to false)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to prevent creation of this menu item (defaults to false)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hideDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "hideOnClick", + "type" : "Boolean", + "desc" : "True to hide the containing menu after this item is clicked (defaults to false)", + "memberOf" : "" + }, + { + "name" : "itemCls", + "type" : "String", + "desc" : "The default CSS class to use for text items (defaults to \"x-menu-text\")", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "text", + "type" : "Boolean", + "desc" : "Text to show on item.", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "activate", + "type" : "function", + "desc" : "Fires when this item is activated", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when this item is clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "deactivate", + "type" : "function", + "desc" : "Fires when this item is deactivated", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.menu.BaseItem" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.state" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.state.CookieProvider" : { + "props" : [ + { + "name" : "domain", + "type" : "String", + "desc" : "The domain to save the cookie for. Note that you cannot specify a different domain than\nyour page is on, but you can specify a sub-domain, or simply the domain itself like 'roojs.com' to include\nall sub-domains if you need to access cookies across different sub-domains (defaults to null which uses the same\ndomain the page is running on including the 'www' like 'www.roojs.com')", + "memberOf" : "" + }, + { + "name" : "expires", + "type" : "Date", + "desc" : "The cookie expiration date (defaults to 7 days from now)", + "memberOf" : "" + }, + { + "name" : "path", + "type" : "String", + "desc" : "The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)", + "memberOf" : "" + }, + { + "name" : "secure", + "type" : "Boolean", + "desc" : "True if the site is using SSL (defaults to false)", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "statechange", + "type" : "function", + "desc" : "Fires when a state change occurs.", + "sig" : "function (_self, key, value)\n{\n\n}", + "memberOf" : "Roo.state.Provider" + } + ], + "methods" : [ + { + "name" : "clear", + "type" : "function", + "desc" : "Clears a value from the state", + "sig" : "(name)", + "static" : false, + "memberOf" : "Roo.state.Provider" + }, + { + "name" : "decodeValue", + "type" : "function", + "desc" : "Decodes a string previously encoded with {@link #encodeValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.state.Provider" + }, + { + "name" : "encodeValue", + "type" : "function", + "desc" : "Encodes a value including type information. Decode with {@link #decodeValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.state.Provider" + }, + { + "name" : "get", + "type" : "function", + "desc" : "Returns the current value for a key", + "sig" : "(name, defaultValue)", + "static" : false, + "memberOf" : "Roo.state.Provider" + }, + { + "name" : "set", + "type" : "function", + "desc" : "Sets the value for a key", + "sig" : "(name, value)", + "static" : false, + "memberOf" : "Roo.state.Provider" + } + ] + }, + "Roo.state.Manager" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "clear", + "type" : "function", + "desc" : "Clears a value from the state", + "sig" : "(name)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "get", + "type" : "function", + "desc" : "Returns the current value for a key", + "sig" : "(name, defaultValue)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getProvider", + "type" : "function", + "desc" : "Gets the currently configured state provider", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "set", + "type" : "function", + "desc" : "Sets the value for a key", + "sig" : "(name, value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setProvider", + "type" : "function", + "desc" : "Configures the default state provider for your application", + "sig" : "(stateProvider)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.state.Provider" : { + "props" : [ + ], + "events" : [ + { + "name" : "statechange", + "type" : "function", + "desc" : "Fires when a state change occurs.", + "sig" : "function (_self, key, value)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "clear", + "type" : "function", + "desc" : "Clears a value from the state", + "sig" : "(name)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "decodeValue", + "type" : "function", + "desc" : "Decodes a string previously encoded with {@link #encodeValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "encodeValue", + "type" : "function", + "desc" : "Encodes a value including type information. Decode with {@link #decodeValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "get", + "type" : "function", + "desc" : "Returns the current value for a key", + "sig" : "(name, defaultValue)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "set", + "type" : "function", + "desc" : "Sets the value for a key", + "sig" : "(name, value)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.tree" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.tree.AsyncTreeNode" : { + "props" : [ + { + "name" : "allowDrag", + "type" : "Boolean", + "desc" : "false to make this node undraggable if DD is on (defaults to true)", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "allowDrop", + "type" : "Boolean", + "desc" : "false if this node cannot be drop on", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "True to render a checked checkbox for this node, false to render an unchecked checkbox\n(defaults to undefined with no checkbox rendered)", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A css class to be added to the node", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "true to start the node disabled", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "expanded", + "type" : "Boolean", + "desc" : "true to start the node expanded", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "href", + "type" : "String", + "desc" : "URL of the link used for the node (defaults to #)", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "hrefTarget", + "type" : "String", + "desc" : "target frame for the link", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "icon", + "type" : "String", + "desc" : "The path to an icon for the node. The preferred way to do this", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "iconCls", + "type" : "String", + "desc" : "A css class to be added to the nodes icon element for applying css background images", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id for this node. If one is not specified, one is generated.", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "leaf", + "type" : "Boolean", + "desc" : "true if this node is a leaf and does not have children", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loader", + "type" : "TreeLoader", + "desc" : "A TreeLoader to be used by this node (defaults to the loader defined on the tree)", + "memberOf" : "" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "An Ext QuickTip for the node", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "qtipCfg", + "type" : "String", + "desc" : "An Ext QuickTip config for the node (used instead of qtip)", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "singleClickExpand", + "type" : "Boolean", + "desc" : "True for single click expand on this node", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "text", + "type" : "String", + "desc" : "The text for this node", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "uiProvider", + "type" : "Function", + "desc" : "A UI class to use for this node (defaults to Roo.tree.TreeNodeUI)", + "memberOf" : "Roo.tree.TreeNode" + } + ], + "events" : [ + { + "name" : "append", + "type" : "function", + "desc" : "Fires when a new child node is appended", + "sig" : "function (tree, _self, node, index)\n{\n\n}", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "beforeappend", + "type" : "function", + "desc" : "Fires before a new child is appended, return false to cancel the append.", + "sig" : "function (tree, _self, node)\n{\n\n}", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "beforechildrenrendered", + "type" : "function", + "desc" : "Fires right before the child nodes for this node are rendered", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "beforeclick", + "type" : "function", + "desc" : "Fires before click processing. Return false to cancel the default action.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "beforecollapse", + "type" : "function", + "desc" : "Fires before this node is collapsed, return false to cancel.", + "sig" : "function (_self, deep, anim)\n{\n\n}", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "beforeexpand", + "type" : "function", + "desc" : "Fires before this node is expanded, return false to cancel.", + "sig" : "function (_self, deep, anim)\n{\n\n}", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "beforeinsert", + "type" : "function", + "desc" : "Fires before a new child is inserted, return false to cancel the insert.", + "sig" : "function (tree, _self, node, refNode)\n{\n\n}", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "beforeload", + "type" : "function", + "desc" : "Fires before this node is loaded, return false to cancel", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforemove", + "type" : "function", + "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.", + "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "beforeremove", + "type" : "function", + "desc" : "Fires before a child is removed, return false to cancel the remove.", + "sig" : "function (tree, _self, node)\n{\n\n}", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "checkchange", + "type" : "function", + "desc" : "Fires when a node with a checkbox's checked property changes", + "sig" : "function (_self, checked)\n{\n\n}", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when this node is clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "collapse", + "type" : "function", + "desc" : "Fires when this node is collapsed", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "contextmenu", + "type" : "function", + "desc" : "Fires when this node is right clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "dblclick", + "type" : "function", + "desc" : "Fires when this node is double clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "disabledchange", + "type" : "function", + "desc" : "Fires when the disabled status of this node changes", + "sig" : "function (_self, disabled)\n{\n\n}", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Fires when this node is expanded", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "insert", + "type" : "function", + "desc" : "Fires when a new child node is inserted.", + "sig" : "function (tree, _self, node, refNode)\n{\n\n}", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Fires when this node is loaded", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires when this node is moved to a new location in the tree", + "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Fires when a child node is removed", + "sig" : "function (tree, _self, node)\n{\n\n}", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "textchange", + "type" : "function", + "desc" : "Fires when the text for this node is changed", + "sig" : "function (_self, text, oldText)\n{\n\n}", + "memberOf" : "Roo.tree.TreeNode" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "appendChild", + "type" : "function", + "desc" : "Insert node(s) as the last child node of this node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "bubble", + "type" : "function", + "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.", + "sig" : "(fn, scope, args)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "cascade", + "type" : "function", + "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.", + "sig" : "(fn, scope, args)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "collapse", + "type" : "function", + "desc" : "Collapse this node.", + "sig" : "(deep, anim)", + "static" : false, + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "collapseChildNodes", + "type" : "function", + "desc" : "Collapse all child nodes", + "sig" : "(deep)", + "static" : false, + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "contains", + "type" : "function", + "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disables this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "eachChild", + "type" : "function", + "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.", + "sig" : "(fn, scope, args)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enables this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "ensureVisible", + "type" : "function", + "desc" : "Ensures all parent nodes are expanded", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Expand this node.", + "sig" : "(deep, anim, callback)", + "static" : false, + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "expandChildNodes", + "type" : "function", + "desc" : "Expand all child nodes", + "sig" : "(deep)", + "static" : false, + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "findChild", + "type" : "function", + "desc" : "Finds the first child that has the attribute with the specified value.", + "sig" : "(attribute, value)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "findChildBy", + "type" : "function", + "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getDepth", + "type" : "function", + "desc" : "Returns depth of this node (the root node has a depth of 0)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "getOwnerTree", + "type" : "function", + "desc" : "Returns the tree this node is in.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "getPath", + "type" : "function", + "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.", + "sig" : "(attr)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "getUI", + "type" : "function", + "desc" : "Returns the UI object for this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "indexOf", + "type" : "function", + "desc" : "Returns the index of a child node", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "insertBefore", + "type" : "function", + "desc" : "Inserts the first node before the second node in this nodes childNodes collection.", + "sig" : "(node, refNode)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "isAncestor", + "type" : "function", + "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "isExpanded", + "type" : "function", + "desc" : "Returns true if this node is expanded", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "isFirst", + "type" : "function", + "desc" : "Returns true if this node is the first child of its parent", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "isLast", + "type" : "function", + "desc" : "Returns true if this node is the last child of its parent", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "isLeaf", + "type" : "function", + "desc" : "Returns true if this node is a leaf", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "isLoaded", + "type" : "function", + "desc" : "Returns true if this node has been loaded", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isLoading", + "type" : "function", + "desc" : "Returns true if this node is currently loading", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isSelected", + "type" : "function", + "desc" : "Returns true if this node is selected", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "item", + "type" : "function", + "desc" : "Returns the child node at the specified index.", + "sig" : "(index)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "reload", + "type" : "function", + "desc" : "Trigger a reload for this node", + "sig" : "(callback)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeChild", + "type" : "function", + "desc" : "Removes a child node from this node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "replaceChild", + "type" : "function", + "desc" : "Replaces one child node in this node with another.", + "sig" : "(newChild, oldChild)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Triggers selection of this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "setText", + "type" : "function", + "desc" : "Sets the text for this node", + "sig" : "(text)", + "static" : false, + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "sort", + "type" : "function", + "desc" : "Sorts this nodes children using the supplied sort function", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "toggle", + "type" : "function", + "desc" : "Toggles expanded/collapsed state of the node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.tree.TreeNode" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unselect", + "type" : "function", + "desc" : "Triggers deselection of this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.tree.TreeNode" + } + ] + }, + "Roo.tree.ColumnTree" : { + "props" : [ + { + "name" : "borderWidth", + "type" : "int", + "desc" : "compined right/left border allowance", + "memberOf" : "" + }, + { + "name" : "columns", + "type" : "Object", + "desc" : "Including width, header, renderer, cls, dataIndex", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "resize", + "type" : "function", + "desc" : "Fire this event on a container when it resizes", + "sig" : "function (w, h)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + ] + }, + "Roo.tree.DefaultSelectionModel" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "beforeselect", + "type" : "function", + "desc" : "Fires before the selected node changes, return false to cancel the change", + "sig" : "function (_self, node, node)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "selectionchange", + "type" : "function", + "desc" : "Fires when the selected node changes", + "sig" : "function (_self, node)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearSelections", + "type" : "function", + "desc" : "Clear all selections", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getSelectedNode", + "type" : "function", + "desc" : "Get the selected node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "isSelected", + "type" : "function", + "desc" : "Returns true if the node is selected", + "sig" : "(node)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Select a node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectNext", + "type" : "function", + "desc" : "Selects the node above the selected node in the tree, intelligently walking the nodes", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectPrevious", + "type" : "function", + "desc" : "Selects the node above the selected node in the tree, intelligently walking the nodes", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unselect", + "type" : "function", + "desc" : "Deselect a node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.tree.MultiSelectionModel" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "selectionchange", + "type" : "function", + "desc" : "Fires when the selected nodes change", + "sig" : "function (_self, nodes)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clearSelections", + "type" : "function", + "desc" : "Clear all selections", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getSelectedNodes", + "type" : "function", + "desc" : "Returns an array of the selected nodes", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "isSelected", + "type" : "function", + "desc" : "Returns true if the node is selected", + "sig" : "(node)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Select a node.", + "sig" : "(node, e, keepExisting)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unselect", + "type" : "function", + "desc" : "Deselect a node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.tree.TreeEditor" : { + "props" : [ + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component" + }, + { + "name" : "alignment", + "type" : "String", + "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"l-l\").", + "memberOf" : "" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "autosize", + "type" : "Boolean/String", + "desc" : "True for the editor to automatically adopt the size of the underlying field, \"width\" to adopt the width only,\nor \"height\" to adopt the height only (defaults to false)", + "memberOf" : "Roo.Editor" + }, + { + "name" : "cancelOnEsc", + "type" : "Boolean", + "desc" : "True to cancel the edit when the escape key is pressed (defaults to false)", + "memberOf" : "Roo.Editor" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "CSS class to apply to the editor (defaults to \"x-small-editor x-tree-editor\")", + "memberOf" : "" + }, + { + "name" : "completeOnEnter", + "type" : "Boolean", + "desc" : "True to complete the edit when the enter key is pressed (defaults to false)", + "memberOf" : "Roo.Editor" + }, + { + "name" : "constrain", + "type" : "Boolean", + "desc" : "True to constrain the editor to the viewport", + "memberOf" : "Roo.Editor" + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "field", + "type" : "Roo.form.TextField|Object", + "desc" : "The field configuration", + "memberOf" : "" + }, + { + "name" : "hideEl", + "type" : "Boolean", + "desc" : "True to hide the bound element while the editor is displayed (defaults to false)", + "memberOf" : "" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : [ + "(display", + "visibility)" + ], + "memberOf" : "Roo.Component" + }, + { + "name" : "ignoreNoChange", + "type" : "Boolean", + "desc" : "True to skip the the edit completion process (no save, no events fired) if the user completes an edit and\nthe value has not changed (defaults to false). Applies only to string values - edits for other data types\nwill never be ignored.", + "memberOf" : "Roo.Editor" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "maxWidth", + "type" : "Number", + "desc" : "The maximum width in pixels of the editor field (defaults to 250). Note that if the maxWidth would exceed\nthe containing tree element's size, it will be automatically limited for you to the container width, taking\nscroll and client offsets into account prior to each edit.", + "memberOf" : "" + }, + { + "name" : "revertInvalid", + "type" : "Boolean", + "desc" : "True to automatically revert the field value and cancel the edit when the user completes an edit and the field\nvalidation fails (defaults to true)", + "memberOf" : "Roo.Editor" + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "\"sides\" for sides/bottom only, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"frame\")", + "memberOf" : "Roo.Editor" + }, + { + "name" : "shim", + "type" : "Boolean", + "desc" : "True to shim the editor if selects/iframes could be displayed beneath it (defaults to false)", + "memberOf" : "" + }, + { + "name" : "tree", + "type" : "Roo.tree.TreePanel", + "desc" : "The tree to bind to.", + "memberOf" : "" + }, + { + "name" : "updateEl", + "type" : "Boolean", + "desc" : "True to update the innerHTML of the bound element when the update completes (defaults to false)", + "memberOf" : "Roo.Editor" + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The data value of the underlying field (defaults to \"\")", + "memberOf" : "Roo.Editor" + } + ], + "events" : [ + { + "name" : "beforecomplete", + "type" : "function", + "desc" : "Fires after a change has been made to the field, but before the change is reflected in the underlying\nfield. Saving the change to the field can be canceled by returning false from the handler of this event.\nNote that if the value has not changed and ignoreNoChange = true, the editing will still end but this\nevent will not fire since no edit actually occurred.", + "sig" : "function (_self, value, startValue)\n{\n\n}", + "memberOf" : "Roo.Editor" + }, + { + "name" : "beforedestroy", + "type" : "function", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforehide", + "type" : "function", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforenodeedit", + "type" : "function", + "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.", + "sig" : "function (_self, node)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforerender", + "type" : "function", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforeshow", + "type" : "function", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "beforestartedit", + "type" : "function", + "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.", + "sig" : "function (_self, boundEl, value)\n{\n\n}", + "memberOf" : "Roo.Editor" + }, + { + "name" : "complete", + "type" : "function", + "desc" : "Fires after editing is complete and any changed value has been written to the underlying field.", + "sig" : "function (_self, value, startValue)\n{\n\n}", + "memberOf" : "Roo.Editor" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component" + }, + { + "name" : "specialkey", + "type" : "function", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "Roo.Editor" + }, + { + "name" : "startedit", + "type" : "function", + "desc" : "Fires when this editor is displayed", + "sig" : "function (boundEl, value)\n{\n\n}", + "memberOf" : "Roo.Editor" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "cancelEdit", + "type" : "function", + "desc" : "Cancels the editing process and hides the editor without persisting any changes. The field value will be\nreverted to the original starting value.", + "sig" : "(remainVisible)", + "static" : false, + "memberOf" : "Roo.Editor" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "completeEdit", + "type" : "function", + "desc" : "Ends the editing process, persists the changed value to the underlying field, and hides the editor.", + "sig" : "(remainVisible)", + "static" : false, + "memberOf" : "Roo.Editor" + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "getValue", + "type" : "function", + "desc" : "Gets the data value of the editor", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Editor" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "realign", + "type" : "function", + "desc" : "Realigns the editor to the bound field based on the current alignment config value.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Editor" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "setSize", + "type" : "function", + "desc" : "Sets the height and width of this editor.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.Editor" + }, + { + "name" : "setValue", + "type" : "function", + "desc" : "Sets the data value of the editor", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.Editor" + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component" + }, + { + "name" : "startEdit", + "type" : "function", + "desc" : "Starts the editing process and shows the editor.", + "sig" : "(el, value)", + "static" : false, + "memberOf" : "Roo.Editor" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.tree.TreeFilter" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "clear", + "type" : "function", + "desc" : "Clears the current filter. Note: with the \"remove\" option\nset a filter cannot be cleared.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "filter", + "type" : "function", + "desc" : "Filter the data by a specific attribute.", + "sig" : "(value, attr, startNode)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "filterBy", + "type" : "function", + "desc" : "Filter by a function. The passed function will be called with each\nnode in the tree (or from the startNode). If the function returns true, the node is kept\notherwise it is filtered. If a node is filtered, its children are also filtered.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.tree.TreeLoader" : { + "props" : [ + { + "name" : "baseAttrs", + "type" : "Object", + "desc" : "(optional) An object containing attributes to be added to all nodes\ncreated by this loader. If the attributes sent by the server have an attribute in this object,\nthey take priority.", + "memberOf" : "" + }, + { + "name" : "baseParams", + "type" : "Object", + "desc" : "(optional) An object containing properties which\nspecify HTTP parameters to be passed to each request for child nodes.", + "memberOf" : "" + }, + { + "name" : "clearOnLoad", + "type" : "Boolean", + "desc" : "(optional) Default to true. Remove previously existing\nchild nodes before loading.", + "memberOf" : "" + }, + { + "name" : "dataUrl", + "type" : "String", + "desc" : "The URL from which to request a Json string which\nspecifies an array of node definition object representing the child nodes\nto be loaded.", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "queryParam", + "type" : "String", + "desc" : "(optional) \nName of the query as it will be passed on the querystring (defaults to 'node')\neg. the request will be ?node=[id]", + "memberOf" : "" + }, + { + "name" : "requestMethod", + "type" : "String", + "desc" : "either GET or POST\ndefaults to POST (due to BC)\nto be loaded.", + "memberOf" : "" + }, + { + "name" : "root", + "type" : "String", + "desc" : "(optional) Default to false. Use this to read data from an object \nproperty on loading, rather than expecting an array. (eg. more compatible to a standard\nGrid query { data : [ .....] }", + "memberOf" : "" + }, + { + "name" : "uiProviders", + "type" : "Object", + "desc" : "(optional) An object containing properties which\n\nDEPRECATED - use 'create' event handler to modify attributes - which affect creation.\nspecify custom {@link Roo.tree.TreeNodeUI} implementations. If the optional\nuiProvider attribute of a returned child node is a string rather\nthan a reference to a TreeNodeUI implementation, this that string value\nis used as a property name in the uiProviders object. You can define the provider named\n'default' , and this will be used for all nodes (if no uiProvider is delivered by the node data)", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "beforeload", + "type" : "function", + "desc" : "Fires before a network request is made to retrieve the Json text which specifies a node's children.", + "sig" : "function (This, node, callback)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "create", + "type" : "function", + "desc" : "Fires before a node is created, enabling you to return custom Node types", + "sig" : "function (This, attr)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Fires when the node has been successfuly loaded.", + "sig" : "function (This, node, response)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "loadexception", + "type" : "function", + "desc" : "Fires if the network request failed.", + "sig" : "function (This, node, response)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Load an {@link Roo.tree.TreeNode} from the URL specified in the constructor.\nThis is called automatically when a node is expanded, but may be used to reload\na node (or append new children if the {@link #clearOnLoad} option is false.)", + "sig" : "(node, callback)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.tree.TreeNode" : { + "props" : [ + { + "name" : "allowDrag", + "type" : "Boolean", + "desc" : "false to make this node undraggable if DD is on (defaults to true)", + "memberOf" : "" + }, + { + "name" : "allowDrop", + "type" : "Boolean", + "desc" : "false if this node cannot be drop on", + "memberOf" : "" + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "True to render a checked checkbox for this node, false to render an unchecked checkbox\n(defaults to undefined with no checkbox rendered)", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A css class to be added to the node", + "memberOf" : "" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "true to start the node disabled", + "memberOf" : "" + }, + { + "name" : "expanded", + "type" : "Boolean", + "desc" : "true to start the node expanded", + "memberOf" : "" + }, + { + "name" : "href", + "type" : "String", + "desc" : "URL of the link used for the node (defaults to #)", + "memberOf" : "" + }, + { + "name" : "hrefTarget", + "type" : "String", + "desc" : "target frame for the link", + "memberOf" : "" + }, + { + "name" : "icon", + "type" : "String", + "desc" : "The path to an icon for the node. The preferred way to do this", + "memberOf" : "" + }, + { + "name" : "iconCls", + "type" : "String", + "desc" : "A css class to be added to the nodes icon element for applying css background images", + "memberOf" : "" + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id for this node. If one is not specified, one is generated.", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "leaf", + "type" : "Boolean", + "desc" : "true if this node is a leaf and does not have children", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "An Ext QuickTip for the node", + "memberOf" : "" + }, + { + "name" : "qtipCfg", + "type" : "String", + "desc" : "An Ext QuickTip config for the node (used instead of qtip)", + "memberOf" : "" + }, + { + "name" : "singleClickExpand", + "type" : "Boolean", + "desc" : "True for single click expand on this node", + "memberOf" : "" + }, + { + "name" : "text", + "type" : "String", + "desc" : "The text for this node", + "memberOf" : "" + }, + { + "name" : "uiProvider", + "type" : "Function", + "desc" : "A UI class to use for this node (defaults to Roo.tree.TreeNodeUI)", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "append", + "type" : "function", + "desc" : "Fires when a new child node is appended", + "sig" : "function (tree, _self, node, index)\n{\n\n}", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "beforeappend", + "type" : "function", + "desc" : "Fires before a new child is appended, return false to cancel the append.", + "sig" : "function (tree, _self, node)\n{\n\n}", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "beforechildrenrendered", + "type" : "function", + "desc" : "Fires right before the child nodes for this node are rendered", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeclick", + "type" : "function", + "desc" : "Fires before click processing. Return false to cancel the default action.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforecollapse", + "type" : "function", + "desc" : "Fires before this node is collapsed, return false to cancel.", + "sig" : "function (_self, deep, anim)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeexpand", + "type" : "function", + "desc" : "Fires before this node is expanded, return false to cancel.", + "sig" : "function (_self, deep, anim)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeinsert", + "type" : "function", + "desc" : "Fires before a new child is inserted, return false to cancel the insert.", + "sig" : "function (tree, _self, node, refNode)\n{\n\n}", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "beforemove", + "type" : "function", + "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.", + "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "beforeremove", + "type" : "function", + "desc" : "Fires before a child is removed, return false to cancel the remove.", + "sig" : "function (tree, _self, node)\n{\n\n}", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "checkchange", + "type" : "function", + "desc" : "Fires when a node with a checkbox's checked property changes", + "sig" : "function (_self, checked)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when this node is clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "collapse", + "type" : "function", + "desc" : "Fires when this node is collapsed", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "contextmenu", + "type" : "function", + "desc" : "Fires when this node is right clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "dblclick", + "type" : "function", + "desc" : "Fires when this node is double clicked", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "disabledchange", + "type" : "function", + "desc" : "Fires when the disabled status of this node changes", + "sig" : "function (_self, disabled)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Fires when this node is expanded", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "insert", + "type" : "function", + "desc" : "Fires when a new child node is inserted.", + "sig" : "function (tree, _self, node, refNode)\n{\n\n}", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires when this node is moved to a new location in the tree", + "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Fires when a child node is removed", + "sig" : "function (tree, _self, node)\n{\n\n}", + "memberOf" : "Roo.data.Node" + }, + { + "name" : "textchange", + "type" : "function", + "desc" : "Fires when the text for this node is changed", + "sig" : "function (_self, text, oldText)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "appendChild", + "type" : "function", + "desc" : "Insert node(s) as the last child node of this node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "bubble", + "type" : "function", + "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.", + "sig" : "(fn, scope, args)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "cascade", + "type" : "function", + "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.", + "sig" : "(fn, scope, args)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "collapse", + "type" : "function", + "desc" : "Collapse this node.", + "sig" : "(deep, anim)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "collapseChildNodes", + "type" : "function", + "desc" : "Collapse all child nodes", + "sig" : "(deep)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "contains", + "type" : "function", + "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disables this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "eachChild", + "type" : "function", + "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.", + "sig" : "(fn, scope, args)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Enables this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "ensureVisible", + "type" : "function", + "desc" : "Ensures all parent nodes are expanded", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Expand this node.", + "sig" : "(deep, anim, callback)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "expandChildNodes", + "type" : "function", + "desc" : "Expand all child nodes", + "sig" : "(deep)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "findChild", + "type" : "function", + "desc" : "Finds the first child that has the attribute with the specified value.", + "sig" : "(attribute, value)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "findChildBy", + "type" : "function", + "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getDepth", + "type" : "function", + "desc" : "Returns depth of this node (the root node has a depth of 0)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "getOwnerTree", + "type" : "function", + "desc" : "Returns the tree this node is in.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "getPath", + "type" : "function", + "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.", + "sig" : "(attr)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "getUI", + "type" : "function", + "desc" : "Returns the UI object for this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "indexOf", + "type" : "function", + "desc" : "Returns the index of a child node", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "insertBefore", + "type" : "function", + "desc" : "Inserts the first node before the second node in this nodes childNodes collection.", + "sig" : "(node, refNode)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "isAncestor", + "type" : "function", + "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "isExpanded", + "type" : "function", + "desc" : "Returns true if this node is expanded", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "isFirst", + "type" : "function", + "desc" : "Returns true if this node is the first child of its parent", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "isLast", + "type" : "function", + "desc" : "Returns true if this node is the last child of its parent", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "isLeaf", + "type" : "function", + "desc" : "Returns true if this node is a leaf", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "isSelected", + "type" : "function", + "desc" : "Returns true if this node is selected", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "item", + "type" : "function", + "desc" : "Returns the child node at the specified index.", + "sig" : "(index)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeChild", + "type" : "function", + "desc" : "Removes a child node from this node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "replaceChild", + "type" : "function", + "desc" : "Replaces one child node in this node with another.", + "sig" : "(newChild, oldChild)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "select", + "type" : "function", + "desc" : "Triggers selection of this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setText", + "type" : "function", + "desc" : "Sets the text for this node", + "sig" : "(text)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "sort", + "type" : "function", + "desc" : "Sorts this nodes children using the supplied sort function", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Node" + }, + { + "name" : "toggle", + "type" : "function", + "desc" : "Toggles expanded/collapsed state of the node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "unselect", + "type" : "function", + "desc" : "Triggers deselection of this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.tree.TreeNodeUI" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.tree.TreePanel" : { + "props" : [ + { + "name" : "animate", + "type" : "Boolean", + "desc" : "true to enable animated expand/collapse (defaults to the value of Roo.enableFx)", + "memberOf" : "" + }, + { + "name" : "containerScroll", + "type" : "Boolean", + "desc" : "true to register this container with ScrollManager", + "memberOf" : "" + }, + { + "name" : "ddAppendOnly", + "type" : "String", + "desc" : "True if the tree should only allow append drops (use for trees which are sorted)", + "memberOf" : "" + }, + { + "name" : "ddGroup", + "type" : "String", + "desc" : "The DD group this TreePanel belongs to", + "memberOf" : "" + }, + { + "name" : "ddScroll", + "type" : "Boolean", + "desc" : "true to enable YUI body scrolling", + "memberOf" : "" + }, + { + "name" : "dragConfig", + "type" : "Object", + "desc" : "Custom config to pass to the {@link Roo.tree.TreeDragZone} instance", + "memberOf" : "" + }, + { + "name" : "dropConfig", + "type" : "Object", + "desc" : "Custom config to pass to the {@link Roo.tree.TreeDropZone} instance", + "memberOf" : "" + }, + { + "name" : "editor", + "type" : "Object|Roo.tree.TreeEditor", + "desc" : "The TreeEditor or xtype data to display when clicked.", + "memberOf" : "" + }, + { + "name" : "enableDD", + "type" : "Boolean", + "desc" : "true to enable drag and drop", + "memberOf" : "" + }, + { + "name" : "enableDrag", + "type" : "Boolean", + "desc" : "true to enable just drag", + "memberOf" : "" + }, + { + "name" : "enableDrop", + "type" : "Boolean", + "desc" : "true to enable just drop", + "memberOf" : "" + }, + { + "name" : "hlColor", + "type" : "String", + "desc" : "The color of the node highlight (defaults to C3DAF9)", + "memberOf" : "" + }, + { + "name" : "hlDrop", + "type" : "Boolean", + "desc" : "false to disable node highlight on drop (defaults to the value of Roo.enableFx)", + "memberOf" : "" + }, + { + "name" : "lines", + "type" : "Boolean", + "desc" : "false to disable tree lines (defaults to true)", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "loader", + "type" : "Boolean", + "desc" : "A TreeLoader for use with this TreePanel", + "memberOf" : "" + }, + { + "name" : "pathSeparator", + "type" : "String", + "desc" : "The token used to separate sub-paths in path strings (defaults to '/')", + "memberOf" : "" + }, + { + "name" : "renderer", + "type" : "Function", + "desc" : "DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes. to return HTML markup for the tree view. The render function is called with the following parameters:", + "memberOf" : "" + }, + { + "name" : "rendererTip", + "type" : "Function", + "desc" : "DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes hovertip to return HTML markup for the tree view. The render function is called with the following parameters:", + "memberOf" : "" + }, + { + "name" : "rootVisible", + "type" : "Boolean", + "desc" : "false to hide the root node (defaults to true)", + "memberOf" : "" + }, + { + "name" : "selModel", + "type" : "Boolean", + "desc" : "A tree selection model to use with this TreePanel (defaults to a {@link Roo.tree.DefaultSelectionModel})", + "memberOf" : "" + }, + { + "name" : "singleExpand", + "type" : "Boolean", + "desc" : "true if only 1 node per branch may be expanded", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "append", + "type" : "function", + "desc" : "Fires when a new child node is appended to a node in this tree.", + "sig" : "function (tree, parent, node, index)\n{\n\n}", + "memberOf" : "Roo.data.Tree" + }, + { + "name" : "beforeappend", + "type" : "function", + "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.", + "sig" : "function (tree, parent, node)\n{\n\n}", + "memberOf" : "Roo.data.Tree" + }, + { + "name" : "beforechildrenrendered", + "type" : "function", + "desc" : "Fires right before the child nodes for a node are rendered", + "sig" : "function (node)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeclick", + "type" : "function", + "desc" : "Fires before click processing on a node. Return false to cancel the default action.", + "sig" : "function (node, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforecollapse", + "type" : "function", + "desc" : "Fires before a node is collapsed, return false to cancel.", + "sig" : "function (node, deep, anim)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeexpand", + "type" : "function", + "desc" : "Fires before a node is expanded, return false to cancel.", + "sig" : "function (node, deep, anim)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeinsert", + "type" : "function", + "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.", + "sig" : "function (tree, parent, node, refNode)\n{\n\n}", + "memberOf" : "Roo.data.Tree" + }, + { + "name" : "beforeload", + "type" : "function", + "desc" : "Fires before a node is loaded, return false to cancel", + "sig" : "function (node)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforemove", + "type" : "function", + "desc" : "Fires before a node is moved to a new location in the tree. Return false to cancel the move.", + "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}", + "memberOf" : "Roo.data.Tree" + }, + { + "name" : "beforenodedrop", + "type" : "function", + "desc" : "Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The dropEvent\npassed to handlers has the following properties:
\n", + "sig" : "function (dropEvent)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "beforeremove", + "type" : "function", + "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.", + "sig" : "function (tree, parent, node)\n{\n\n}", + "memberOf" : "Roo.data.Tree" + }, + { + "name" : "checkchange", + "type" : "function", + "desc" : "Fires when a node with a checkbox's checked property changes", + "sig" : "function (_self, checked)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "click", + "type" : "function", + "desc" : "Fires when a node is clicked", + "sig" : "function (node, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "collapse", + "type" : "function", + "desc" : "Fires when a node is collapsed", + "sig" : "function (node)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "contextmenu", + "type" : "function", + "desc" : "Fires when a node is right clicked", + "sig" : "function (node, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "dblclick", + "type" : "function", + "desc" : "Fires when a node is double clicked", + "sig" : "function (node, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "disabledchange", + "type" : "function", + "desc" : "Fires when the disabled status of a node changes", + "sig" : "function (node, disabled)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "dragdrop", + "type" : "function", + "desc" : "Fires when a dragged node is dropped on a valid DD target", + "sig" : "function (_self, node, dd, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "enddrag", + "type" : "function", + "desc" : "Fires when a drag operation is complete", + "sig" : "function (_self, node, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Fires when a node is expanded", + "sig" : "function (node)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "insert", + "type" : "function", + "desc" : "Fires when a new child node is inserted in a node in this tree.", + "sig" : "function (tree, parent, node, refNode)\n{\n\n}", + "memberOf" : "Roo.data.Tree" + }, + { + "name" : "load", + "type" : "function", + "desc" : "Fires when a node is loaded", + "sig" : "function (node)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "move", + "type" : "function", + "desc" : "Fires when a node is moved to a new location in the tree", + "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}", + "memberOf" : "Roo.data.Tree" + }, + { + "name" : "nodedragover", + "type" : "function", + "desc" : "Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent\npassed to handlers has the following properties:
\n", + "sig" : "function (dragOverEvent)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "nodedrop", + "type" : "function", + "desc" : "Fires after a DD object is dropped on a node in this tree. The dropEvent\npassed to handlers has the following properties:
\n", + "sig" : "function (dropEvent)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Fires when a child node is removed from a node in this tree.", + "sig" : "function (tree, parent, node)\n{\n\n}", + "memberOf" : "Roo.data.Tree" + }, + { + "name" : "startdrag", + "type" : "function", + "desc" : "Fires when a node starts being dragged", + "sig" : "function (_self, node, e)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "textchange", + "type" : "function", + "desc" : "Fires when the text for a node is changed", + "sig" : "function (node, text, oldText)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "collapseAll", + "type" : "function", + "desc" : "Collapse all nodes", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "expandAll", + "type" : "function", + "desc" : "Expand all nodes", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "expandPath", + "type" : "function", + "desc" : "Expands a specified path in this TreePanel. A path can be retrieved from a node with {@link Roo.data.Node#getPath}", + "sig" : "(path, attr, callback)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "getChecked", + "type" : "function", + "desc" : "Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. \"id\")", + "sig" : "(attribute, startNode)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the container element for this TreePanel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getLoader", + "type" : "function", + "desc" : "Returns the default TreeLoader for this TreePanel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getNodeById", + "type" : "function", + "desc" : "Gets a node in this tree by its id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.data.Tree" + }, + { + "name" : "getRootNode", + "type" : "function", + "desc" : "Returns the root node for this tree.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Tree" + }, + { + "name" : "getSelectionModel", + "type" : "function", + "desc" : "Returns the selection model used by this TreePanel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "render", + "type" : "function", + "desc" : "Trigger rendering of this TreePanel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "selectPath", + "type" : "function", + "desc" : "Selects the node in this tree at the specified path. A path can be retrieved from a node with {@link Roo.data.Node#getPath}", + "sig" : "(path, attr, callback)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "setRootNode", + "type" : "function", + "desc" : "Sets the root node for this tree.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Tree" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.tree.TreeSorter" : { + "props" : [ + { + "name" : "caseSensitive", + "type" : "Boolean", + "desc" : "true for case sensitive sort (defaults to false)", + "memberOf" : "" + }, + { + "name" : "dir", + "type" : "String", + "desc" : "The direction to sort (asc or desc) (defaults to asc)", + "memberOf" : "" + }, + { + "name" : "folderSort", + "type" : "Boolean", + "desc" : "True to sort leaf nodes under non leaf nodes", + "memberOf" : "" + }, + { + "name" : "leafAttr", + "type" : "String", + "desc" : "The attribute used to determine leaf nodes in folder sort (defaults to \"leaf\")", + "memberOf" : "" + }, + { + "name" : "property", + "type" : "String", + "desc" : "The named attribute on the node to sort by (defaults to text)", + "memberOf" : "" + }, + { + "name" : "sortType", + "type" : "Function", + "desc" : "A custom \"casting\" function used to convert node values before sorting", + "memberOf" : "" + } + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.util" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.util.CSS" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "createStyleSheet", + "type" : "function", + "desc" : "Very simple dynamic creation of stylesheets from a text blob of rules. The text will wrapped in a style\ntag and appended to the HEAD of the document.", + "sig" : "(cssText, id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getRule", + "type" : "function", + "desc" : "Gets an an individual CSS rule by selector(s)", + "sig" : "(selector, refreshCache)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getRules", + "type" : "function", + "desc" : "Gets all css rules for the document", + "sig" : "(refreshCache)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "refreshCache", + "type" : "function", + "desc" : "Refresh the rule cache if you have dynamically added stylesheets", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeStyleSheet", + "type" : "function", + "desc" : "Removes a style or link tag by id", + "sig" : "(id)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "swapStyleSheet", + "type" : "function", + "desc" : "Dynamically swaps an existing stylesheet reference for a new one", + "sig" : "(id, url)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "updateRule", + "type" : "function", + "desc" : "Updates a rule property", + "sig" : "(selector, property, value)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.util.ClickRepeater" : { + "props" : [ + { + "name" : "accelerate", + "type" : "Boolean", + "desc" : "True if autorepeating should start slowly and accelerate.\n \"interval\" and \"delay\" are ignored. \"immediate\" is honored.", + "memberOf" : "" + }, + { + "name" : "delay", + "type" : "Number", + "desc" : "The initial delay before the repeating event begins firing.\nSimilar to an autorepeat key delay.", + "memberOf" : "" + }, + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The element to act as a button.", + "memberOf" : "" + }, + { + "name" : "interval", + "type" : "Number", + "desc" : "The interval between firings of the \"click\" event. Default 10 ms.", + "memberOf" : "" + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "pressClass", + "type" : "String", + "desc" : "A CSS class name to be applied to the element while pressed.", + "memberOf" : "" + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : "True to prevent the default click event", + "memberOf" : "" + }, + { + "name" : "stopDefault", + "type" : "Boolean", + "desc" : "True to stop the default click event", + "memberOf" : "" + } + ], + "events" : [ + { + "name" : "click", + "type" : "function", + "desc" : "Fires on a specified interval during the time the element is pressed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "mousedown", + "type" : "function", + "desc" : "Fires when the mouse button is depressed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "mouseup", + "type" : "function", + "desc" : "Fires when the mouse key is released.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.util.DelayedTask" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.util.Format" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "capitalize", + "type" : "function", + "desc" : "Converts the first character only of a string to upper case", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "date", + "type" : "function", + "desc" : "Parse a value into a formatted date using the specified format pattern.", + "sig" : "(value, format)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "dateRenderer", + "type" : "function", + "desc" : "Returns a date rendering function that can be reused to apply a date format multiple times efficiently", + "sig" : "(format)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "ellipsis", + "type" : "function", + "desc" : "Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length", + "sig" : "(value, length)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "htmlDecode", + "type" : "function", + "desc" : "Convert certain characters (&, <, >, and ') from their HTML character equivalents.", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "htmlEncode", + "type" : "function", + "desc" : "Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "lowercase", + "type" : "function", + "desc" : "Converts a string to all lower case letters", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "number", + "type" : "function", + "desc" : "Format a number\neventually this should probably emulate php's number_format", + "sig" : "(value, decimals, delimiter)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "stripTags", + "type" : "function", + "desc" : "Strips all HTML tags", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "substr", + "type" : "function", + "desc" : "Returns a substring from within an original string", + "sig" : "(value, start, length)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "toFixed", + "type" : "function", + "desc" : "safer version of Math.toFixed..??/", + "sig" : "(value, value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "trim", + "type" : "function", + "desc" : "Trims any whitespace from either side of a string", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "undef", + "type" : "function", + "desc" : "Checks a reference and converts it to empty string if it is undefined", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "uppercase", + "type" : "function", + "desc" : "Converts a string to all upper case letters", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "usMoney", + "type" : "function", + "desc" : "Format a number as US currency", + "sig" : "(value)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.util.JSON" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "Roo.util.MixedCollection" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], + "events" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Fires when an item is added to the collection.", + "sig" : "function (index, o, key)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "clear", + "type" : "function", + "desc" : "Fires when the collection is cleared.", + "sig" : "function ()\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Fires when an item is removed from the collection.", + "sig" : "function (o, key)\n{\n\n}", + "memberOf" : "" + }, + { + "name" : "replace", + "type" : "function", + "desc" : "Fires when an item is replaced in the collection.", + "sig" : "function (key, old, new)\n{\n\n}", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "add", + "type" : "function", + "desc" : "Adds an item to the collection.", + "sig" : "(key, o)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addAll", + "type" : "function", + "desc" : "Adds all elements of an Array or an Object to the collection.", + "sig" : "(objs)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "clear", + "type" : "function", + "desc" : "Removes all items from the collection.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "clone", + "type" : "function", + "desc" : "Creates a duplicate of this collection", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "contains", + "type" : "function", + "desc" : "Returns true if the collection contains the passed Object as an item.", + "sig" : "(o)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "containsKey", + "type" : "function", + "desc" : "Returns true if the collection contains the passed Object as a key.", + "sig" : "(key)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "each", + "type" : "function", + "desc" : "Executes the specified function once for every item in the collection, passing each\nitem as the first and only parameter. returning false from the function will stop the iteration.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "eachKey", + "type" : "function", + "desc" : "Executes the specified function once for every key in the collection, passing each\nkey, and its associated item as the first two parameters.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "filter", + "type" : "function", + "desc" : "Filter the objects in this collection by a specific property. \nReturns a new collection that has been filtered.", + "sig" : "(property, value)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "filterBy", + "type" : "function", + "desc" : "Filter by a function. * Returns a new collection that has been filtered.\nThe passed function will be called with each \nobject in the collection. If the function returns true, the value is included \notherwise it is filtered.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "find", + "type" : "function", + "desc" : "Returns the first item in the collection which elicits a true return value from the\npassed selection function.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "first", + "type" : "function", + "desc" : "Returns the first item in the collection.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "get", + "type" : "function", + "desc" : "Returns the item associated with the passed key or index.", + "sig" : "(key)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getCount", + "type" : "function", + "desc" : "Returns the number of items in the collection.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getKey", + "type" : "function", + "desc" : "MixedCollection has a generic way to fetch keys if you implement getKey.\n
\n// normal way\nvar mc = new Roo.util.MixedCollection();\nmc.add(someEl.dom.id, someEl);\nmc.add(otherEl.dom.id, otherEl);\n//and so on\n\n// using getKey\nvar mc = new Roo.util.MixedCollection();\nmc.getKey = function(el){\n   return el.dom.id;\n};\nmc.add(someEl);\nmc.add(otherEl);\n\n// or via the constructor\nvar mc = new Roo.util.MixedCollection(false, function(el){\n   return el.dom.id;\n});\nmc.add(someEl);\nmc.add(otherEl);\n
", + "sig" : "(o)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "getRange", + "type" : "function", + "desc" : "Returns a range of items in this collection", + "sig" : "(startIndex, endIndex)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "indexOf", + "type" : "function", + "desc" : "Returns index within the collection of the passed Object.", + "sig" : "(o)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "indexOfKey", + "type" : "function", + "desc" : "Returns index within the collection of the passed key.", + "sig" : "(key)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "insert", + "type" : "function", + "desc" : "Inserts an item at the specified index in the collection.", + "sig" : "(index, key, o)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "item", + "type" : "function", + "desc" : "Returns the item associated with the passed key OR index. Key has priority over index.", + "sig" : "(key)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "itemAt", + "type" : "function", + "desc" : "Returns the item at the specified index.", + "sig" : "(index)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "key", + "type" : "function", + "desc" : "Returns the item associated with the passed key.", + "sig" : "(key)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "keySort", + "type" : "function", + "desc" : "Sorts this collection by keys", + "sig" : "(direction, fn)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "last", + "type" : "function", + "desc" : "Returns the last item in the collection.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "remove", + "type" : "function", + "desc" : "Removed an item from the collection.", + "sig" : "(o)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeAt", + "type" : "function", + "desc" : "Remove an item from a specified index in the collection.", + "sig" : "(index)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeKey", + "type" : "function", + "desc" : "Removed an item associated with the passed key fom the collection.", + "sig" : "(key)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "replace", + "type" : "function", + "desc" : "Replaces an item in the collection.", + "sig" : "(key, o)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "sort", + "type" : "function", + "desc" : "Sorts this collection with the passed comparison function", + "sig" : "(direction, fn)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable" + } + ] + }, + "Roo.util.Observable" : { + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "" + } + ], + "events" : [ + ], + "methods" : [ + { + "name" : "addEvents", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "addListener", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "capture", + "type" : "function", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "fireEvent", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "hasListener", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "on", + "type" : "function", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "un", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.util.TextMetrics" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "createInstance", + "type" : "function", + "desc" : "Return a unique TextMetrics instance that can be bound directly to an element and reused. This reduces\nthe overhead of multiple calls to initialize the style properties on each measurement.", + "sig" : "(el, fixedWidth)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "measure", + "type" : "function", + "desc" : "Measures the size of the specified text", + "sig" : "(el, text, fixedWidth)", + "static" : false, + "memberOf" : "" + } + ] + }, + "Roo.util.TextMetrics.Instance" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + }, + "String" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "escape", + "type" : "function", + "desc" : "Escapes the passed string for ' and \\", + "sig" : "(string)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "format", + "type" : "function", + "desc" : "Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens. Each\ntoken must be unique, and must increment in the format {0}, {1}, etc. Example usage:\n
\nvar cls = 'my-class', text = 'Some text';\nvar s = String.format('
{1}
', cls, text);\n// s now contains the string: '
Some text
'\n
", + "sig" : "(string, value1, value2)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "leftPad", + "type" : "function", + "desc" : "Pads the left side of a string with a specified character. This is especially useful\nfor normalizing number and date strings. Example usage:\n
\nvar s = String.leftPad('123', 5, '0');\n// s now contains the string: '00123'\n
", + "sig" : "(string, size, char)", + "static" : true, + "memberOf" : "" + }, + { + "name" : "toggle", + "type" : "function", + "desc" : "Utility function that allows you to easily switch a string between two alternating values. The passed value\nis compared to the current string, and if they are equal, the other value that was passed in is returned. If\nthey are already different, the first value passed in is returned. Note that this method returns the new value\nbut does not change the current string.\n
\n// alternate sort directions\nsort = sort.toggle('ASC', 'DESC');\n\n// instead of conditional logic:\nsort = (sort == 'ASC' ? 'DESC' : 'ASC');\n
", + "sig" : "(value, other)", + "static" : false, + "memberOf" : "" + }, + { + "name" : "unicodeClean", + "type" : "function", + "desc" : "Remove invalid unicode characters from a string", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + } + ] + }, + "_global_" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + { + "name" : "InlineLexer", + "type" : "function", + "desc" : "Inline Lexer & Compiler", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "Lexer", + "type" : "function", + "desc" : "Block Lexer", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "Parser", + "type" : "function", + "desc" : "Parsing & Compiling", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "Renderer", + "type" : "function", + "desc" : "Renderer", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "escape", + "type" : "function", + "desc" : "Helpers", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + }, + { + "name" : "marked", + "type" : "function", + "desc" : "Marked", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "" + } + ] + }, + "this" : { + "props" : [ + ], + "events" : [ + ], + "methods" : [ + ] + } +} \ No newline at end of file diff --git a/docs2/src/Array.js.html b/docs2/src/Array.js.html new file mode 100644 index 0000000000..cf37ed1dc1 --- /dev/null +++ b/docs2/src/Array.js.html @@ -0,0 +1,64 @@ +/home/alan/gitlive/roojs1/Array.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + /** + * @class Array + */ +Roo.applyIf(Array.prototype, { + /** + * + * Checks whether or not the specified object exists in the array. + * @param {Object} o The object to check for + * @return {Number} The index of o in the array (or -1 if it is not found) + */ + indexOf : function(o){ + for (var i = 0, len = this.length; i < len; i++){ + if(this[i] == o) { return i; } + } + return -1; + }, + + /** + * Removes the specified object from the array. If the object is not found nothing happens. + * @param {Object} o The object to remove + */ + remove : function(o){ + var index = this.indexOf(o); + if(index != -1){ + this.splice(index, 1); + } + }, + /** + * Map (JS 1.6 compatibility) + * @param {Function} function to call + */ + map : function(fun ) + { + var len = this.length >>> 0; + if (typeof fun != "function") { + throw new TypeError(); + } + var res = new Array(len); + var thisp = arguments[1]; + for (var i = 0; i < len; i++) + { + if (i in this) { + res[i] = fun.call(thisp, this[i], i, this); + } + } + + return res; + } + +}); + + + + \ No newline at end of file diff --git a/docs2/src/Date.js.html b/docs2/src/Date.js.html new file mode 100644 index 0000000000..9572e3dbcd --- /dev/null +++ b/docs2/src/Date.js.html @@ -0,0 +1,809 @@ +/home/alan/gitlive/roojs1/Date.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Date + * + * The date parsing and format syntax is a subset of + * <a href="http://www.php.net/date">PHP's date() function</a>, and the formats that are + * supported will provide results equivalent to their PHP versions. + * + * Following is the list of all currently supported formats: + *<pre> +Sample date: +'Wed Jan 10 2007 15:05:01 GMT-0600 (Central Standard Time)' + +Format Output Description +------ ---------- -------------------------------------------------------------- + d 10 Day of the month, 2 digits with leading zeros + D Wed A textual representation of a day, three letters + j 10 Day of the month without leading zeros + l Wednesday A full textual representation of the day of the week + S th English ordinal day of month suffix, 2 chars (use with j) + w 3 Numeric representation of the day of the week + z 9 The julian date, or day of the year (0-365) + W 01 ISO-8601 2-digit week number of year, weeks starting on Monday (00-52) + F January A full textual representation of the month + m 01 Numeric representation of a month, with leading zeros + M Jan Month name abbreviation, three letters + n 1 Numeric representation of a month, without leading zeros + t 31 Number of days in the given month + L 0 Whether it's a leap year (1 if it is a leap year, else 0) + Y 2007 A full numeric representation of a year, 4 digits + y 07 A two digit representation of a year + a pm Lowercase Ante meridiem and Post meridiem + A PM Uppercase Ante meridiem and Post meridiem + g 3 12-hour format of an hour without leading zeros + G 15 24-hour format of an hour without leading zeros + h 03 12-hour format of an hour with leading zeros + H 15 24-hour format of an hour with leading zeros + i 05 Minutes with leading zeros + s 01 Seconds, with leading zeros + O -0600 Difference to Greenwich time (GMT) in hours (Allows +08, without minutes) + P -06:00 Difference to Greenwich time (GMT) with colon between hours and minutes + T CST Timezone setting of the machine running the code + Z -21600 Timezone offset in seconds (negative if west of UTC, positive if east) +</pre> + * + * Example usage (note that you must escape format specifiers with '\\' to render them as character literals): + * <pre><code> +var dt = new Date('1/10/2007 03:05:01 PM GMT-0600'); +document.write(dt.format('Y-m-d')); //2007-01-10 +document.write(dt.format('F j, Y, g:i a')); //January 10, 2007, 3:05 pm +document.write(dt.format('l, \\t\\he dS of F Y h:i:s A')); //Wednesday, the 10th of January 2007 03:05:01 PM + </code></pre> + * + * Here are some standard date/time patterns that you might find helpful. They + * are not part of the source of Date.js, but to use them you can simply copy this + * block of code into any script that is included after Date.js and they will also become + * globally available on the Date object. Feel free to add or remove patterns as needed in your code. + * <pre><code> +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-d\\TH:i:s", + UniversalSortableDateTime: "Y-m-d H:i:sO", + YearMonth: "F, Y" +}; +</code></pre> + * + * Example usage: + * <pre><code> +var dt = new Date(); +document.write(dt.format(Date.patterns.ShortDate)); + </code></pre> + */ + +/* + * Most of the date-formatting functions below are the excellent work of Baron Schwartz. + * They generate precompiled functions from date formats instead of parsing and + * processing the pattern every time you format a date. These functions are available + * on every Date object (any javascript function). + * + * The original article and download are here: + * http://www.xaprb.com/blog/2005/12/12/javascript-closures-for-runtime-efficiency/ + * + */ + + + // was in core +/** + Returns the number of milliseconds between this date and date + @param {Date} date (optional) Defaults to now + @return {Number} The diff in milliseconds + @member Date getElapsed + */ +Date.prototype.getElapsed = function(date) { + return Math.abs((date || new Date()).getTime()-this.getTime()); +}; +// was in date file.. + + +// private +Date.parseFunctions = {count:0}; +// private +Date.parseRegexes = []; +// private +Date.formatFunctions = {count:0}; + +// private +Date.prototype.dateFormat = function(format) { + if (Date.formatFunctions[format] == null) { + Date.createNewFormat(format); + } + var func = Date.formatFunctions[format]; + return this[func](); +}; + + +/** + * Formats a date given the supplied format string + * @param {String} format The format string + * @return {String} The formatted date + * @method + */ +Date.prototype.format = Date.prototype.dateFormat; + +// private +Date.createNewFormat = function(format) { + var funcName = "format" + Date.formatFunctions.count++; + Date.formatFunctions[format] = funcName; + var code = "Date.prototype." + funcName + " = function(){return "; + var special = false; + var ch = ''; + for (var i = 0; i < format.length; ++i) { + ch = format.charAt(i); + if (!special && ch == "\\") { + special = true; + } + else if (special) { + special = false; + code += "'" + String.escape(ch) + "' + "; + } + else { + code += Date.getFormatCode(ch); + } + } + /** eval:var:zzzzzzzzzzzzz */ + eval(code.substring(0, code.length - 3) + ";}"); +}; + +// private +Date.getFormatCode = function(character) { + switch (character) { + case "d": + return "String.leftPad(this.getDate(), 2, '0') + "; + case "D": + return "Date.dayNames[this.getDay()].substring(0, 3) + "; + case "j": + return "this.getDate() + "; + case "l": + return "Date.dayNames[this.getDay()] + "; + case "S": + return "this.getSuffix() + "; + case "w": + return "this.getDay() + "; + case "z": + return "this.getDayOfYear() + "; + case "W": + return "this.getWeekOfYear() + "; + case "F": + return "Date.monthNames[this.getMonth()] + "; + case "m": + return "String.leftPad(this.getMonth() + 1, 2, '0') + "; + case "M": + return "Date.monthNames[this.getMonth()].substring(0, 3) + "; + case "n": + return "(this.getMonth() + 1) + "; + case "t": + return "this.getDaysInMonth() + "; + case "L": + return "(this.isLeapYear() ? 1 : 0) + "; + case "Y": + return "this.getFullYear() + "; + case "y": + return "('' + this.getFullYear()).substring(2, 4) + "; + case "a": + return "(this.getHours() < 12 ? 'am' : 'pm') + "; + case "A": + return "(this.getHours() < 12 ? 'AM' : 'PM') + "; + case "g": + return "((this.getHours() % 12) ? this.getHours() % 12 : 12) + "; + case "G": + return "this.getHours() + "; + case "h": + return "String.leftPad((this.getHours() % 12) ? this.getHours() % 12 : 12, 2, '0') + "; + case "H": + return "String.leftPad(this.getHours(), 2, '0') + "; + case "i": + return "String.leftPad(this.getMinutes(), 2, '0') + "; + case "s": + return "String.leftPad(this.getSeconds(), 2, '0') + "; + case "O": + return "this.getGMTOffset() + "; + case "P": + return "this.getGMTColonOffset() + "; + case "T": + return "this.getTimezone() + "; + case "Z": + return "(this.getTimezoneOffset() * -60) + "; + default: + return "'" + String.escape(character) + "' + "; + } +}; + +/** + * Parses the passed string using the specified format. Note that this function expects dates in normal calendar + * format, meaning that months are 1-based (1 = January) and not zero-based like in JavaScript dates. Any part of + * the date format that is not specified will default to the current date value for that part. Time parts can also + * be specified, but default to 0. Keep in mind that the input date string must precisely match the specified format + * string or the parse operation will fail. + * Example Usage: +<pre><code> +//dt = Fri May 25 2007 (current date) +var dt = new Date(); + +//dt = Thu May 25 2006 (today's month/day in 2006) +dt = Date.parseDate("2006", "Y"); + +//dt = Sun Jan 15 2006 (all date parts specified) +dt = Date.parseDate("2006-1-15", "Y-m-d"); + +//dt = Sun Jan 15 2006 15:20:01 GMT-0600 (CST) +dt = Date.parseDate("2006-1-15 3:20:01 PM", "Y-m-d h:i:s A" ); +</code></pre> + * @param {String} input The unparsed date as a string + * @param {String} format The format the date is in + * @return {Date} The parsed date + * @static + */ +Date.parseDate = function(input, format) { + if (Date.parseFunctions[format] == null) { + Date.createParser(format); + } + var func = Date.parseFunctions[format]; + return Date[func](input); +}; +/** + * @private + */ + +Date.createParser = function(format) { + var funcName = "parse" + Date.parseFunctions.count++; + var regexNum = Date.parseRegexes.length; + var currentGroup = 1; + Date.parseFunctions[format] = funcName; + + var code = "Date." + funcName + " = function(input){\n" + + "var y = -1, m = -1, d = -1, h = -1, i = -1, s = -1, o, z, v;\n" + + "var d = new Date();\n" + + "y = d.getFullYear();\n" + + "m = d.getMonth();\n" + + "d = d.getDate();\n" + + "if (typeof(input) !== 'string') { input = input.toString(); }\n" + + "var results = input.match(Date.parseRegexes[" + regexNum + "]);\n" + + "if (results && results.length > 0) {"; + var regex = ""; + + var special = false; + var ch = ''; + for (var i = 0; i < format.length; ++i) { + ch = format.charAt(i); + if (!special && ch == "\\") { + special = true; + } + else if (special) { + special = false; + regex += String.escape(ch); + } + else { + var obj = Date.formatCodeToRegex(ch, currentGroup); + currentGroup += obj.g; + regex += obj.s; + if (obj.g && obj.c) { + code += obj.c; + } + } + } + + code += "if (y >= 0 && m >= 0 && d > 0 && h >= 0 && i >= 0 && s >= 0)\n" + + "{v = new Date(y, m, d, h, i, s);}\n" + + "else if (y >= 0 && m >= 0 && d > 0 && h >= 0 && i >= 0)\n" + + "{v = new Date(y, m, d, h, i);}\n" + + "else if (y >= 0 && m >= 0 && d > 0 && h >= 0)\n" + + "{v = new Date(y, m, d, h);}\n" + + "else if (y >= 0 && m >= 0 && d > 0)\n" + + "{v = new Date(y, m, d);}\n" + + "else if (y >= 0 && m >= 0)\n" + + "{v = new Date(y, m);}\n" + + "else if (y >= 0)\n" + + "{v = new Date(y);}\n" + + "}return (v && (z || o))?\n" // favour UTC offset over GMT offset + + " ((z)? v.add(Date.SECOND, (v.getTimezoneOffset() * 60) + (z*1)) :\n" // reset to UTC, then add offset + + " v.add(Date.HOUR, (v.getGMTOffset() / 100) + (o / -100))) : v\n" // reset to GMT, then add offset + + ";}"; + + Date.parseRegexes[regexNum] = new RegExp("^" + regex + "$"); + /** eval:var:zzzzzzzzzzzzz */ + eval(code); +}; + +// private +Date.formatCodeToRegex = function(character, currentGroup) { + switch (character) { + case "D": + return {g:0, + c:null, + s:"(?:Sun|Mon|Tue|Wed|Thu|Fri|Sat)"}; + case "j": + return {g:1, + c:"d = parseInt(results[" + currentGroup + "], 10);\n", + s:"(\\d{1,2})"}; // day of month without leading zeroes + case "d": + return {g:1, + c:"d = parseInt(results[" + currentGroup + "], 10);\n", + s:"(\\d{2})"}; // day of month with leading zeroes + case "l": + return {g:0, + c:null, + s:"(?:" + Date.dayNames.join("|") + ")"}; + case "S": + return {g:0, + c:null, + s:"(?:st|nd|rd|th)"}; + case "w": + return {g:0, + c:null, + s:"\\d"}; + case "z": + return {g:0, + c:null, + s:"(?:\\d{1,3})"}; + case "W": + return {g:0, + c:null, + s:"(?:\\d{2})"}; + case "F": + return {g:1, + c:"m = parseInt(Date.monthNumbers[results[" + currentGroup + "].substring(0, 3)], 10);\n", + s:"(" + Date.monthNames.join("|") + ")"}; + case "M": + return {g:1, + c:"m = parseInt(Date.monthNumbers[results[" + currentGroup + "]], 10);\n", + s:"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)"}; + case "n": + return {g:1, + c:"m = parseInt(results[" + currentGroup + "], 10) - 1;\n", + s:"(\\d{1,2})"}; // Numeric representation of a month, without leading zeros + case "m": + return {g:1, + c:"m = parseInt(results[" + currentGroup + "], 10) - 1;\n", + s:"(\\d{2})"}; // Numeric representation of a month, with leading zeros + case "t": + return {g:0, + c:null, + s:"\\d{1,2}"}; + case "L": + return {g:0, + c:null, + s:"(?:1|0)"}; + case "Y": + return {g:1, + c:"y = parseInt(results[" + currentGroup + "], 10);\n", + s:"(\\d{4})"}; + case "y": + return {g:1, + c:"var ty = parseInt(results[" + currentGroup + "], 10);\n" + + "y = ty > Date.y2kYear ? 1900 + ty : 2000 + ty;\n", + s:"(\\d{1,2})"}; + case "a": + return {g:1, + c:"if (results[" + currentGroup + "] == 'am') {\n" + + "if (h == 12) { h = 0; }\n" + + "} else { if (h < 12) { h += 12; }}", + s:"(am|pm)"}; + case "A": + return {g:1, + c:"if (results[" + currentGroup + "] == 'AM') {\n" + + "if (h == 12) { h = 0; }\n" + + "} else { if (h < 12) { h += 12; }}", + s:"(AM|PM)"}; + case "g": + case "G": + return {g:1, + c:"h = parseInt(results[" + currentGroup + "], 10);\n", + s:"(\\d{1,2})"}; // 12/24-hr format format of an hour without leading zeroes + case "h": + case "H": + return {g:1, + c:"h = parseInt(results[" + currentGroup + "], 10);\n", + s:"(\\d{2})"}; // 12/24-hr format format of an hour with leading zeroes + case "i": + return {g:1, + c:"i = parseInt(results[" + currentGroup + "], 10);\n", + s:"(\\d{2})"}; + case "s": + return {g:1, + c:"s = parseInt(results[" + currentGroup + "], 10);\n", + s:"(\\d{2})"}; + case "O": + return {g:1, + c:[ + "o = results[", currentGroup, "];\n", + "var sn = o.substring(0,1);\n", // get + / - sign + "var hr = o.substring(1,3)*1 + Math.floor(o.substring(3,5) / 60);\n", // get hours (performs minutes-to-hour conversion also) + "var mn = o.substring(3,5) % 60;\n", // get minutes + "o = ((-12 <= (hr*60 + mn)/60) && ((hr*60 + mn)/60 <= 14))?\n", // -12hrs <= GMT offset <= 14hrs + " (sn + String.leftPad(hr, 2, 0) + String.leftPad(mn, 2, 0)) : null;\n" + ].join(""), + s:"([+\-]\\d{2,4})"}; + + + case "P": + return {g:1, + c:[ + "o = results[", currentGroup, "];\n", + "var sn = o.substring(0,1);\n", + "var hr = o.substring(1,3)*1 + Math.floor(o.substring(4,6) / 60);\n", + "var mn = o.substring(4,6) % 60;\n", + "o = ((-12 <= (hr*60 + mn)/60) && ((hr*60 + mn)/60 <= 14))?\n", + " (sn + String.leftPad(hr, 2, 0) + String.leftPad(mn, 2, 0)) : null;\n" + ].join(""), + s:"([+\-]\\d{4})"}; + case "T": + return {g:0, + c:null, + s:"[A-Z]{1,4}"}; // timezone abbrev. may be between 1 - 4 chars + case "Z": + return {g:1, + c:"z = results[" + currentGroup + "];\n" // -43200 <= UTC offset <= 50400 + + "z = (-43200 <= z*1 && z*1 <= 50400)? z : null;\n", + s:"([+\-]?\\d{1,5})"}; // leading '+' sign is optional for UTC offset + default: + return {g:0, + c:null, + s:String.escape(character)}; + } +}; + +/** + * Get the timezone abbreviation of the current date (equivalent to the format specifier 'T'). + * @return {String} The abbreviated timezone name (e.g. 'CST') + */ +Date.prototype.getTimezone = function() { + return this.toString().replace(/^.*? ([A-Z]{1,4})[\-+][0-9]{4} .*$/, "$1"); +}; + +/** + * Get the offset from GMT of the current date (equivalent to the format specifier 'O'). + * @return {String} The 4-character offset string prefixed with + or - (e.g. '-0600') + */ +Date.prototype.getGMTOffset = function() { + return (this.getTimezoneOffset() > 0 ? "-" : "+") + + String.leftPad(Math.abs(Math.floor(this.getTimezoneOffset() / 60)), 2, "0") + + String.leftPad(this.getTimezoneOffset() % 60, 2, "0"); +}; + +/** + * Get the offset from GMT of the current date (equivalent to the format specifier 'P'). + * @return {String} 2-characters representing hours and 2-characters representing minutes + * seperated by a colon and prefixed with + or - (e.g. '-06:00') + */ +Date.prototype.getGMTColonOffset = function() { + return (this.getTimezoneOffset() > 0 ? "-" : "+") + + String.leftPad(Math.abs(Math.floor(this.getTimezoneOffset() / 60)), 2, "0") + + ":" + + String.leftPad(this.getTimezoneOffset() %60, 2, "0"); +} + +/** + * Get the numeric day number of the year, adjusted for leap year. + * @return {Number} 0 through 364 (365 in leap years) + */ +Date.prototype.getDayOfYear = function() { + var num = 0; + Date.daysInMonth[1] = this.isLeapYear() ? 29 : 28; + for (var i = 0; i < this.getMonth(); ++i) { + num += Date.daysInMonth[i]; + } + return num + this.getDate() - 1; +}; + +/** + * Get the string representation of the numeric week number of the year + * (equivalent to the format specifier 'W'). + * @return {String} '00' through '52' + */ +Date.prototype.getWeekOfYear = function() { + // Skip to Thursday of this week + var now = this.getDayOfYear() + (4 - this.getDay()); + // Find the first Thursday of the year + var jan1 = new Date(this.getFullYear(), 0, 1); + var then = (7 - jan1.getDay() + 4); + return String.leftPad(((now - then) / 7) + 1, 2, "0"); +}; + +/** + * Whether or not the current date is in a leap year. + * @return {Boolean} True if the current date is in a leap year, else false + */ +Date.prototype.isLeapYear = function() { + var year = this.getFullYear(); + return ((year & 3) == 0 && (year % 100 || (year % 400 == 0 && year))); +}; + +/** + * Get the first day of the current month, adjusted for leap year. The returned value + * is the numeric day index within the week (0-6) which can be used in conjunction with + * the {@link #monthNames} array to retrieve the textual day name. + * Example: + *<pre><code> +var dt = new Date('1/10/2007'); +document.write(Date.dayNames[dt.getFirstDayOfMonth()]); //output: 'Monday' +</code></pre> + * @return {Number} The day number (0-6) + */ +Date.prototype.getFirstDayOfMonth = function() { + var day = (this.getDay() - (this.getDate() - 1)) % 7; + return (day < 0) ? (day + 7) : day; +}; + +/** + * Get the last day of the current month, adjusted for leap year. The returned value + * is the numeric day index within the week (0-6) which can be used in conjunction with + * the {@link #monthNames} array to retrieve the textual day name. + * Example: + *<pre><code> +var dt = new Date('1/10/2007'); +document.write(Date.dayNames[dt.getLastDayOfMonth()]); //output: 'Wednesday' +</code></pre> + * @return {Number} The day number (0-6) + */ +Date.prototype.getLastDayOfMonth = function() { + var day = (this.getDay() + (Date.daysInMonth[this.getMonth()] - this.getDate())) % 7; + return (day < 0) ? (day + 7) : day; +}; + + +/** + * Get the first date of this date's month + * @return {Date} + */ +Date.prototype.getFirstDateOfMonth = function() { + return new Date(this.getFullYear(), this.getMonth(), 1); +}; + +/** + * Get the last date of this date's month + * @return {Date} + */ +Date.prototype.getLastDateOfMonth = function() { + return new Date(this.getFullYear(), this.getMonth(), this.getDaysInMonth()); +}; +/** + * Get the number of days in the current month, adjusted for leap year. + * @return {Number} The number of days in the month + */ +Date.prototype.getDaysInMonth = function() { + Date.daysInMonth[1] = this.isLeapYear() ? 29 : 28; + return Date.daysInMonth[this.getMonth()]; +}; + +/** + * Get the English ordinal suffix of the current day (equivalent to the format specifier 'S'). + * @return {String} 'st, 'nd', 'rd' or 'th' + */ +Date.prototype.getSuffix = function() { + switch (this.getDate()) { + case 1: + case 21: + case 31: + return "st"; + case 2: + case 22: + return "nd"; + case 3: + case 23: + return "rd"; + default: + return "th"; + } +}; + +// private +Date.daysInMonth = [31,28,31,30,31,30,31,31,30,31,30,31]; + +/** + * An array of textual month names. + * Override these values for international dates, for example... + * Date.monthNames = ['JanInYourLang', 'FebInYourLang', ...]; + * @type Array + * @static + */ +Date.monthNames = + ["January", + "February", + "March", + "April", + "May", + "June", + "July", + "August", + "September", + "October", + "November", + "December"]; + +/** + * An array of textual day names. + * Override these values for international dates, for example... + * Date.dayNames = ['SundayInYourLang', 'MondayInYourLang', ...]; + * @type Array + * @static + */ +Date.dayNames = + ["Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday"]; + +// private +Date.y2kYear = 50; +// private +Date.monthNumbers = { + Jan:0, + Feb:1, + Mar:2, + Apr:3, + May:4, + Jun:5, + Jul:6, + Aug:7, + Sep:8, + Oct:9, + Nov:10, + Dec:11}; + +/** + * Creates and returns a new Date instance with the exact same date value as the called instance. + * Dates are copied and passed by reference, so if a copied date variable is modified later, the original + * variable will also be changed. When the intention is to create a new variable that will not + * modify the original instance, you should create a clone. + * + * Example of correctly cloning a date: + * <pre><code> +//wrong way: +var orig = new Date('10/1/2006'); +var copy = orig; +copy.setDate(5); +document.write(orig); //returns 'Thu Oct 05 2006'! + +//correct way: +var orig = new Date('10/1/2006'); +var copy = orig.clone(); +copy.setDate(5); +document.write(orig); //returns 'Thu Oct 01 2006' +</code></pre> + * @return {Date} The new Date instance + */ +Date.prototype.clone = function() { + return new Date(this.getTime()); +}; + +/** + * Clears any time information from this date + @param {Boolean} clone true to create a clone of this date, clear the time and return it + @return {Date} this or the clone + */ +Date.prototype.clearTime = function(clone){ + if(clone){ + return this.clone().clearTime(); + } + this.setHours(0); + this.setMinutes(0); + this.setSeconds(0); + this.setMilliseconds(0); + return this; +}; + +// private +// safari setMonth is broken -- check that this is only donw once... +if(Roo.isSafari && typeof(Date.brokenSetMonth) == 'undefined'){ + Date.brokenSetMonth = Date.prototype.setMonth; + Date.prototype.setMonth = function(num){ + if(num <= -1){ + var n = Math.ceil(-num); + var back_year = Math.ceil(n/12); + var month = (n % 12) ? 12 - n % 12 : 0 ; + this.setFullYear(this.getFullYear() - back_year); + return Date.brokenSetMonth.call(this, month); + } else { + return Date.brokenSetMonth.apply(this, arguments); + } + }; +} + +/** Date interval constant +* @static +* @type String */ +Date.MILLI = "ms"; +/** Date interval constant +* @static +* @type String */ +Date.SECOND = "s"; +/** Date interval constant +* @static +* @type String */ +Date.MINUTE = "mi"; +/** Date interval constant +* @static +* @type String */ +Date.HOUR = "h"; +/** Date interval constant +* @static +* @type String */ +Date.DAY = "d"; +/** Date interval constant +* @static +* @type String */ +Date.MONTH = "mo"; +/** Date interval constant +* @static +* @type String */ +Date.YEAR = "y"; + +/** + * Provides a convenient method of performing basic date arithmetic. This method + * does not modify the Date instance being called - it creates and returns + * a new Date instance containing the resulting date value. + * + * Examples: + * <pre><code> +//Basic usage: +var dt = new Date('10/29/2006').add(Date.DAY, 5); +document.write(dt); //returns 'Fri Oct 06 2006 00:00:00' + +//Negative values will subtract correctly: +var dt2 = new Date('10/1/2006').add(Date.DAY, -5); +document.write(dt2); //returns 'Tue Sep 26 2006 00:00:00' + +//You can even chain several calls together in one line! +var dt3 = new Date('10/1/2006').add(Date.DAY, 5).add(Date.HOUR, 8).add(Date.MINUTE, -30); +document.write(dt3); //returns 'Fri Oct 06 2006 07:30:00' + </code></pre> + * + * @param {String} interval A valid date interval enum value + * @param {Number} value The amount to add to the current date + * @return {Date} The new Date instance + */ +Date.prototype.add = function(interval, value){ + var d = this.clone(); + if (!interval || value === 0) { return d; } + switch(interval.toLowerCase()){ + case Date.MILLI: + d.setMilliseconds(this.getMilliseconds() + value); + break; + case Date.SECOND: + d.setSeconds(this.getSeconds() + value); + break; + case Date.MINUTE: + d.setMinutes(this.getMinutes() + value); + break; + case Date.HOUR: + d.setHours(this.getHours() + value); + break; + case Date.DAY: + d.setDate(this.getDate() + value); + break; + case Date.MONTH: + var day = this.getDate(); + if(day > 28){ + day = Math.min(day, this.getFirstDateOfMonth().add('mo', value).getLastDateOfMonth().getDate()); + } + d.setDate(day); + d.setMonth(this.getMonth() + value); + break; + case Date.YEAR: + d.setFullYear(this.getFullYear() + value); + break; + } + return d; +}; + \ No newline at end of file diff --git a/docs2/src/Function.js.html b/docs2/src/Function.js.html new file mode 100644 index 0000000000..fc56411619 --- /dev/null +++ b/docs2/src/Function.js.html @@ -0,0 +1,137 @@ +/home/alan/gitlive/roojs1/Function.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +(function() { + // wrappedn so fnCleanup is not in global scope... + if(Roo.isIE) { + function fnCleanUp() { + var p = Function.prototype; + delete p.createSequence; + delete p.defer; + delete p.createDelegate; + delete p.createCallback; + delete p.createInterceptor; + + window.detachEvent("onunload", fnCleanUp); + } + window.attachEvent("onunload", fnCleanUp); + } +})(); + + +/** + * @class Function + * These functions are available on every Function object (any JavaScript function). + */ +Roo.apply(Function.prototype, { + /** + * Creates a callback that passes arguments[0], arguments[1], arguments[2], ... + * Call directly on any function. Example: <code>myFunction.createCallback(myarg, myarg2)</code> + * Will create a function that is bound to those 2 args. + * @return {Function} The new function + */ + createCallback : function(/*args...*/){ + // make args available, in function below + var args = arguments; + var method = this; + return function() { + return method.apply(window, args); + }; + }, + + /** + * Creates a delegate (callback) that sets the scope to obj. + * Call directly on any function. Example: <code>this.myFunction.createDelegate(this)</code> + * Will create a function that is automatically scoped to this. + * @param {Object} obj (optional) The object for which the scope is set + * @param {Array} args (optional) Overrides arguments for the call. (Defaults to the arguments passed by the caller) + * @param {Boolean/Number} appendArgs (optional) if True args are appended to call args instead of overriding, + * if a number the args are inserted at the specified position + * @return {Function} The new function + */ + createDelegate : function(obj, args, appendArgs){ + var method = this; + return function() { + var callArgs = args || arguments; + if(appendArgs === true){ + callArgs = Array.prototype.slice.call(arguments, 0); + callArgs = callArgs.concat(args); + }else if(typeof appendArgs == "number"){ + callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first + var applyArgs = [appendArgs, 0].concat(args); // create method call params + Array.prototype.splice.apply(callArgs, applyArgs); // splice them in + } + return method.apply(obj || window, callArgs); + }; + }, + + /** + * Calls this function after the number of millseconds specified. + * @param {Number} millis The number of milliseconds for the setTimeout call (if 0 the function is executed immediately) + * @param {Object} obj (optional) The object for which the scope is set + * @param {Array} args (optional) Overrides arguments for the call. (Defaults to the arguments passed by the caller) + * @param {Boolean/Number} appendArgs (optional) if True args are appended to call args instead of overriding, + * if a number the args are inserted at the specified position + * @return {Number} The timeout id that can be used with clearTimeout + */ + defer : function(millis, obj, args, appendArgs){ + var fn = this.createDelegate(obj, args, appendArgs); + if(millis){ + return setTimeout(fn, millis); + } + fn(); + return 0; + }, + /** + * Create a combined function call sequence of the original function + the passed function. + * The resulting function returns the results of the original function. + * The passed fcn is called with the parameters of the original function + * @param {Function} fcn The function to sequence + * @param {Object} scope (optional) The scope of the passed fcn (Defaults to scope of original function or window) + * @return {Function} The new function + */ + createSequence : function(fcn, scope){ + if(typeof fcn != "function"){ + return this; + } + var method = this; + return function() { + var retval = method.apply(this || window, arguments); + fcn.apply(scope || this || window, arguments); + return retval; + }; + }, + + /** + * Creates an interceptor function. The passed fcn is called before the original one. If it returns false, the original one is not called. + * The resulting function returns the results of the original function. + * The passed fcn is called with the parameters of the original function. + * @addon + * @param {Function} fcn The function to call before the original + * @param {Object} scope (optional) The scope of the passed fcn (Defaults to scope of original function or window) + * @return {Function} The new function + */ + createInterceptor : function(fcn, scope){ + if(typeof fcn != "function"){ + return this; + } + var method = this; + return function() { + fcn.target = this; + fcn.method = method; + if(fcn.apply(scope || this || window, arguments) === false){ + return; + } + return method.apply(this || window, arguments); + }; + } +}); + \ No newline at end of file diff --git a/docs2/src/Number.js.html b/docs2/src/Number.js.html new file mode 100644 index 0000000000..5ebdd52ae3 --- /dev/null +++ b/docs2/src/Number.js.html @@ -0,0 +1,27 @@ +/home/alan/gitlive/roojs1/Number.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + /** + * @class Number + */ +Roo.applyIf(Number.prototype, { + /** + * Checks whether or not the current number is within a desired range. If the number is already within the + * range it is returned, otherwise the min or max value is returned depending on which side of the range is + * exceeded. Note that this method returns the constrained value but does not change the current number. + * @param {Number} min The minimum number in the range + * @param {Number} max The maximum number in the range + * @return {Number} The constrained value if outside the range, otherwise the current value + */ + constrain : function(min, max){ + return Math.min(Math.max(this, min), max); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo.js.html b/docs2/src/Roo.js.html new file mode 100644 index 0000000000..4e57d8fd42 --- /dev/null +++ b/docs2/src/Roo.js.html @@ -0,0 +1,683 @@ +/home/alan/gitlive/roojs1/Roo.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + + + + +// for old browsers +window["undefined"] = window["undefined"]; + +/** + * @class Roo + * Roo core utilities and functions. + * @singleton + */ +var Roo = {}; +/** + * Copies all the properties of config to obj. + * @param {Object} obj The receiver of the properties + * @param {Object} config The source of the properties + * @param {Object} defaults A different object that will also be applied for default values + * @return {Object} returns obj + * @member Roo apply + */ + + +Roo.apply = function(o, c, defaults){ + if(defaults){ + // no "this" reference for friendly out of scope calls + Roo.apply(o, defaults); + } + if(o && c && typeof c == 'object'){ + for(var p in c){ + o[p] = c[p]; + } + } + return o; +}; + + +(function(){ + var idSeed = 0; + var ua = navigator.userAgent.toLowerCase(); + + var isStrict = document.compatMode == "CSS1Compat", + isOpera = ua.indexOf("opera") > -1, + isSafari = (/webkit|khtml/).test(ua), + isFirefox = ua.indexOf("firefox") > -1, + isIE = ua.indexOf("msie") > -1, + isIE7 = ua.indexOf("msie 7") > -1, + isIE11 = /trident.*rv\:11\./.test(ua), + isEdge = ua.indexOf("edge") > -1, + isGecko = !isSafari && ua.indexOf("gecko") > -1, + isBorderBox = isIE && !isStrict, + isWindows = (ua.indexOf("windows") != -1 || ua.indexOf("win32") != -1), + isMac = (ua.indexOf("macintosh") != -1 || ua.indexOf("mac os x") != -1), + isLinux = (ua.indexOf("linux") != -1), + isSecure = window.location.href.toLowerCase().indexOf("https") === 0, + isIOS = /iphone|ipad/.test(ua), + isAndroid = /android/.test(ua), + isTouch = (function() { + try { + if (ua.indexOf('chrome') != -1 && ua.indexOf('android') == -1) { + window.addEventListener('touchstart', function __set_has_touch__ () { + Roo.isTouch = true; + window.removeEventListener('touchstart', __set_has_touch__); + }); + return false; // no touch on chrome!? + } + document.createEvent("TouchEvent"); + return true; + } catch (e) { + return false; + } + + })(); + // remove css image flicker + if(isIE && !isIE7){ + try{ + document.execCommand("BackgroundImageCache", false, true); + }catch(e){} + } + + Roo.apply(Roo, { + /** + * True if the browser is in strict mode + * @type Boolean + */ + isStrict : isStrict, + /** + * True if the page is running over SSL + * @type Boolean + */ + isSecure : isSecure, + /** + * True when the document is fully initialized and ready for action + * @type Boolean + */ + isReady : false, + /** + * Turn on debugging output (currently only the factory uses this) + * @type Boolean + */ + + debug: false, + + /** + * True to automatically uncache orphaned Roo.Elements periodically (defaults to true) + * @type Boolean + */ + enableGarbageCollector : true, + + /** + * True to automatically purge event listeners after uncaching an element (defaults to false). + * Note: this only happens if enableGarbageCollector is true. + * @type Boolean + */ + enableListenerCollection:false, + + /** + * URL to a blank file used by Roo when in secure mode for iframe src and onReady src to prevent + * the IE insecure content warning (defaults to javascript:false). + * @type String + */ + SSL_SECURE_URL : "javascript:false", + + /** + * URL to a 1x1 transparent gif image used by Roo to create inline icons with CSS background images. (Defaults to + * "http://Roojs.com/s.gif" and you should change this to a URL on your server). + * @type String + */ + BLANK_IMAGE_URL : "http:/"+"/localhost/s.gif", + + emptyFn : function(){}, + + /** + * Copies all the properties of config to obj if they don't already exist. + * @param {Object} obj The receiver of the properties + * @param {Object} config The source of the properties + * @return {Object} returns obj + */ + applyIf : function(o, c){ + if(o && c){ + for(var p in c){ + if(typeof o[p] == "undefined"){ o[p] = c[p]; } + } + } + return o; + }, + + /** + * Applies event listeners to elements by selectors when the document is ready. + * The event name is specified with an @ suffix. +<pre><code> +Roo.addBehaviors({ + // add a listener for click on all anchors in element with id foo + '#foo a@click' : function(e, t){ + // do something + }, + + // add the same listener to multiple selectors (separated by comma BEFORE the @) + '#foo a, #bar span.some-class@mouseover' : function(){ + // do something + } +}); +</code></pre> + * @param {Object} obj The list of behaviors to apply + */ + addBehaviors : function(o){ + if(!Roo.isReady){ + Roo.onReady(function(){ + Roo.addBehaviors(o); + }); + return; + } + var cache = {}; // simple cache for applying multiple behaviors to same selector does query multiple times + for(var b in o){ + var parts = b.split('@'); + if(parts[1]){ // for Object prototype breakers + var s = parts[0]; + if(!cache[s]){ + cache[s] = Roo.select(s); + } + cache[s].on(parts[1], o[b]); + } + } + cache = null; + }, + + /** + * Generates unique ids. If the element already has an id, it is unchanged + * @param {String/HTMLElement/Element} el (optional) The element to generate an id for + * @param {String} prefix (optional) Id prefix (defaults "Roo-gen") + * @return {String} The generated Id. + */ + id : function(el, prefix){ + prefix = prefix || "roo-gen"; + el = Roo.getDom(el); + var id = prefix + (++idSeed); + return el ? (el.id ? el.id : (el.id = id)) : id; + }, + + + /** + * Extends one class with another class and optionally overrides members with the passed literal. This class + * also adds the function "override()" to the class that can be used to override + * members on an instance. + * @param {Object} subclass The class inheriting the functionality + * @param {Object} superclass The class being extended + * @param {Object} overrides (optional) A literal with members + * @method extend + */ + extend : function(){ + // inline overrides + var io = function(o){ + for(var m in o){ + this[m] = o[m]; + } + }; + return function(sb, sp, overrides){ + if(typeof sp == 'object'){ // eg. prototype, rather than function constructor.. + overrides = sp; + sp = sb; + sb = function(){sp.apply(this, arguments);}; + } + var F = function(){}, sbp, spp = sp.prototype; + F.prototype = spp; + sbp = sb.prototype = new F(); + sbp.constructor=sb; + sb.superclass=spp; + + if(spp.constructor == Object.prototype.constructor){ + spp.constructor=sp; + + } + + sb.override = function(o){ + Roo.override(sb, o); + }; + sbp.override = io; + Roo.override(sb, overrides); + return sb; + }; + }(), + + /** + * Adds a list of functions to the prototype of an existing class, overwriting any existing methods with the same name. + * Usage:<pre><code> +Roo.override(MyClass, { + newMethod1: function(){ + // etc. + }, + newMethod2: function(foo){ + // etc. + } +}); + </code></pre> + * @param {Object} origclass The class to override + * @param {Object} overrides The list of functions to add to origClass. This should be specified as an object literal + * containing one or more methods. + * @method override + */ + override : function(origclass, overrides){ + if(overrides){ + var p = origclass.prototype; + for(var method in overrides){ + p[method] = overrides[method]; + } + } + }, + /** + * Creates namespaces to be used for scoping variables and classes so that they are not global. Usage: + * <pre><code> +Roo.namespace('Company', 'Company.data'); +Company.Widget = function() { ... } +Company.data.CustomStore = function(config) { ... } +</code></pre> + * @param {String} namespace1 + * @param {String} namespace2 + * @param {String} etc + * @method namespace + */ + namespace : function(){ + var a=arguments, o=null, i, j, d, rt; + for (i=0; i<a.length; ++i) { + d=a[i].split("."); + rt = d[0]; + /** eval:var:o */ + eval('if (typeof ' + rt + ' == "undefined"){' + rt + ' = {};} o = ' + rt + ';'); + for (j=1; j<d.length; ++j) { + o[d[j]]=o[d[j]] || {}; + o=o[d[j]]; + } + } + }, + /** + * Creates namespaces to be used for scoping variables and classes so that they are not global. Usage: + * <pre><code> +Roo.factory({ xns: Roo.data, xtype : 'Store', .....}); +Roo.factory(conf, Roo.data); +</code></pre> + * @param {String} classname + * @param {String} namespace (optional) + * @method factory + */ + + factory : function(c, ns) + { + // no xtype, no ns or c.xns - or forced off by c.xns + if (!c.xtype || (!ns && !c.xns) || (c.xns === false)) { // not enough info... + return c; + } + ns = c.xns ? c.xns : ns; // if c.xns is set, then use that.. + if (c.constructor == ns[c.xtype]) {// already created... + return c; + } + if (ns[c.xtype]) { + if (Roo.debug) { Roo.log("Roo.Factory(" + c.xtype + ")"); } + var ret = new ns[c.xtype](c); + ret.xns = false; + return ret; + } + c.xns = false; // prevent recursion.. + return c; + }, + /** + * Logs to console if it can. + * + * @param {String|Object} string + * @method log + */ + log : function(s) + { + if ((typeof(console) == 'undefined') || (typeof(console.log) == 'undefined')) { + return; // alerT? + } + + console.log(s); + }, + /** + * Takes an object and converts it to an encoded URL. e.g. Roo.urlEncode({foo: 1, bar: 2}); would return "foo=1&bar=2". Optionally, property values can be arrays, instead of keys and the resulting string that's returned will contain a name/value pair for each array value. + * @param {Object} o + * @return {String} + */ + urlEncode : function(o){ + if(!o){ + return ""; + } + var buf = []; + for(var key in o){ + var ov = o[key], k = Roo.encodeURIComponent(key); + var type = typeof ov; + if(type == 'undefined'){ + buf.push(k, "=&"); + }else if(type != "function" && type != "object"){ + buf.push(k, "=", Roo.encodeURIComponent(ov), "&"); + }else if(ov instanceof Array){ + if (ov.length) { + for(var i = 0, len = ov.length; i < len; i++) { + buf.push(k, "=", Roo.encodeURIComponent(ov[i] === undefined ? '' : ov[i]), "&"); + } + } else { + buf.push(k, "=&"); + } + } + } + buf.pop(); + return buf.join(""); + }, + /** + * Safe version of encodeURIComponent + * @param {String} data + * @return {String} + */ + + encodeURIComponent : function (data) + { + try { + return encodeURIComponent(data); + } catch(e) {} // should be an uri encode error. + + if (data == '' || data == null){ + return ''; + } + // http://stackoverflow.com/questions/2596483/unicode-and-uri-encoding-decoding-and-escaping-in-javascript + function nibble_to_hex(nibble){ + var chars = '0123456789ABCDEF'; + return chars.charAt(nibble); + } + data = data.toString(); + var buffer = ''; + for(var i=0; i<data.length; i++){ + var c = data.charCodeAt(i); + var bs = new Array(); + if (c > 0x10000){ + // 4 bytes + bs[0] = 0xF0 | ((c & 0x1C0000) >>> 18); + bs[1] = 0x80 | ((c & 0x3F000) >>> 12); + bs[2] = 0x80 | ((c & 0xFC0) >>> 6); + bs[3] = 0x80 | (c & 0x3F); + }else if (c > 0x800){ + // 3 bytes + bs[0] = 0xE0 | ((c & 0xF000) >>> 12); + bs[1] = 0x80 | ((c & 0xFC0) >>> 6); + bs[2] = 0x80 | (c & 0x3F); + }else if (c > 0x80){ + // 2 bytes + bs[0] = 0xC0 | ((c & 0x7C0) >>> 6); + bs[1] = 0x80 | (c & 0x3F); + }else{ + // 1 byte + bs[0] = c; + } + for(var j=0; j<bs.length; j++){ + var b = bs[j]; + var hex = nibble_to_hex((b & 0xF0) >>> 4) + + nibble_to_hex(b &0x0F); + buffer += '%'+hex; + } + } + return buffer; + + }, + + /** + * Takes an encoded URL and and converts it to an object. e.g. Roo.urlDecode("foo=1&bar=2"); would return {foo: 1, bar: 2} or Roo.urlDecode("foo=1&bar=2&bar=3&bar=4", true); would return {foo: 1, bar: [2, 3, 4]}. + * @param {String} string + * @param {Boolean} overwrite (optional) Items of the same name will overwrite previous values instead of creating an an array (Defaults to false). + * @return {Object} A literal with members + */ + urlDecode : function(string, overwrite){ + if(!string || !string.length){ + return {}; + } + var obj = {}; + var pairs = string.split('&'); + var pair, name, value; + for(var i = 0, len = pairs.length; i < len; i++){ + pair = pairs[i].split('='); + name = decodeURIComponent(pair[0]); + value = decodeURIComponent(pair[1]); + if(overwrite !== true){ + if(typeof obj[name] == "undefined"){ + obj[name] = value; + }else if(typeof obj[name] == "string"){ + obj[name] = [obj[name]]; + obj[name].push(value); + }else{ + obj[name].push(value); + } + }else{ + obj[name] = value; + } + } + return obj; + }, + + /** + * Iterates an array calling the passed function with each item, stopping if your function returns false. If the + * passed array is not really an array, your function is called once with it. + * The supplied function is called with (Object item, Number index, Array allItems). + * @param {Array/NodeList/Mixed} array + * @param {Function} fn + * @param {Object} scope + */ + each : function(array, fn, scope){ + if(typeof array.length == "undefined" || typeof array == "string"){ + array = [array]; + } + for(var i = 0, len = array.length; i < len; i++){ + if(fn.call(scope || array[i], array[i], i, array) === false){ return i; }; + } + }, + + // deprecated + combine : function(){ + var as = arguments, l = as.length, r = []; + for(var i = 0; i < l; i++){ + var a = as[i]; + if(a instanceof Array){ + r = r.concat(a); + }else if(a.length !== undefined && !a.substr){ + r = r.concat(Array.prototype.slice.call(a, 0)); + }else{ + r.push(a); + } + } + return r; + }, + + /** + * Escapes the passed string for use in a regular expression + * @param {String} str + * @return {String} + */ + escapeRe : function(s) { + return s.replace(/([.*+?^${}()|[\]\/\\])/g, "\\$1"); + }, + + // internal + callback : function(cb, scope, args, delay){ + if(typeof cb == "function"){ + if(delay){ + cb.defer(delay, scope, args || []); + }else{ + cb.apply(scope, args || []); + } + } + }, + + /** + * Return the dom node for the passed string (id), dom node, or Roo.Element + * @param {String/HTMLElement/Roo.Element} el + * @return HTMLElement + */ + getDom : function(el){ + if(!el){ + return null; + } + return el.dom ? el.dom : (typeof el == 'string' ? document.getElementById(el) : el); + }, + + /** + * Shorthand for {@link Roo.ComponentMgr#get} + * @param {String} id + * @return Roo.Component + */ + getCmp : function(id){ + return Roo.ComponentMgr.get(id); + }, + + num : function(v, defaultValue){ + if(typeof v != 'number'){ + return defaultValue; + } + return v; + }, + + destroy : function(){ + for(var i = 0, a = arguments, len = a.length; i < len; i++) { + var as = a[i]; + if(as){ + if(as.dom){ + as.removeAllListeners(); + as.remove(); + continue; + } + if(typeof as.purgeListeners == 'function'){ + as.purgeListeners(); + } + if(typeof as.destroy == 'function'){ + as.destroy(); + } + } + } + }, + + // inpired by a similar function in mootools library + /** + * Returns the type of object that is passed in. If the object passed in is null or undefined it + * return false otherwise it returns one of the following values:<ul> + * <li><b>string</b>: If the object passed is a string</li> + * <li><b>number</b>: If the object passed is a number</li> + * <li><b>boolean</b>: If the object passed is a boolean value</li> + * <li><b>function</b>: If the object passed is a function reference</li> + * <li><b>object</b>: If the object passed is an object</li> + * <li><b>array</b>: If the object passed is an array</li> + * <li><b>regexp</b>: If the object passed is a regular expression</li> + * <li><b>element</b>: If the object passed is a DOM Element</li> + * <li><b>nodelist</b>: If the object passed is a DOM NodeList</li> + * <li><b>textnode</b>: If the object passed is a DOM text node and contains something other than whitespace</li> + * <li><b>whitespace</b>: If the object passed is a DOM text node and contains only whitespace</li> + * @param {Mixed} object + * @return {String} + */ + type : function(o){ + if(o === undefined || o === null){ + return false; + } + if(o.htmlElement){ + return 'element'; + } + var t = typeof o; + if(t == 'object' && o.nodeName) { + switch(o.nodeType) { + case 1: return 'element'; + case 3: return (/\S/).test(o.nodeValue) ? 'textnode' : 'whitespace'; + } + } + if(t == 'object' || t == 'function') { + switch(o.constructor) { + case Array: return 'array'; + case RegExp: return 'regexp'; + } + if(typeof o.length == 'number' && typeof o.item == 'function') { + return 'nodelist'; + } + } + return t; + }, + + /** + * Returns true if the passed value is null, undefined or an empty string (optional). + * @param {Mixed} value The value to test + * @param {Boolean} allowBlank (optional) Pass true if an empty string is not considered empty + * @return {Boolean} + */ + isEmpty : function(v, allowBlank){ + return v === null || v === undefined || (!allowBlank ? v === '' : false); + }, + + /** @type Boolean */ + isOpera : isOpera, + /** @type Boolean */ + isSafari : isSafari, + /** @type Boolean */ + isFirefox : isFirefox, + /** @type Boolean */ + isIE : isIE, + /** @type Boolean */ + isIE7 : isIE7, + /** @type Boolean */ + isIE11 : isIE11, + /** @type Boolean */ + isEdge : isEdge, + /** @type Boolean */ + isGecko : isGecko, + /** @type Boolean */ + isBorderBox : isBorderBox, + /** @type Boolean */ + isWindows : isWindows, + /** @type Boolean */ + isLinux : isLinux, + /** @type Boolean */ + isMac : isMac, + /** @type Boolean */ + isIOS : isIOS, + /** @type Boolean */ + isAndroid : isAndroid, + /** @type Boolean */ + isTouch : isTouch, + + /** + * By default, Ext intelligently decides whether floating elements should be shimmed. If you are using flash, + * you may want to set this to true. + * @type Boolean + */ + useShims : ((isIE && !isIE7) || (isGecko && isMac)), + + + + /** + * Selects a single element as a Roo Element + * This is about as close as you can get to jQuery's $('do crazy stuff') + * @param {String} selector The selector/xpath query + * @param {Node} root (optional) The start of the query (defaults to document). + * @return {Roo.Element} + */ + selectNode : function(selector, root) + { + var node = Roo.DomQuery.selectNode(selector,root); + return node ? Roo.get(node) : new Roo.Element(false); + } + + }); + + +})(); + +Roo.namespace("Roo", "Roo.util", "Roo.grid", "Roo.dd", "Roo.tree", "Roo.data", + "Roo.form", "Roo.menu", "Roo.state", "Roo.lib", "Roo.layout", + "Roo.app", "Roo.ux", + "Roo.bootstrap", + "Roo.bootstrap.dash"); + \ No newline at end of file diff --git a/docs2/src/Roo_Ajax.js.html b/docs2/src/Roo_Ajax.js.html new file mode 100644 index 0000000000..666a1a4a55 --- /dev/null +++ b/docs2/src/Roo_Ajax.js.html @@ -0,0 +1,44 @@ +/home/alan/gitlive/roojs1/Roo/Ajax.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * Global Ajax request class. + * + * @class Roo.Ajax + * @extends Roo.data.Connection + * @static + * + * @cfg {String} url The default URL to be used for requests to the server. (defaults to undefined) + * @cfg {Object} extraParams An object containing properties which are used as extra parameters to each request made by this object. (defaults to undefined) + * @cfg {Object} defaultHeaders An object containing request headers which are added to each request made by this object. (defaults to undefined) + * @cfg {String} method (Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET) + * @cfg {Number} timeout (Optional) The timeout in milliseconds to be used for requests. (defaults to 30000) + * @cfg {Boolean} autoAbort (Optional) Whether a new request should abort any pending requests. (defaults to false) + * @cfg {Boolean} disableCaching (Optional) True to add a unique cache-buster param to GET requests. (defaults to true) + */ +Roo.Ajax = new Roo.data.Connection({ + // fix up the docs + /** + * @scope Roo.Ajax + * @type {Boolear} + */ + autoAbort : false, + + /** + * Serialize the passed form into a url encoded string + * @scope Roo.Ajax + * @param {String/HTMLElement} form + * @return {String} + */ + serializeForm : function(form){ + return Roo.lib.Ajax.serializeForm(form); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_BasicDialog.js.html b/docs2/src/Roo_BasicDialog.js.html new file mode 100644 index 0000000000..978594d37c --- /dev/null +++ b/docs2/src/Roo_BasicDialog.js.html @@ -0,0 +1,1255 @@ +/home/alan/gitlive/roojs1/Roo/BasicDialog.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.BasicDialog + * @extends Roo.util.Observable + * Lightweight Dialog Class. The code below shows the creation of a typical dialog using existing HTML markup: + * <pre><code> +var dlg = new Roo.BasicDialog("my-dlg", { + height: 200, + width: 300, + minHeight: 100, + minWidth: 150, + modal: true, + proxyDrag: true, + shadow: true +}); +dlg.addKeyListener(27, dlg.hide, dlg); // ESC can also close the dialog +dlg.addButton('OK', dlg.hide, dlg); // Could call a save function instead of hiding +dlg.addButton('Cancel', dlg.hide, dlg); +dlg.show(); +</code></pre> + <b>A Dialog should always be a direct child of the body element.</b> + * @cfg {Boolean/DomHelper} autoCreate True to auto create from scratch, or using a DomHelper Object (defaults to false) + * @cfg {String} title Default text to display in the title bar (defaults to null) + * @cfg {Number} width Width of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified. + * @cfg {Number} height Height of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified. + * @cfg {Number} x The default left page coordinate of the dialog (defaults to center screen) + * @cfg {Number} y The default top page coordinate of the dialog (defaults to center screen) + * @cfg {String/Element} animateTarget Id or element from which the dialog should animate while opening + * (defaults to null with no animation) + * @cfg {Boolean} resizable False to disable manual dialog resizing (defaults to true) + * @cfg {String} resizeHandles Which resize handles to display - see the {@link Roo.Resizable} handles config + * property for valid values (defaults to 'all') + * @cfg {Number} minHeight The minimum allowable height for a resizable dialog (defaults to 80) + * @cfg {Number} minWidth The minimum allowable width for a resizable dialog (defaults to 200) + * @cfg {Boolean} modal True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false) + * @cfg {Boolean} autoScroll True to allow the dialog body contents to overflow and display scrollbars (defaults to false) + * @cfg {Boolean} closable False to remove the built-in top-right corner close button (defaults to true) + * @cfg {Boolean} collapsible False to remove the built-in top-right corner collapse button (defaults to true) + * @cfg {Boolean} constraintoviewport True to keep the dialog constrained within the visible viewport boundaries (defaults to true) + * @cfg {Boolean} syncHeightBeforeShow True to cause the dimensions to be recalculated before the dialog is shown (defaults to false) + * @cfg {Boolean} draggable False to disable dragging of the dialog within the viewport (defaults to true) + * @cfg {Boolean} autoTabs If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false) + * @cfg {String} tabTag The tag name of tab elements, used when autoTabs = true (defaults to 'div') + * @cfg {Boolean} proxyDrag True to drag a lightweight proxy element rather than the dialog itself, used when + * draggable = true (defaults to false) + * @cfg {Boolean} fixedcenter True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false) + * @cfg {Boolean/String} shadow True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right + * shadow (defaults to false) + * @cfg {Number} shadowOffset The number of pixels to offset the shadow if displayed (defaults to 5) + * @cfg {String} buttonAlign Valid values are "left," "center" and "right" (defaults to "right") + * @cfg {Number} minButtonWidth Minimum width of all dialog buttons (defaults to 75) + * @cfg {Array} buttons Array of buttons + * @cfg {Boolean} shim True to create an iframe shim that prevents selects from showing through (defaults to false) + * @constructor + * Create a new BasicDialog. + * @param {String/HTMLElement/Roo.Element} el The container element or DOM node, or its id + * @param {Object} config Configuration options + */ +Roo.BasicDialog = function(el, config){ + this.el = Roo.get(el); + var dh = Roo.DomHelper; + if(!this.el && config && config.autoCreate){ + if(typeof config.autoCreate == "object"){ + if(!config.autoCreate.id){ + config.autoCreate.id = el; + } + this.el = dh.append(document.body, + config.autoCreate, true); + }else{ + this.el = dh.append(document.body, + {tag: "div", id: el, style:'visibility:hidden;'}, true); + } + } + el = this.el; + el.setDisplayed(true); + el.hide = this.hideAction; + this.id = el.id; + el.addClass("x-dlg"); + + Roo.apply(this, config); + + this.proxy = el.createProxy("x-dlg-proxy"); + this.proxy.hide = this.hideAction; + this.proxy.setOpacity(.5); + this.proxy.hide(); + + if(config.width){ + el.setWidth(config.width); + } + if(config.height){ + el.setHeight(config.height); + } + this.size = el.getSize(); + if(typeof config.x != "undefined" && typeof config.y != "undefined"){ + this.xy = [config.x,config.y]; + }else{ + this.xy = el.getCenterXY(true); + } + /** The header element @type Roo.Element */ + this.header = el.child("> .x-dlg-hd"); + /** The body element @type Roo.Element */ + this.body = el.child("> .x-dlg-bd"); + /** The footer element @type Roo.Element */ + this.footer = el.child("> .x-dlg-ft"); + + if(!this.header){ + this.header = el.createChild({tag: "div", cls:"x-dlg-hd", html: "&#160;"}, this.body ? this.body.dom : null); + } + if(!this.body){ + this.body = el.createChild({tag: "div", cls:"x-dlg-bd"}); + } + + this.header.unselectable(); + if(this.title){ + this.header.update(this.title); + } + // this element allows the dialog to be focused for keyboard event + this.focusEl = el.createChild({tag: "a", href:"#", cls:"x-dlg-focus", tabIndex:"-1"}); + this.focusEl.swallowEvent("click", true); + + this.header.wrap({cls:"x-dlg-hd-right"}).wrap({cls:"x-dlg-hd-left"}, true); + + // wrap the body and footer for special rendering + this.bwrap = this.body.wrap({tag: "div", cls:"x-dlg-dlg-body"}); + if(this.footer){ + this.bwrap.dom.appendChild(this.footer.dom); + } + + this.bg = this.el.createChild({ + tag: "div", cls:"x-dlg-bg", + html: '<div class="x-dlg-bg-left"><div class="x-dlg-bg-right"><div class="x-dlg-bg-center">&#160;</div></div></div>' + }); + this.centerBg = this.bg.child("div.x-dlg-bg-center"); + + + if(this.autoScroll !== false && !this.autoTabs){ + this.body.setStyle("overflow", "auto"); + } + + this.toolbox = this.el.createChild({cls: "x-dlg-toolbox"}); + + if(this.closable !== false){ + this.el.addClass("x-dlg-closable"); + this.close = this.toolbox.createChild({cls:"x-dlg-close"}); + this.close.on("click", this.closeClick, this); + this.close.addClassOnOver("x-dlg-close-over"); + } + if(this.collapsible !== false){ + this.collapseBtn = this.toolbox.createChild({cls:"x-dlg-collapse"}); + this.collapseBtn.on("click", this.collapseClick, this); + this.collapseBtn.addClassOnOver("x-dlg-collapse-over"); + this.header.on("dblclick", this.collapseClick, this); + } + if(this.resizable !== false){ + this.el.addClass("x-dlg-resizable"); + this.resizer = new Roo.Resizable(el, { + minWidth: this.minWidth || 80, + minHeight:this.minHeight || 80, + handles: this.resizeHandles || "all", + pinned: true + }); + this.resizer.on("beforeresize", this.beforeResize, this); + this.resizer.on("resize", this.onResize, this); + } + if(this.draggable !== false){ + el.addClass("x-dlg-draggable"); + if (!this.proxyDrag) { + var dd = new Roo.dd.DD(el.dom.id, "WindowDrag"); + } + else { + var dd = new Roo.dd.DDProxy(el.dom.id, "WindowDrag", {dragElId: this.proxy.id}); + } + dd.setHandleElId(this.header.id); + dd.endDrag = this.endMove.createDelegate(this); + dd.startDrag = this.startMove.createDelegate(this); + dd.onDrag = this.onDrag.createDelegate(this); + dd.scroll = false; + this.dd = dd; + } + if(this.modal){ + this.mask = dh.append(document.body, {tag: "div", cls:"x-dlg-mask"}, true); + this.mask.enableDisplayMode("block"); + this.mask.hide(); + this.el.addClass("x-dlg-modal"); + } + if(this.shadow){ + this.shadow = new Roo.Shadow({ + mode : typeof this.shadow == "string" ? this.shadow : "sides", + offset : this.shadowOffset + }); + }else{ + this.shadowOffset = 0; + } + if(Roo.useShims && this.shim !== false){ + this.shim = this.el.createShim(); + this.shim.hide = this.hideAction; + this.shim.hide(); + }else{ + this.shim = false; + } + if(this.autoTabs){ + this.initTabs(); + } + if (this.buttons) { + var bts= this.buttons; + this.buttons = []; + Roo.each(bts, function(b) { + this.addButton(b); + }, this); + } + + + this.addEvents({ + /** + * @event keydown + * Fires when a key is pressed + * @param {Roo.BasicDialog} this + * @param {Roo.EventObject} e + */ + "keydown" : true, + /** + * @event move + * Fires when this dialog is moved by the user. + * @param {Roo.BasicDialog} this + * @param {Number} x The new page X + * @param {Number} y The new page Y + */ + "move" : true, + /** + * @event resize + * Fires when this dialog is resized by the user. + * @param {Roo.BasicDialog} this + * @param {Number} width The new width + * @param {Number} height The new height + */ + "resize" : true, + /** + * @event beforehide + * Fires before this dialog is hidden. + * @param {Roo.BasicDialog} this + */ + "beforehide" : true, + /** + * @event hide + * Fires when this dialog is hidden. + * @param {Roo.BasicDialog} this + */ + "hide" : true, + /** + * @event beforeshow + * Fires before this dialog is shown. + * @param {Roo.BasicDialog} this + */ + "beforeshow" : true, + /** + * @event show + * Fires when this dialog is shown. + * @param {Roo.BasicDialog} this + */ + "show" : true + }); + el.on("keydown", this.onKeyDown, this); + el.on("mousedown", this.toFront, this); + Roo.EventManager.onWindowResize(this.adjustViewport, this, true); + this.el.hide(); + Roo.DialogManager.register(this); + Roo.BasicDialog.superclass.constructor.call(this); +}; + +Roo.extend(Roo.BasicDialog, Roo.util.Observable, { + shadowOffset: Roo.isIE ? 6 : 5, + minHeight: 80, + minWidth: 200, + minButtonWidth: 75, + defaultButton: null, + buttonAlign: "right", + tabTag: 'div', + firstShow: true, + + /** + * Sets the dialog title text + * @param {String} text The title text to display + * @return {Roo.BasicDialog} this + */ + setTitle : function(text){ + this.header.update(text); + return this; + }, + + // private + closeClick : function(){ + this.hide(); + }, + + // private + collapseClick : function(){ + this[this.collapsed ? "expand" : "collapse"](); + }, + + /** + * Collapses the dialog to its minimized state (only the title bar is visible). + * Equivalent to the user clicking the collapse dialog button. + */ + collapse : function(){ + if(!this.collapsed){ + this.collapsed = true; + this.el.addClass("x-dlg-collapsed"); + this.restoreHeight = this.el.getHeight(); + this.resizeTo(this.el.getWidth(), this.header.getHeight()); + } + }, + + /** + * Expands a collapsed dialog back to its normal state. Equivalent to the user + * clicking the expand dialog button. + */ + expand : function(){ + if(this.collapsed){ + this.collapsed = false; + this.el.removeClass("x-dlg-collapsed"); + this.resizeTo(this.el.getWidth(), this.restoreHeight); + } + }, + + /** + * Reinitializes the tabs component, clearing out old tabs and finding new ones. + * @return {Roo.TabPanel} The tabs component + */ + initTabs : function(){ + var tabs = this.getTabs(); + while(tabs.getTab(0)){ + tabs.removeTab(0); + } + this.el.select(this.tabTag+'.x-dlg-tab').each(function(el){ + var dom = el.dom; + tabs.addTab(Roo.id(dom), dom.title); + dom.title = ""; + }); + tabs.activate(0); + return tabs; + }, + + // private + beforeResize : function(){ + this.resizer.minHeight = Math.max(this.minHeight, this.getHeaderFooterHeight(true)+40); + }, + + // private + onResize : function(){ + this.refreshSize(); + this.syncBodyHeight(); + this.adjustAssets(); + this.focus(); + this.fireEvent("resize", this, this.size.width, this.size.height); + }, + + // private + onKeyDown : function(e){ + if(this.isVisible()){ + this.fireEvent("keydown", this, e); + } + }, + + /** + * Resizes the dialog. + * @param {Number} width + * @param {Number} height + * @return {Roo.BasicDialog} this + */ + resizeTo : function(width, height){ + this.el.setSize(width, height); + this.size = {width: width, height: height}; + this.syncBodyHeight(); + if(this.fixedcenter){ + this.center(); + } + if(this.isVisible()){ + this.constrainXY(); + this.adjustAssets(); + } + this.fireEvent("resize", this, width, height); + return this; + }, + + + /** + * Resizes the dialog to fit the specified content size. + * @param {Number} width + * @param {Number} height + * @return {Roo.BasicDialog} this + */ + setContentSize : function(w, h){ + h += this.getHeaderFooterHeight() + this.body.getMargins("tb"); + w += this.body.getMargins("lr") + this.bwrap.getMargins("lr") + this.centerBg.getPadding("lr"); + //if(!this.el.isBorderBox()){ + h += this.body.getPadding("tb") + this.bwrap.getBorderWidth("tb") + this.body.getBorderWidth("tb") + this.el.getBorderWidth("tb"); + w += this.body.getPadding("lr") + this.bwrap.getBorderWidth("lr") + this.body.getBorderWidth("lr") + this.bwrap.getPadding("lr") + this.el.getBorderWidth("lr"); + //} + if(this.tabs){ + h += this.tabs.stripWrap.getHeight() + this.tabs.bodyEl.getMargins("tb") + this.tabs.bodyEl.getPadding("tb"); + w += this.tabs.bodyEl.getMargins("lr") + this.tabs.bodyEl.getPadding("lr"); + } + this.resizeTo(w, h); + return this; + }, + + /** + * Adds a key listener for when this dialog is displayed. This allows you to hook in a function that will be + * executed in response to a particular key being pressed while the dialog is active. + * @param {Number/Array/Object} key Either the numeric key code, array of key codes or an object with the following options: + * {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)} + * @param {Function} fn The function to call + * @param {Object} scope (optional) The scope of the function + * @return {Roo.BasicDialog} this + */ + addKeyListener : function(key, fn, scope){ + var keyCode, shift, ctrl, alt; + if(typeof key == "object" && !(key instanceof Array)){ + keyCode = key["key"]; + shift = key["shift"]; + ctrl = key["ctrl"]; + alt = key["alt"]; + }else{ + keyCode = key; + } + var handler = function(dlg, e){ + if((!shift || e.shiftKey) && (!ctrl || e.ctrlKey) && (!alt || e.altKey)){ + var k = e.getKey(); + if(keyCode instanceof Array){ + for(var i = 0, len = keyCode.length; i < len; i++){ + if(keyCode[i] == k){ + fn.call(scope || window, dlg, k, e); + return; + } + } + }else{ + if(k == keyCode){ + fn.call(scope || window, dlg, k, e); + } + } + } + }; + this.on("keydown", handler); + return this; + }, + + /** + * Returns the TabPanel component (creates it if it doesn't exist). + * Note: If you wish to simply check for the existence of tabs without creating them, + * check for a null 'tabs' property. + * @return {Roo.TabPanel} The tabs component + */ + getTabs : function(){ + if(!this.tabs){ + this.el.addClass("x-dlg-auto-tabs"); + this.body.addClass(this.tabPosition == "bottom" ? "x-tabs-bottom" : "x-tabs-top"); + this.tabs = new Roo.TabPanel(this.body.dom, this.tabPosition == "bottom"); + } + return this.tabs; + }, + + /** + * Adds a button to the footer section of the dialog. + * @param {String/Object} config A string becomes the button text, an object can either be a Button config + * object or a valid Roo.DomHelper element config + * @param {Function} handler The function called when the button is clicked + * @param {Object} scope (optional) The scope of the handler function (accepts position as a property) + * @return {Roo.Button} The new button + */ + addButton : function(config, handler, scope){ + var dh = Roo.DomHelper; + if(!this.footer){ + this.footer = dh.append(this.bwrap, {tag: "div", cls:"x-dlg-ft"}, true); + } + if(!this.btnContainer){ + var tb = this.footer.createChild({ + + cls:"x-dlg-btns x-dlg-btns-"+this.buttonAlign, + html:'<table cellspacing="0"><tbody><tr></tr></tbody></table><div class="x-clear"></div>' + }, null, true); + this.btnContainer = tb.firstChild.firstChild.firstChild; + } + var bconfig = { + handler: handler, + scope: scope, + minWidth: this.minButtonWidth, + hideParent:true + }; + if(typeof config == "string"){ + bconfig.text = config; + }else{ + if(config.tag){ + bconfig.dhconfig = config; + }else{ + Roo.apply(bconfig, config); + } + } + var fc = false; + if ((typeof(bconfig.position) != 'undefined') && bconfig.position < this.btnContainer.childNodes.length-1) { + bconfig.position = Math.max(0, bconfig.position); + fc = this.btnContainer.childNodes[bconfig.position]; + } + + var btn = new Roo.Button( + fc ? + this.btnContainer.insertBefore(document.createElement("td"),fc) + : this.btnContainer.appendChild(document.createElement("td")), + //Roo.get(this.btnContainer).createChild( { tag: 'td'}, fc ), + bconfig + ); + this.syncBodyHeight(); + if(!this.buttons){ + /** + * Array of all the buttons that have been added to this dialog via addButton + * @type Array + */ + this.buttons = []; + } + this.buttons.push(btn); + return btn; + }, + + /** + * Sets the default button to be focused when the dialog is displayed. + * @param {Roo.BasicDialog.Button} btn The button object returned by {@link #addButton} + * @return {Roo.BasicDialog} this + */ + setDefaultButton : function(btn){ + this.defaultButton = btn; + return this; + }, + + // private + getHeaderFooterHeight : function(safe){ + var height = 0; + if(this.header){ + height += this.header.getHeight(); + } + if(this.footer){ + var fm = this.footer.getMargins(); + height += (this.footer.getHeight()+fm.top+fm.bottom); + } + height += this.bwrap.getPadding("tb")+this.bwrap.getBorderWidth("tb"); + height += this.centerBg.getPadding("tb"); + return height; + }, + + // private + syncBodyHeight : function() + { + var bd = this.body, // the text + cb = this.centerBg, // wrapper around bottom.. but does not seem to be used.. + bw = this.bwrap; + var height = this.size.height - this.getHeaderFooterHeight(false); + bd.setHeight(height-bd.getMargins("tb")); + var hh = this.header.getHeight(); + var h = this.size.height-hh; + cb.setHeight(h); + + bw.setLeftTop(cb.getPadding("l"), hh+cb.getPadding("t")); + bw.setHeight(h-cb.getPadding("tb")); + + bw.setWidth(this.el.getWidth(true)-cb.getPadding("lr")); + bd.setWidth(bw.getWidth(true)); + if(this.tabs){ + this.tabs.syncHeight(); + if(Roo.isIE){ + this.tabs.el.repaint(); + } + } + }, + + /** + * Restores the previous state of the dialog if Roo.state is configured. + * @return {Roo.BasicDialog} this + */ + restoreState : function(){ + var box = Roo.state.Manager.get(this.stateId || (this.el.id + "-state")); + if(box && box.width){ + this.xy = [box.x, box.y]; + this.resizeTo(box.width, box.height); + } + return this; + }, + + // private + beforeShow : function(){ + this.expand(); + if(this.fixedcenter){ + this.xy = this.el.getCenterXY(true); + } + if(this.modal){ + Roo.get(document.body).addClass("x-body-masked"); + this.mask.setSize(Roo.lib.Dom.getViewWidth(true), Roo.lib.Dom.getViewHeight(true)); + this.mask.show(); + } + this.constrainXY(); + }, + + // private + animShow : function(){ + var b = Roo.get(this.animateTarget).getBox(); + this.proxy.setSize(b.width, b.height); + this.proxy.setLocation(b.x, b.y); + this.proxy.show(); + this.proxy.setBounds(this.xy[0], this.xy[1], this.size.width, this.size.height, + true, .35, this.showEl.createDelegate(this)); + }, + + /** + * Shows the dialog. + * @param {String/HTMLElement/Roo.Element} animateTarget (optional) Reset the animation target + * @return {Roo.BasicDialog} this + */ + show : function(animateTarget){ + if (this.fireEvent("beforeshow", this) === false){ + return; + } + if(this.syncHeightBeforeShow){ + this.syncBodyHeight(); + }else if(this.firstShow){ + this.firstShow = false; + this.syncBodyHeight(); // sync the height on the first show instead of in the constructor + } + this.animateTarget = animateTarget || this.animateTarget; + if(!this.el.isVisible()){ + this.beforeShow(); + if(this.animateTarget && Roo.get(this.animateTarget)){ + this.animShow(); + }else{ + this.showEl(); + } + } + return this; + }, + + // private + showEl : function(){ + this.proxy.hide(); + this.el.setXY(this.xy); + this.el.show(); + this.adjustAssets(true); + this.toFront(); + this.focus(); + // IE peekaboo bug - fix found by Dave Fenwick + if(Roo.isIE){ + this.el.repaint(); + } + this.fireEvent("show", this); + }, + + /** + * Focuses the dialog. If a defaultButton is set, it will receive focus, otherwise the + * dialog itself will receive focus. + */ + focus : function(){ + if(this.defaultButton){ + this.defaultButton.focus(); + }else{ + this.focusEl.focus(); + } + }, + + // private + constrainXY : function(){ + if(this.constraintoviewport !== false){ + if(!this.viewSize){ + if(this.container){ + var s = this.container.getSize(); + this.viewSize = [s.width, s.height]; + }else{ + this.viewSize = [Roo.lib.Dom.getViewWidth(),Roo.lib.Dom.getViewHeight()]; + } + } + var s = Roo.get(this.container||document).getScroll(); + + var x = this.xy[0], y = this.xy[1]; + var w = this.size.width, h = this.size.height; + var vw = this.viewSize[0], vh = this.viewSize[1]; + // only move it if it needs it + var moved = false; + // first validate right/bottom + if(x + w > vw+s.left){ + x = vw - w; + moved = true; + } + if(y + h > vh+s.top){ + y = vh - h; + moved = true; + } + // then make sure top/left isn't negative + if(x < s.left){ + x = s.left; + moved = true; + } + if(y < s.top){ + y = s.top; + moved = true; + } + if(moved){ + // cache xy + this.xy = [x, y]; + if(this.isVisible()){ + this.el.setLocation(x, y); + this.adjustAssets(); + } + } + } + }, + + // private + onDrag : function(){ + if(!this.proxyDrag){ + this.xy = this.el.getXY(); + this.adjustAssets(); + } + }, + + // private + adjustAssets : function(doShow){ + var x = this.xy[0], y = this.xy[1]; + var w = this.size.width, h = this.size.height; + if(doShow === true){ + if(this.shadow){ + this.shadow.show(this.el); + } + if(this.shim){ + this.shim.show(); + } + } + if(this.shadow && this.shadow.isVisible()){ + this.shadow.show(this.el); + } + if(this.shim && this.shim.isVisible()){ + this.shim.setBounds(x, y, w, h); + } + }, + + // private + adjustViewport : function(w, h){ + if(!w || !h){ + w = Roo.lib.Dom.getViewWidth(); + h = Roo.lib.Dom.getViewHeight(); + } + // cache the size + this.viewSize = [w, h]; + if(this.modal && this.mask.isVisible()){ + this.mask.setSize(w, h); // first make sure the mask isn't causing overflow + this.mask.setSize(Roo.lib.Dom.getViewWidth(true), Roo.lib.Dom.getViewHeight(true)); + } + if(this.isVisible()){ + this.constrainXY(); + } + }, + + /** + * Destroys this dialog and all its supporting elements (including any tabs, shim, + * shadow, proxy, mask, etc.) Also removes all event listeners. + * @param {Boolean} removeEl (optional) true to remove the element from the DOM + */ + destroy : function(removeEl){ + if(this.isVisible()){ + this.animateTarget = null; + this.hide(); + } + Roo.EventManager.removeResizeListener(this.adjustViewport, this); + if(this.tabs){ + this.tabs.destroy(removeEl); + } + Roo.destroy( + this.shim, + this.proxy, + this.resizer, + this.close, + this.mask + ); + if(this.dd){ + this.dd.unreg(); + } + if(this.buttons){ + for(var i = 0, len = this.buttons.length; i < len; i++){ + this.buttons[i].destroy(); + } + } + this.el.removeAllListeners(); + if(removeEl === true){ + this.el.update(""); + this.el.remove(); + } + Roo.DialogManager.unregister(this); + }, + + // private + startMove : function(){ + if(this.proxyDrag){ + this.proxy.show(); + } + if(this.constraintoviewport !== false){ + this.dd.constrainTo(document.body, {right: this.shadowOffset, bottom: this.shadowOffset}); + } + }, + + // private + endMove : function(){ + if(!this.proxyDrag){ + Roo.dd.DD.prototype.endDrag.apply(this.dd, arguments); + }else{ + Roo.dd.DDProxy.prototype.endDrag.apply(this.dd, arguments); + this.proxy.hide(); + } + this.refreshSize(); + this.adjustAssets(); + this.focus(); + this.fireEvent("move", this, this.xy[0], this.xy[1]); + }, + + /** + * Brings this dialog to the front of any other visible dialogs + * @return {Roo.BasicDialog} this + */ + toFront : function(){ + Roo.DialogManager.bringToFront(this); + return this; + }, + + /** + * Sends this dialog to the back (under) of any other visible dialogs + * @return {Roo.BasicDialog} this + */ + toBack : function(){ + Roo.DialogManager.sendToBack(this); + return this; + }, + + /** + * Centers this dialog in the viewport + * @return {Roo.BasicDialog} this + */ + center : function(){ + var xy = this.el.getCenterXY(true); + this.moveTo(xy[0], xy[1]); + return this; + }, + + /** + * Moves the dialog's top-left corner to the specified point + * @param {Number} x + * @param {Number} y + * @return {Roo.BasicDialog} this + */ + moveTo : function(x, y){ + this.xy = [x,y]; + if(this.isVisible()){ + this.el.setXY(this.xy); + this.adjustAssets(); + } + return this; + }, + + /** + * Aligns the dialog to the specified element + * @param {String/HTMLElement/Roo.Element} element The element to align to. + * @param {String} position The position to align to (see {@link Roo.Element#alignTo} for more details). + * @param {Array} offsets (optional) Offset the positioning by [x, y] + * @return {Roo.BasicDialog} this + */ + alignTo : function(element, position, offsets){ + this.xy = this.el.getAlignToXY(element, position, offsets); + if(this.isVisible()){ + this.el.setXY(this.xy); + this.adjustAssets(); + } + return this; + }, + + /** + * Anchors an element to another element and realigns it when the window is resized. + * @param {String/HTMLElement/Roo.Element} element The element to align to. + * @param {String} position The position to align to (see {@link Roo.Element#alignTo} for more details) + * @param {Array} offsets (optional) Offset the positioning by [x, y] + * @param {Boolean/Number} monitorScroll (optional) true to monitor body scroll and reposition. If this parameter + * is a number, it is used as the buffer delay (defaults to 50ms). + * @return {Roo.BasicDialog} this + */ + anchorTo : function(el, alignment, offsets, monitorScroll){ + var action = function(){ + this.alignTo(el, alignment, offsets); + }; + Roo.EventManager.onWindowResize(action, this); + var tm = typeof monitorScroll; + if(tm != 'undefined'){ + Roo.EventManager.on(window, 'scroll', action, this, + {buffer: tm == 'number' ? monitorScroll : 50}); + } + action.call(this); + return this; + }, + + /** + * Returns true if the dialog is visible + * @return {Boolean} + */ + isVisible : function(){ + return this.el.isVisible(); + }, + + // private + animHide : function(callback){ + var b = Roo.get(this.animateTarget).getBox(); + this.proxy.show(); + this.proxy.setBounds(this.xy[0], this.xy[1], this.size.width, this.size.height); + this.el.hide(); + this.proxy.setBounds(b.x, b.y, b.width, b.height, true, .35, + this.hideEl.createDelegate(this, [callback])); + }, + + /** + * Hides the dialog. + * @param {Function} callback (optional) Function to call when the dialog is hidden + * @return {Roo.BasicDialog} this + */ + hide : function(callback){ + if (this.fireEvent("beforehide", this) === false){ + return; + } + if(this.shadow){ + this.shadow.hide(); + } + if(this.shim) { + this.shim.hide(); + } + // sometimes animateTarget seems to get set.. causing problems... + // this just double checks.. + if(this.animateTarget && Roo.get(this.animateTarget)) { + this.animHide(callback); + }else{ + this.el.hide(); + this.hideEl(callback); + } + return this; + }, + + // private + hideEl : function(callback){ + this.proxy.hide(); + if(this.modal){ + this.mask.hide(); + Roo.get(document.body).removeClass("x-body-masked"); + } + this.fireEvent("hide", this); + if(typeof callback == "function"){ + callback(); + } + }, + + // private + hideAction : function(){ + this.setLeft("-10000px"); + this.setTop("-10000px"); + this.setStyle("visibility", "hidden"); + }, + + // private + refreshSize : function(){ + this.size = this.el.getSize(); + this.xy = this.el.getXY(); + Roo.state.Manager.set(this.stateId || this.el.id + "-state", this.el.getBox()); + }, + + // private + // z-index is managed by the DialogManager and may be overwritten at any time + setZIndex : function(index){ + if(this.modal){ + this.mask.setStyle("z-index", index); + } + if(this.shim){ + this.shim.setStyle("z-index", ++index); + } + if(this.shadow){ + this.shadow.setZIndex(++index); + } + this.el.setStyle("z-index", ++index); + if(this.proxy){ + this.proxy.setStyle("z-index", ++index); + } + if(this.resizer){ + this.resizer.proxy.setStyle("z-index", ++index); + } + + this.lastZIndex = index; + }, + + /** + * Returns the element for this dialog + * @return {Roo.Element} The underlying dialog Element + */ + getEl : function(){ + return this.el; + } +}); + +/** + * @class Roo.DialogManager + * Provides global access to BasicDialogs that have been created and + * support for z-indexing (layering) multiple open dialogs. + */ +Roo.DialogManager = function(){ + var list = {}; + var accessList = []; + var front = null; + + // private + var sortDialogs = function(d1, d2){ + return (!d1._lastAccess || d1._lastAccess < d2._lastAccess) ? -1 : 1; + }; + + // private + var orderDialogs = function(){ + accessList.sort(sortDialogs); + var seed = Roo.DialogManager.zseed; + for(var i = 0, len = accessList.length; i < len; i++){ + var dlg = accessList[i]; + if(dlg){ + dlg.setZIndex(seed + (i*10)); + } + } + }; + + return { + /** + * The starting z-index for BasicDialogs (defaults to 9000) + * @type Number The z-index value + */ + zseed : 9000, + + // private + register : function(dlg){ + list[dlg.id] = dlg; + accessList.push(dlg); + }, + + // private + unregister : function(dlg){ + delete list[dlg.id]; + var i=0; + var len=0; + if(!accessList.indexOf){ + for( i = 0, len = accessList.length; i < len; i++){ + if(accessList[i] == dlg){ + accessList.splice(i, 1); + return; + } + } + }else{ + i = accessList.indexOf(dlg); + if(i != -1){ + accessList.splice(i, 1); + } + } + }, + + /** + * Gets a registered dialog by id + * @param {String/Object} id The id of the dialog or a dialog + * @return {Roo.BasicDialog} this + */ + get : function(id){ + return typeof id == "object" ? id : list[id]; + }, + + /** + * Brings the specified dialog to the front + * @param {String/Object} dlg The id of the dialog or a dialog + * @return {Roo.BasicDialog} this + */ + bringToFront : function(dlg){ + dlg = this.get(dlg); + if(dlg != front){ + front = dlg; + dlg._lastAccess = new Date().getTime(); + orderDialogs(); + } + return dlg; + }, + + /** + * Sends the specified dialog to the back + * @param {String/Object} dlg The id of the dialog or a dialog + * @return {Roo.BasicDialog} this + */ + sendToBack : function(dlg){ + dlg = this.get(dlg); + dlg._lastAccess = -(new Date().getTime()); + orderDialogs(); + return dlg; + }, + + /** + * Hides all dialogs + */ + hideAll : function(){ + for(var id in list){ + if(list[id] && typeof list[id] != "function" && list[id].isVisible()){ + list[id].hide(); + } + } + } + }; +}(); + +/** + * @class Roo.LayoutDialog + * @extends Roo.BasicDialog + * Dialog which provides adjustments for working with a layout in a Dialog. + * Add your necessary layout config options to the dialog's config.<br> + * Example usage (including a nested layout): + * <pre><code> +if(!dialog){ + dialog = new Roo.LayoutDialog("download-dlg", { + modal: true, + width:600, + height:450, + shadow:true, + minWidth:500, + minHeight:350, + autoTabs:true, + proxyDrag:true, + // layout config merges with the dialog config + center:{ + tabPosition: "top", + alwaysShowTabs: true + } + }); + dialog.addKeyListener(27, dialog.hide, dialog); + dialog.setDefaultButton(dialog.addButton("Close", dialog.hide, dialog)); + dialog.addButton("Build It!", this.getDownload, this); + + // we can even add nested layouts + var innerLayout = new Roo.BorderLayout("dl-inner", { + east: { + initialSize: 200, + autoScroll:true, + split:true + }, + center: { + autoScroll:true + } + }); + innerLayout.beginUpdate(); + innerLayout.add("east", new Roo.ContentPanel("dl-details")); + innerLayout.add("center", new Roo.ContentPanel("selection-panel")); + innerLayout.endUpdate(true); + + var layout = dialog.getLayout(); + layout.beginUpdate(); + layout.add("center", new Roo.ContentPanel("standard-panel", + {title: "Download the Source", fitToFrame:true})); + layout.add("center", new Roo.NestedLayoutPanel(innerLayout, + {title: "Build your own roo.js"})); + layout.getRegion("center").showPanel(sp); + layout.endUpdate(); +} +</code></pre> + * @constructor + * @param {String/HTMLElement/Roo.Element} el The id of or container element, or config + * @param {Object} config configuration options + */ +Roo.LayoutDialog = function(el, cfg){ + + var config= cfg; + if (typeof(cfg) == 'undefined') { + config = Roo.apply({}, el); + // not sure why we use documentElement here.. - it should always be body. + // IE7 borks horribly if we use documentElement. + // webkit also does not like documentElement - it creates a body element... + el = Roo.get( document.body || document.documentElement ).createChild(); + //config.autoCreate = true; + } + + + config.autoTabs = false; + Roo.LayoutDialog.superclass.constructor.call(this, el, config); + this.body.setStyle({overflow:"hidden", position:"relative"}); + this.layout = new Roo.BorderLayout(this.body.dom, config); + this.layout.monitorWindowResize = false; + this.el.addClass("x-dlg-auto-layout"); + // fix case when center region overwrites center function + this.center = Roo.BasicDialog.prototype.center; + this.on("show", this.layout.layout, this.layout, true); + if (config.items) { + var xitems = config.items; + delete config.items; + Roo.each(xitems, this.addxtype, this); + } + + +}; +Roo.extend(Roo.LayoutDialog, Roo.BasicDialog, { + /** + * Ends update of the layout <strike>and resets display to none</strike>. Use standard beginUpdate/endUpdate on the layout. + * @deprecated + */ + endUpdate : function(){ + this.layout.endUpdate(); + }, + + /** + * Begins an update of the layout <strike>and sets display to block and visibility to hidden</strike>. Use standard beginUpdate/endUpdate on the layout. + * @deprecated + */ + beginUpdate : function(){ + this.layout.beginUpdate(); + }, + + /** + * Get the BorderLayout for this dialog + * @return {Roo.BorderLayout} + */ + getLayout : function(){ + return this.layout; + }, + + showEl : function(){ + Roo.LayoutDialog.superclass.showEl.apply(this, arguments); + if(Roo.isIE7){ + this.layout.layout(); + } + }, + + // private + // Use the syncHeightBeforeShow config option to control this automatically + syncBodyHeight : function(){ + Roo.LayoutDialog.superclass.syncBodyHeight.call(this); + if(this.layout){this.layout.layout();} + }, + + /** + * Add an xtype element (actually adds to the layout.) + * @return {Object} xdata xtype object data. + */ + + addxtype : function(c) { + return this.layout.addxtype(c); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_BasicLayoutRegion.js.html b/docs2/src/Roo_BasicLayoutRegion.js.html new file mode 100644 index 0000000000..cf9647d708 --- /dev/null +++ b/docs2/src/Roo_BasicLayoutRegion.js.html @@ -0,0 +1,315 @@ +/home/alan/gitlive/roojs1/Roo/BasicLayoutRegion.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.BasicLayoutRegion + * @extends Roo.util.Observable + * This class represents a lightweight region in a layout manager. This region does not move dom nodes + * and does not have a titlebar, tabs or any other features. All it does is size and position + * panels. To create a BasicLayoutRegion, add lightweight:true or basic:true to your regions config. + */ +Roo.BasicLayoutRegion = function(mgr, config, pos, skipConfig){ + this.mgr = mgr; + this.position = pos; + this.events = { + /** + * @scope Roo.BasicLayoutRegion + */ + + /** + * @event beforeremove + * Fires before a panel is removed (or closed). To cancel the removal set "e.cancel = true" on the event argument. + * @param {Roo.LayoutRegion} this + * @param {Roo.ContentPanel} panel The panel + * @param {Object} e The cancel event object + */ + "beforeremove" : true, + /** + * @event invalidated + * Fires when the layout for this region is changed. + * @param {Roo.LayoutRegion} this + */ + "invalidated" : true, + /** + * @event visibilitychange + * Fires when this region is shown or hidden + * @param {Roo.LayoutRegion} this + * @param {Boolean} visibility true or false + */ + "visibilitychange" : true, + /** + * @event paneladded + * Fires when a panel is added. + * @param {Roo.LayoutRegion} this + * @param {Roo.ContentPanel} panel The panel + */ + "paneladded" : true, + /** + * @event panelremoved + * Fires when a panel is removed. + * @param {Roo.LayoutRegion} this + * @param {Roo.ContentPanel} panel The panel + */ + "panelremoved" : true, + /** + * @event beforecollapse + * Fires when this region before collapse. + * @param {Roo.LayoutRegion} this + */ + "beforecollapse" : true, + /** + * @event collapsed + * Fires when this region is collapsed. + * @param {Roo.LayoutRegion} this + */ + "collapsed" : true, + /** + * @event expanded + * Fires when this region is expanded. + * @param {Roo.LayoutRegion} this + */ + "expanded" : true, + /** + * @event slideshow + * Fires when this region is slid into view. + * @param {Roo.LayoutRegion} this + */ + "slideshow" : true, + /** + * @event slidehide + * Fires when this region slides out of view. + * @param {Roo.LayoutRegion} this + */ + "slidehide" : true, + /** + * @event panelactivated + * Fires when a panel is activated. + * @param {Roo.LayoutRegion} this + * @param {Roo.ContentPanel} panel The activated panel + */ + "panelactivated" : true, + /** + * @event resized + * Fires when the user resizes this region. + * @param {Roo.LayoutRegion} this + * @param {Number} newSize The new size (width for east/west, height for north/south) + */ + "resized" : true + }; + /** A collection of panels in this region. @type Roo.util.MixedCollection */ + this.panels = new Roo.util.MixedCollection(); + this.panels.getKey = this.getPanelId.createDelegate(this); + this.box = null; + this.activePanel = null; + // ensure listeners are added... + + if (config.listeners || config.events) { + Roo.BasicLayoutRegion.superclass.constructor.call(this, { + listeners : config.listeners || {}, + events : config.events || {} + }); + } + + if(skipConfig !== true){ + this.applyConfig(config); + } +}; + +Roo.extend(Roo.BasicLayoutRegion, Roo.util.Observable, { + getPanelId : function(p){ + return p.getId(); + }, + + applyConfig : function(config){ + this.margins = config.margins || this.margins || {top: 0, left: 0, right:0, bottom: 0}; + this.config = config; + + }, + + /** + * Resizes the region to the specified size. For vertical regions (west, east) this adjusts + * the width, for horizontal (north, south) the height. + * @param {Number} newSize The new width or height + */ + resizeTo : function(newSize){ + var el = this.el ? this.el : + (this.activePanel ? this.activePanel.getEl() : null); + if(el){ + switch(this.position){ + case "east": + case "west": + el.setWidth(newSize); + this.fireEvent("resized", this, newSize); + break; + case "north": + case "south": + el.setHeight(newSize); + this.fireEvent("resized", this, newSize); + break; + } + } + }, + + getBox : function(){ + return this.activePanel ? this.activePanel.getEl().getBox(false, true) : null; + }, + + getMargins : function(){ + return this.margins; + }, + + updateBox : function(box){ + this.box = box; + var el = this.activePanel.getEl(); + el.dom.style.left = box.x + "px"; + el.dom.style.top = box.y + "px"; + this.activePanel.setSize(box.width, box.height); + }, + + /** + * Returns the container element for this region. + * @return {Roo.Element} + */ + getEl : function(){ + return this.activePanel; + }, + + /** + * Returns true if this region is currently visible. + * @return {Boolean} + */ + isVisible : function(){ + return this.activePanel ? true : false; + }, + + setActivePanel : function(panel){ + panel = this.getPanel(panel); + if(this.activePanel && this.activePanel != panel){ + this.activePanel.setActiveState(false); + this.activePanel.getEl().setLeftTop(-10000,-10000); + } + this.activePanel = panel; + panel.setActiveState(true); + if(this.box){ + panel.setSize(this.box.width, this.box.height); + } + this.fireEvent("panelactivated", this, panel); + this.fireEvent("invalidated"); + }, + + /** + * Show the specified panel. + * @param {Number/String/ContentPanel} panelId The panels index, id or the panel itself + * @return {Roo.ContentPanel} The shown panel or null + */ + showPanel : function(panel){ + if(panel = this.getPanel(panel)){ + this.setActivePanel(panel); + } + return panel; + }, + + /** + * Get the active panel for this region. + * @return {Roo.ContentPanel} The active panel or null + */ + getActivePanel : function(){ + return this.activePanel; + }, + + /** + * Add the passed ContentPanel(s) + * @param {ContentPanel...} panel The ContentPanel(s) to add (you can pass more than one) + * @return {Roo.ContentPanel} The panel added (if only one was added) + */ + add : function(panel){ + if(arguments.length > 1){ + for(var i = 0, len = arguments.length; i < len; i++) { + this.add(arguments[i]); + } + return null; + } + if(this.hasPanel(panel)){ + this.showPanel(panel); + return panel; + } + var el = panel.getEl(); + if(el.dom.parentNode != this.mgr.el.dom){ + this.mgr.el.dom.appendChild(el.dom); + } + if(panel.setRegion){ + panel.setRegion(this); + } + this.panels.add(panel); + el.setStyle("position", "absolute"); + if(!panel.background){ + this.setActivePanel(panel); + if(this.config.initialSize && this.panels.getCount()==1){ + this.resizeTo(this.config.initialSize); + } + } + this.fireEvent("paneladded", this, panel); + return panel; + }, + + /** + * Returns true if the panel is in this region. + * @param {Number/String/ContentPanel} panel The panels index, id or the panel itself + * @return {Boolean} + */ + hasPanel : function(panel){ + if(typeof panel == "object"){ // must be panel obj + panel = panel.getId(); + } + return this.getPanel(panel) ? true : false; + }, + + /** + * Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed. + * @param {Number/String/ContentPanel} panel The panels index, id or the panel itself + * @param {Boolean} preservePanel Overrides the config preservePanel option + * @return {Roo.ContentPanel} The panel that was removed + */ + remove : function(panel, preservePanel){ + panel = this.getPanel(panel); + if(!panel){ + return null; + } + var e = {}; + this.fireEvent("beforeremove", this, panel, e); + if(e.cancel === true){ + return null; + } + var panelId = panel.getId(); + this.panels.removeKey(panelId); + return panel; + }, + + /** + * Returns the panel specified or null if it's not in this region. + * @param {Number/String/ContentPanel} panel The panels index, id or the panel itself + * @return {Roo.ContentPanel} + */ + getPanel : function(id){ + if(typeof id == "object"){ // must be panel obj + return id; + } + return this.panels.get(id); + }, + + /** + * Returns this regions position (north/south/east/west/center). + * @return {String} + */ + getPosition: function(){ + return this.position; + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_BorderLayout.js.html b/docs2/src/Roo_BorderLayout.js.html new file mode 100644 index 0000000000..1b76a78bbd --- /dev/null +++ b/docs2/src/Roo_BorderLayout.js.html @@ -0,0 +1,628 @@ +/home/alan/gitlive/roojs1/Roo/BorderLayout.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.BorderLayout + * @extends Roo.LayoutManager + * This class represents a common layout manager used in desktop applications. For screenshots and more details, + * please see: <br><br> + * <a href="http://www.jackslocum.com/yui/2006/10/19/cross-browser-web-20-layouts-with-yahoo-ui/">Cross Browser Layouts - Part 1</a><br> + * <a href="http://www.jackslocum.com/yui/2006/10/28/cross-browser-web-20-layouts-part-2-ajax-feed-viewer-20/">Cross Browser Layouts - Part 2</a><br><br> + * Example: + <pre><code> + var layout = new Roo.BorderLayout(document.body, { + north: { + initialSize: 25, + titlebar: false + }, + west: { + split:true, + initialSize: 200, + minSize: 175, + maxSize: 400, + titlebar: true, + collapsible: true + }, + east: { + split:true, + initialSize: 202, + minSize: 175, + maxSize: 400, + titlebar: true, + collapsible: true + }, + south: { + split:true, + initialSize: 100, + minSize: 100, + maxSize: 200, + titlebar: true, + collapsible: true + }, + center: { + titlebar: true, + autoScroll:true, + resizeTabs: true, + minTabWidth: 50, + preferredTabWidth: 150 + } +}); + +// shorthand +var CP = Roo.ContentPanel; + +layout.beginUpdate(); +layout.add("north", new CP("north", "North")); +layout.add("south", new CP("south", {title: "South", closable: true})); +layout.add("west", new CP("west", {title: "West"})); +layout.add("east", new CP("autoTabs", {title: "Auto Tabs", closable: true})); +layout.add("center", new CP("center1", {title: "Close Me", closable: true})); +layout.add("center", new CP("center2", {title: "Center Panel", closable: false})); +layout.getRegion("center").showPanel("center1"); +layout.endUpdate(); +</code></pre> + +<b>The container the layout is rendered into can be either the body element or any other element. +If it is not the body element, the container needs to either be an absolute positioned element, +or you will need to add "position:relative" to the css of the container. You will also need to specify +the container size if it is not the body element.</b> + +* @constructor +* Create a new BorderLayout +* @param {String/HTMLElement/Element} container The container this layout is bound to +* @param {Object} config Configuration options + */ +Roo.BorderLayout = function(container, config){ + config = config || {}; + Roo.BorderLayout.superclass.constructor.call(this, container, config); + this.factory = config.factory || Roo.BorderLayout.RegionFactory; + for(var i = 0, len = this.factory.validRegions.length; i < len; i++) { + var target = this.factory.validRegions[i]; + if(config[target]){ + this.addRegion(target, config[target]); + } + } +}; + +Roo.extend(Roo.BorderLayout, Roo.LayoutManager, { + /** + * Creates and adds a new region if it doesn't already exist. + * @param {String} target The target region key (north, south, east, west or center). + * @param {Object} config The regions config object + * @return {BorderLayoutRegion} The new region + */ + addRegion : function(target, config){ + if(!this.regions[target]){ + var r = this.factory.create(target, this, config); + this.bindRegion(target, r); + } + return this.regions[target]; + }, + + // private (kinda) + bindRegion : function(name, r){ + this.regions[name] = r; + r.on("visibilitychange", this.layout, this); + r.on("paneladded", this.layout, this); + r.on("panelremoved", this.layout, this); + r.on("invalidated", this.layout, this); + r.on("resized", this.onRegionResized, this); + r.on("collapsed", this.onRegionCollapsed, this); + r.on("expanded", this.onRegionExpanded, this); + }, + + /** + * Performs a layout update. + */ + layout : function(){ + if(this.updating) { + return; + } + var size = this.getViewSize(); + var w = size.width; + var h = size.height; + var centerW = w; + var centerH = h; + var centerY = 0; + var centerX = 0; + //var x = 0, y = 0; + + var rs = this.regions; + var north = rs["north"]; + var south = rs["south"]; + var west = rs["west"]; + var east = rs["east"]; + var center = rs["center"]; + //if(this.hideOnLayout){ // not supported anymore + //c.el.setStyle("display", "none"); + //} + if(north && north.isVisible()){ + var b = north.getBox(); + var m = north.getMargins(); + b.width = w - (m.left+m.right); + b.x = m.left; + b.y = m.top; + centerY = b.height + b.y + m.bottom; + centerH -= centerY; + north.updateBox(this.safeBox(b)); + } + if(south && south.isVisible()){ + var b = south.getBox(); + var m = south.getMargins(); + b.width = w - (m.left+m.right); + b.x = m.left; + var totalHeight = (b.height + m.top + m.bottom); + b.y = h - totalHeight + m.top; + centerH -= totalHeight; + south.updateBox(this.safeBox(b)); + } + if(west && west.isVisible()){ + var b = west.getBox(); + var m = west.getMargins(); + b.height = centerH - (m.top+m.bottom); + b.x = m.left; + b.y = centerY + m.top; + var totalWidth = (b.width + m.left + m.right); + centerX += totalWidth; + centerW -= totalWidth; + west.updateBox(this.safeBox(b)); + } + if(east && east.isVisible()){ + var b = east.getBox(); + var m = east.getMargins(); + b.height = centerH - (m.top+m.bottom); + var totalWidth = (b.width + m.left + m.right); + b.x = w - totalWidth + m.left; + b.y = centerY + m.top; + centerW -= totalWidth; + east.updateBox(this.safeBox(b)); + } + if(center){ + var m = center.getMargins(); + var centerBox = { + x: centerX + m.left, + y: centerY + m.top, + width: centerW - (m.left+m.right), + height: centerH - (m.top+m.bottom) + }; + //if(this.hideOnLayout){ + //center.el.setStyle("display", "block"); + //} + center.updateBox(this.safeBox(centerBox)); + } + this.el.repaint(); + this.fireEvent("layout", this); + }, + + // private + safeBox : function(box){ + box.width = Math.max(0, box.width); + box.height = Math.max(0, box.height); + return box; + }, + + /** + * Adds a ContentPanel (or subclass) to this layout. + * @param {String} target The target region key (north, south, east, west or center). + * @param {Roo.ContentPanel} panel The panel to add + * @return {Roo.ContentPanel} The added panel + */ + add : function(target, panel){ + + target = target.toLowerCase(); + return this.regions[target].add(panel); + }, + + /** + * Remove a ContentPanel (or subclass) to this layout. + * @param {String} target The target region key (north, south, east, west or center). + * @param {Number/String/Roo.ContentPanel} panel The index, id or panel to remove + * @return {Roo.ContentPanel} The removed panel + */ + remove : function(target, panel){ + target = target.toLowerCase(); + return this.regions[target].remove(panel); + }, + + /** + * Searches all regions for a panel with the specified id + * @param {String} panelId + * @return {Roo.ContentPanel} The panel or null if it wasn't found + */ + findPanel : function(panelId){ + var rs = this.regions; + for(var target in rs){ + if(typeof rs[target] != "function"){ + var p = rs[target].getPanel(panelId); + if(p){ + return p; + } + } + } + return null; + }, + + /** + * Searches all regions for a panel with the specified id and activates (shows) it. + * @param {String/ContentPanel} panelId The panels id or the panel itself + * @return {Roo.ContentPanel} The shown panel or null + */ + showPanel : function(panelId) { + var rs = this.regions; + for(var target in rs){ + var r = rs[target]; + if(typeof r != "function"){ + if(r.hasPanel(panelId)){ + return r.showPanel(panelId); + } + } + } + return null; + }, + + /** + * Restores this layout's state using Roo.state.Manager or the state provided by the passed provider. + * @param {Roo.state.Provider} provider (optional) An alternate state provider + */ + restoreState : function(provider){ + if(!provider){ + provider = Roo.state.Manager; + } + var sm = new Roo.LayoutStateManager(); + sm.init(this, provider); + }, + + /** + * Adds a batch of multiple ContentPanels dynamically by passing a special regions config object. This config + * object should contain properties for each region to add ContentPanels to, and each property's value should be + * a valid ContentPanel config object. Example: + * <pre><code> +// Create the main layout +var layout = new Roo.BorderLayout('main-ct', { + west: { + split:true, + minSize: 175, + titlebar: true + }, + center: { + title:'Components' + } +}, 'main-ct'); + +// Create and add multiple ContentPanels at once via configs +layout.batchAdd({ + west: { + id: 'source-files', + autoCreate:true, + title:'Ext Source Files', + autoScroll:true, + fitToFrame:true + }, + center : { + el: cview, + autoScroll:true, + fitToFrame:true, + toolbar: tb, + resizeEl:'cbody' + } +}); +</code></pre> + * @param {Object} regions An object containing ContentPanel configs by region name + */ + batchAdd : function(regions){ + this.beginUpdate(); + for(var rname in regions){ + var lr = this.regions[rname]; + if(lr){ + this.addTypedPanels(lr, regions[rname]); + } + } + this.endUpdate(); + }, + + // private + addTypedPanels : function(lr, ps){ + if(typeof ps == 'string'){ + lr.add(new Roo.ContentPanel(ps)); + } + else if(ps instanceof Array){ + for(var i =0, len = ps.length; i < len; i++){ + this.addTypedPanels(lr, ps[i]); + } + } + else if(!ps.events){ // raw config? + var el = ps.el; + delete ps.el; // prevent conflict + lr.add(new Roo.ContentPanel(el || Roo.id(), ps)); + } + else { // panel object assumed! + lr.add(ps); + } + }, + /** + * Adds a xtype elements to the layout. + * <pre><code> + +layout.addxtype({ + xtype : 'ContentPanel', + region: 'west', + items: [ .... ] + } +); + +layout.addxtype({ + xtype : 'NestedLayoutPanel', + region: 'west', + layout: { + center: { }, + west: { } + }, + items : [ ... list of content panels or nested layout panels.. ] + } +); +</code></pre> + * @param {Object} cfg Xtype definition of item to add. + */ + addxtype : function(cfg) + { + // basically accepts a pannel... + // can accept a layout region..!?!? + //Roo.log('Roo.BorderLayout add ' + cfg.xtype) + + if (!cfg.xtype.match(/Panel$/)) { + return false; + } + var ret = false; + + if (typeof(cfg.region) == 'undefined') { + Roo.log("Failed to add Panel, region was not set"); + Roo.log(cfg); + return false; + } + var region = cfg.region; + delete cfg.region; + + + var xitems = []; + if (cfg.items) { + xitems = cfg.items; + delete cfg.items; + } + var nb = false; + + switch(cfg.xtype) + { + case 'ContentPanel': // ContentPanel (el, cfg) + case 'ScrollPanel': // ContentPanel (el, cfg) + case 'ViewPanel': + if(cfg.autoCreate) { + ret = new Roo[cfg.xtype](cfg); // new panel!!!!! + } else { + var el = this.el.createChild(); + ret = new Roo[cfg.xtype](el, cfg); // new panel!!!!! + } + + this.add(region, ret); + break; + + + case 'TreePanel': // our new panel! + cfg.el = this.el.createChild(); + ret = new Roo[cfg.xtype](cfg); // new panel!!!!! + this.add(region, ret); + break; + + case 'NestedLayoutPanel': + // create a new Layout (which is a Border Layout... + var el = this.el.createChild(); + var clayout = cfg.layout; + delete cfg.layout; + clayout.items = clayout.items || []; + // replace this exitems with the clayout ones.. + xitems = clayout.items; + + + if (region == 'center' && this.active && this.getRegion('center').panels.length < 1) { + cfg.background = false; + } + var layout = new Roo.BorderLayout(el, clayout); + + ret = new Roo[cfg.xtype](layout, cfg); // new panel!!!!! + //console.log('adding nested layout panel ' + cfg.toSource()); + this.add(region, ret); + nb = {}; /// find first... + break; + + case 'GridPanel': + + // needs grid and region + + //var el = this.getRegion(region).el.createChild(); + var el = this.el.createChild(); + // create the grid first... + + var grid = new Roo.grid[cfg.grid.xtype](el, cfg.grid); + delete cfg.grid; + if (region == 'center' && this.active ) { + cfg.background = false; + } + ret = new Roo[cfg.xtype](grid, cfg); // new panel!!!!! + + this.add(region, ret); + if (cfg.background) { + ret.on('activate', function(gp) { + if (!gp.grid.rendered) { + gp.grid.render(); + } + }); + } else { + grid.render(); + } + break; + + + + + + + default: + if (typeof(Roo[cfg.xtype]) != 'undefined') { + + ret = new Roo[cfg.xtype](cfg); // new panel!!!!! + this.add(region, ret); + } else { + + alert("Can not add '" + cfg.xtype + "' to BorderLayout"); + return null; + } + + // GridPanel (grid, cfg) + + } + this.beginUpdate(); + // add children.. + var region = ''; + var abn = {}; + Roo.each(xitems, function(i) { + region = nb && i.region ? i.region : false; + + var add = ret.addxtype(i); + + if (region) { + nb[region] = nb[region] == undefined ? 0 : nb[region]+1; + if (!i.background) { + abn[region] = nb[region] ; + } + } + + }); + this.endUpdate(); + + // make the last non-background panel active.. + //if (nb) { Roo.log(abn); } + if (nb) { + + for(var r in abn) { + region = this.getRegion(r); + if (region) { + // tried using nb[r], but it does not work.. + + region.showPanel(abn[r]); + + } + } + } + return ret; + + } +}); + +/** + * Shortcut for creating a new BorderLayout object and adding one or more ContentPanels to it in a single step, handling + * the beginUpdate and endUpdate calls internally. The key to this method is the <b>panels</b> property that can be + * provided with each region config, which allows you to add ContentPanel configs in addition to the region configs + * during creation. The following code is equivalent to the constructor-based example at the beginning of this class: + * <pre><code> +// shorthand +var CP = Roo.ContentPanel; + +var layout = Roo.BorderLayout.create({ + north: { + initialSize: 25, + titlebar: false, + panels: [new CP("north", "North")] + }, + west: { + split:true, + initialSize: 200, + minSize: 175, + maxSize: 400, + titlebar: true, + collapsible: true, + panels: [new CP("west", {title: "West"})] + }, + east: { + split:true, + initialSize: 202, + minSize: 175, + maxSize: 400, + titlebar: true, + collapsible: true, + panels: [new CP("autoTabs", {title: "Auto Tabs", closable: true})] + }, + south: { + split:true, + initialSize: 100, + minSize: 100, + maxSize: 200, + titlebar: true, + collapsible: true, + panels: [new CP("south", {title: "South", closable: true})] + }, + center: { + titlebar: true, + autoScroll:true, + resizeTabs: true, + minTabWidth: 50, + preferredTabWidth: 150, + panels: [ + new CP("center1", {title: "Close Me", closable: true}), + new CP("center2", {title: "Center Panel", closable: false}) + ] + } +}, document.body); + +layout.getRegion("center").showPanel("center1"); +</code></pre> + * @param config + * @param targetEl + */ +Roo.BorderLayout.create = function(config, targetEl){ + var layout = new Roo.BorderLayout(targetEl || document.body, config); + layout.beginUpdate(); + var regions = Roo.BorderLayout.RegionFactory.validRegions; + for(var j = 0, jlen = regions.length; j < jlen; j++){ + var lr = regions[j]; + if(layout.regions[lr] && config[lr].panels){ + var r = layout.regions[lr]; + var ps = config[lr].panels; + layout.addTypedPanels(r, ps); + } + } + layout.endUpdate(); + return layout; +}; + +// private +Roo.BorderLayout.RegionFactory = { + // private + validRegions : ["north","south","east","west","center"], + + // private + create : function(target, mgr, config){ + target = target.toLowerCase(); + if(config.lightweight || config.basic){ + return new Roo.BasicLayoutRegion(mgr, config, target); + } + switch(target){ + case "north": + return new Roo.NorthLayoutRegion(mgr, config); + case "south": + return new Roo.SouthLayoutRegion(mgr, config); + case "east": + return new Roo.EastLayoutRegion(mgr, config); + case "west": + return new Roo.WestLayoutRegion(mgr, config); + case "center": + return new Roo.CenterLayoutRegion(mgr, config); + } + throw 'Layout region "'+target+'" not supported.'; + } +}; \ No newline at end of file diff --git a/docs2/src/Roo_BoxComponent.js.html b/docs2/src/Roo_BoxComponent.js.html new file mode 100644 index 0000000000..b0f7985f04 --- /dev/null +++ b/docs2/src/Roo_BoxComponent.js.html @@ -0,0 +1,283 @@ +/home/alan/gitlive/roojs1/Roo/BoxComponent.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.BoxComponent + * @extends Roo.Component + * Base class for any visual {@link Roo.Component} that uses a box container. BoxComponent provides automatic box + * model adjustments for sizing and positioning and will work correctly withnin the Component rendering model. All + * container classes should subclass BoxComponent so that they will work consistently when nested within other Ext + * layout containers. + * @constructor + * @param {Roo.Element/String/Object} config The configuration options. + */ +Roo.BoxComponent = function(config){ + Roo.Component.call(this, config); + this.addEvents({ + /** + * @event resize + * Fires after the component is resized. + * @param {Roo.Component} this + * @param {Number} adjWidth The box-adjusted width that was set + * @param {Number} adjHeight The box-adjusted height that was set + * @param {Number} rawWidth The width that was originally specified + * @param {Number} rawHeight The height that was originally specified + */ + resize : true, + /** + * @event move + * Fires after the component is moved. + * @param {Roo.Component} this + * @param {Number} x The new x position + * @param {Number} y The new y position + */ + move : true + }); +}; + +Roo.extend(Roo.BoxComponent, Roo.Component, { + // private, set in afterRender to signify that the component has been rendered + boxReady : false, + // private, used to defer height settings to subclasses + deferHeight: false, + /** @cfg {Number} width + * width (optional) size of component + */ + /** @cfg {Number} height + * height (optional) size of component + */ + + /** + * Sets the width and height of the component. This method fires the resize event. This method can accept + * either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}. + * @param {Number/Object} width The new width to set, or a size object in the format {width, height} + * @param {Number} height The new height to set (not required if a size object is passed as the first arg) + * @return {Roo.BoxComponent} this + */ + setSize : function(w, h){ + // support for standard size objects + if(typeof w == 'object'){ + h = w.height; + w = w.width; + } + // not rendered + if(!this.boxReady){ + this.width = w; + this.height = h; + return this; + } + + // prevent recalcs when not needed + if(this.lastSize && this.lastSize.width == w && this.lastSize.height == h){ + return this; + } + this.lastSize = {width: w, height: h}; + + var adj = this.adjustSize(w, h); + var aw = adj.width, ah = adj.height; + if(aw !== undefined || ah !== undefined){ // this code is nasty but performs better with floaters + var rz = this.getResizeEl(); + if(!this.deferHeight && aw !== undefined && ah !== undefined){ + rz.setSize(aw, ah); + }else if(!this.deferHeight && ah !== undefined){ + rz.setHeight(ah); + }else if(aw !== undefined){ + rz.setWidth(aw); + } + this.onResize(aw, ah, w, h); + this.fireEvent('resize', this, aw, ah, w, h); + } + return this; + }, + + /** + * Gets the current size of the component's underlying element. + * @return {Object} An object containing the element's size {width: (element width), height: (element height)} + */ + getSize : function(){ + return this.el.getSize(); + }, + + /** + * Gets the current XY position of the component's underlying element. + * @param {Boolean} local (optional) If true the element's left and top are returned instead of page XY (defaults to false) + * @return {Array} The XY position of the element (e.g., [100, 200]) + */ + getPosition : function(local){ + if(local === true){ + return [this.el.getLeft(true), this.el.getTop(true)]; + } + return this.xy || this.el.getXY(); + }, + + /** + * Gets the current box measurements of the component's underlying element. + * @param {Boolean} local (optional) If true the element's left and top are returned instead of page XY (defaults to false) + * @returns {Object} box An object in the format {x, y, width, height} + */ + getBox : function(local){ + var s = this.el.getSize(); + if(local){ + s.x = this.el.getLeft(true); + s.y = this.el.getTop(true); + }else{ + var xy = this.xy || this.el.getXY(); + s.x = xy[0]; + s.y = xy[1]; + } + return s; + }, + + /** + * Sets the current box measurements of the component's underlying element. + * @param {Object} box An object in the format {x, y, width, height} + * @returns {Roo.BoxComponent} this + */ + updateBox : function(box){ + this.setSize(box.width, box.height); + this.setPagePosition(box.x, box.y); + return this; + }, + + // protected + getResizeEl : function(){ + return this.resizeEl || this.el; + }, + + // protected + getPositionEl : function(){ + return this.positionEl || this.el; + }, + + /** + * Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}. + * This method fires the move event. + * @param {Number} left The new left + * @param {Number} top The new top + * @returns {Roo.BoxComponent} this + */ + setPosition : function(x, y){ + this.x = x; + this.y = y; + if(!this.boxReady){ + return this; + } + var adj = this.adjustPosition(x, y); + var ax = adj.x, ay = adj.y; + + var el = this.getPositionEl(); + if(ax !== undefined || ay !== undefined){ + if(ax !== undefined && ay !== undefined){ + el.setLeftTop(ax, ay); + }else if(ax !== undefined){ + el.setLeft(ax); + }else if(ay !== undefined){ + el.setTop(ay); + } + this.onPosition(ax, ay); + this.fireEvent('move', this, ax, ay); + } + return this; + }, + + /** + * Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}. + * This method fires the move event. + * @param {Number} x The new x position + * @param {Number} y The new y position + * @returns {Roo.BoxComponent} this + */ + setPagePosition : function(x, y){ + this.pageX = x; + this.pageY = y; + if(!this.boxReady){ + return; + } + if(x === undefined || y === undefined){ // cannot translate undefined points + return; + } + var p = this.el.translatePoints(x, y); + this.setPosition(p.left, p.top); + return this; + }, + + // private + onRender : function(ct, position){ + Roo.BoxComponent.superclass.onRender.call(this, ct, position); + if(this.resizeEl){ + this.resizeEl = Roo.get(this.resizeEl); + } + if(this.positionEl){ + this.positionEl = Roo.get(this.positionEl); + } + }, + + // private + afterRender : function(){ + Roo.BoxComponent.superclass.afterRender.call(this); + this.boxReady = true; + this.setSize(this.width, this.height); + if(this.x || this.y){ + this.setPosition(this.x, this.y); + } + if(this.pageX || this.pageY){ + this.setPagePosition(this.pageX, this.pageY); + } + }, + + /** + * Force the component's size to recalculate based on the underlying element's current height and width. + * @returns {Roo.BoxComponent} this + */ + syncSize : function(){ + delete this.lastSize; + this.setSize(this.el.getWidth(), this.el.getHeight()); + return this; + }, + + /** + * Called after the component is resized, this method is empty by default but can be implemented by any + * subclass that needs to perform custom logic after a resize occurs. + * @param {Number} adjWidth The box-adjusted width that was set + * @param {Number} adjHeight The box-adjusted height that was set + * @param {Number} rawWidth The width that was originally specified + * @param {Number} rawHeight The height that was originally specified + */ + onResize : function(adjWidth, adjHeight, rawWidth, rawHeight){ + + }, + + /** + * Called after the component is moved, this method is empty by default but can be implemented by any + * subclass that needs to perform custom logic after a move occurs. + * @param {Number} x The new x position + * @param {Number} y The new y position + */ + onPosition : function(x, y){ + + }, + + // private + adjustSize : function(w, h){ + if(this.autoWidth){ + w = 'auto'; + } + if(this.autoHeight){ + h = 'auto'; + } + return {width : w, height: h}; + }, + + // private + adjustPosition : function(x, y){ + return {x : x, y: y}; + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_Button.js.html b/docs2/src/Roo_Button.js.html new file mode 100644 index 0000000000..91ff70db66 --- /dev/null +++ b/docs2/src/Roo_Button.js.html @@ -0,0 +1,540 @@ +/home/alan/gitlive/roojs1/Roo/Button.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.Button + * @extends Roo.util.Observable + * Simple Button class + * @cfg {String} text The button text + * @cfg {String} icon The path to an image to display in the button (the image will be set as the background-image + * CSS property of the button by default, so if you want a mixed icon/text button, set cls:"x-btn-text-icon") + * @cfg {Function} handler A function called when the button is clicked (can be used instead of click event) + * @cfg {Object} scope The scope of the handler + * @cfg {Number} minWidth The minimum width for this button (used to give a set of buttons a common width) + * @cfg {String/Object} tooltip The tooltip for the button - can be a string or QuickTips config object + * @cfg {Boolean} hidden True to start hidden (defaults to false) + * @cfg {Boolean} disabled True to start disabled (defaults to false) + * @cfg {Boolean} pressed True to start pressed (only if enableToggle = true) + * @cfg {String} toggleGroup The group this toggle button is a member of (only 1 per group can be pressed, only + applies if enableToggle = true) + * @cfg {String/HTMLElement/Element} renderTo The element to append the button to + * @cfg {Boolean/Object} repeat True to repeat fire the click event while the mouse is down. This can also be + an {@link Roo.util.ClickRepeater} config object (defaults to false). + * @constructor + * Create a new button + * @param {Object} config The config object + */ +Roo.Button = function(renderTo, config) +{ + if (!config) { + config = renderTo; + renderTo = config.renderTo || false; + } + + Roo.apply(this, config); + this.addEvents({ + /** + * @event click + * Fires when this button is clicked + * @param {Button} this + * @param {EventObject} e The click event + */ + "click" : true, + /** + * @event toggle + * Fires when the "pressed" state of this button changes (only if enableToggle = true) + * @param {Button} this + * @param {Boolean} pressed + */ + "toggle" : true, + /** + * @event mouseover + * Fires when the mouse hovers over the button + * @param {Button} this + * @param {Event} e The event object + */ + 'mouseover' : true, + /** + * @event mouseout + * Fires when the mouse exits the button + * @param {Button} this + * @param {Event} e The event object + */ + 'mouseout': true, + /** + * @event render + * Fires when the button is rendered + * @param {Button} this + */ + 'render': true + }); + if(this.menu){ + this.menu = Roo.menu.MenuMgr.get(this.menu); + } + // register listeners first!! - so render can be captured.. + Roo.util.Observable.call(this); + if(renderTo){ + this.render(renderTo); + } + + +}; + +Roo.extend(Roo.Button, Roo.util.Observable, { + /** + * + */ + + /** + * Read-only. True if this button is hidden + * @type Boolean + */ + hidden : false, + /** + * Read-only. True if this button is disabled + * @type Boolean + */ + disabled : false, + /** + * Read-only. True if this button is pressed (only if enableToggle = true) + * @type Boolean + */ + pressed : false, + + /** + * @cfg {Number} tabIndex + * The DOM tabIndex for this button (defaults to undefined) + */ + tabIndex : undefined, + + /** + * @cfg {Boolean} enableToggle + * True to enable pressed/not pressed toggling (defaults to false) + */ + enableToggle: false, + /** + * @cfg {Mixed} menu + * Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined). + */ + menu : undefined, + /** + * @cfg {String} menuAlign + * The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?'). + */ + menuAlign : "tl-bl?", + + /** + * @cfg {String} iconCls + * A css class which sets a background image to be used as the icon for this button (defaults to undefined). + */ + iconCls : undefined, + /** + * @cfg {String} type + * The button's type, corresponding to the DOM input element type attribute. Either "submit," "reset" or "button" (default). + */ + type : 'button', + + // private + menuClassTarget: 'tr', + + /** + * @cfg {String} clickEvent + * The type of event to map to the button's event handler (defaults to 'click') + */ + clickEvent : 'click', + + /** + * @cfg {Boolean} handleMouseEvents + * False to disable visual cues on mouseover, mouseout and mousedown (defaults to true) + */ + handleMouseEvents : true, + + /** + * @cfg {String} tooltipType + * The type of tooltip to use. Either "qtip" (default) for QuickTips or "title" for title attribute. + */ + tooltipType : 'qtip', + + /** + * @cfg {String} cls + * A CSS class to apply to the button's main element. + */ + + /** + * @cfg {Roo.Template} template (Optional) + * An {@link Roo.Template} with which to create the Button's main element. This Template must + * contain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could + * require code modifications if required elements (e.g. a button) aren't present. + */ + + // private + render : function(renderTo){ + var btn; + if(this.hideParent){ + this.parentEl = Roo.get(renderTo); + } + if(!this.dhconfig){ + if(!this.template){ + if(!Roo.Button.buttonTemplate){ + // hideous table template + Roo.Button.buttonTemplate = new Roo.Template( + '<table border="0" cellpadding="0" cellspacing="0" class="x-btn-wrap"><tbody><tr>', + '<td class="x-btn-left"><i>&#160;</i></td><td class="x-btn-center"><em unselectable="on"><button class="x-btn-text" type="{1}">{0}</button></em></td><td class="x-btn-right"><i>&#160;</i></td>', + "</tr></tbody></table>"); + } + this.template = Roo.Button.buttonTemplate; + } + btn = this.template.append(renderTo, [this.text || '&#160;', this.type], true); + var btnEl = btn.child("button:first"); + btnEl.on('focus', this.onFocus, this); + btnEl.on('blur', this.onBlur, this); + if(this.cls){ + btn.addClass(this.cls); + } + if(this.icon){ + btnEl.setStyle('background-image', 'url(' +this.icon +')'); + } + if(this.iconCls){ + btnEl.addClass(this.iconCls); + if(!this.cls){ + btn.addClass(this.text ? 'x-btn-text-icon' : 'x-btn-icon'); + } + } + if(this.tabIndex !== undefined){ + btnEl.dom.tabIndex = this.tabIndex; + } + if(this.tooltip){ + if(typeof this.tooltip == 'object'){ + Roo.QuickTips.tips(Roo.apply({ + target: btnEl.id + }, this.tooltip)); + } else { + btnEl.dom[this.tooltipType] = this.tooltip; + } + } + }else{ + btn = Roo.DomHelper.append(Roo.get(renderTo).dom, this.dhconfig, true); + } + this.el = btn; + if(this.id){ + this.el.dom.id = this.el.id = this.id; + } + if(this.menu){ + this.el.child(this.menuClassTarget).addClass("x-btn-with-menu"); + this.menu.on("show", this.onMenuShow, this); + this.menu.on("hide", this.onMenuHide, this); + } + btn.addClass("x-btn"); + if(Roo.isIE && !Roo.isIE7){ + this.autoWidth.defer(1, this); + }else{ + this.autoWidth(); + } + if(this.handleMouseEvents){ + btn.on("mouseover", this.onMouseOver, this); + btn.on("mouseout", this.onMouseOut, this); + btn.on("mousedown", this.onMouseDown, this); + } + btn.on(this.clickEvent, this.onClick, this); + //btn.on("mouseup", this.onMouseUp, this); + if(this.hidden){ + this.hide(); + } + if(this.disabled){ + this.disable(); + } + Roo.ButtonToggleMgr.register(this); + if(this.pressed){ + this.el.addClass("x-btn-pressed"); + } + if(this.repeat){ + var repeater = new Roo.util.ClickRepeater(btn, + typeof this.repeat == "object" ? this.repeat : {} + ); + repeater.on("click", this.onClick, this); + } + + this.fireEvent('render', this); + + }, + /** + * Returns the button's underlying element + * @return {Roo.Element} The element + */ + getEl : function(){ + return this.el; + }, + + /** + * Destroys this Button and removes any listeners. + */ + destroy : function(){ + Roo.ButtonToggleMgr.unregister(this); + this.el.removeAllListeners(); + this.purgeListeners(); + this.el.remove(); + }, + + // private + autoWidth : function(){ + if(this.el){ + this.el.setWidth("auto"); + if(Roo.isIE7 && Roo.isStrict){ + var ib = this.el.child('button'); + if(ib && ib.getWidth() > 20){ + ib.clip(); + ib.setWidth(Roo.util.TextMetrics.measure(ib, this.text).width+ib.getFrameWidth('lr')); + } + } + if(this.minWidth){ + if(this.hidden){ + this.el.beginMeasure(); + } + if(this.el.getWidth() < this.minWidth){ + this.el.setWidth(this.minWidth); + } + if(this.hidden){ + this.el.endMeasure(); + } + } + } + }, + + /** + * Assigns this button's click handler + * @param {Function} handler The function to call when the button is clicked + * @param {Object} scope (optional) Scope for the function passed in + */ + setHandler : function(handler, scope){ + this.handler = handler; + this.scope = scope; + }, + + /** + * Sets this button's text + * @param {String} text The button text + */ + setText : function(text){ + this.text = text; + if(this.el){ + this.el.child("td.x-btn-center button.x-btn-text").update(text); + } + this.autoWidth(); + }, + + /** + * Gets the text for this button + * @return {String} The button text + */ + getText : function(){ + return this.text; + }, + + /** + * Show this button + */ + show: function(){ + this.hidden = false; + if(this.el){ + this[this.hideParent? 'parentEl' : 'el'].setStyle("display", ""); + } + }, + + /** + * Hide this button + */ + hide: function(){ + this.hidden = true; + if(this.el){ + this[this.hideParent? 'parentEl' : 'el'].setStyle("display", "none"); + } + }, + + /** + * Convenience function for boolean show/hide + * @param {Boolean} visible True to show, false to hide + */ + setVisible: function(visible){ + if(visible) { + this.show(); + }else{ + this.hide(); + } + }, + + /** + * If a state it passed, it becomes the pressed state otherwise the current state is toggled. + * @param {Boolean} state (optional) Force a particular state + */ + toggle : function(state){ + state = state === undefined ? !this.pressed : state; + if(state != this.pressed){ + if(state){ + this.el.addClass("x-btn-pressed"); + this.pressed = true; + this.fireEvent("toggle", this, true); + }else{ + this.el.removeClass("x-btn-pressed"); + this.pressed = false; + this.fireEvent("toggle", this, false); + } + if(this.toggleHandler){ + this.toggleHandler.call(this.scope || this, this, state); + } + } + }, + + /** + * Focus the button + */ + focus : function(){ + this.el.child('button:first').focus(); + }, + + /** + * Disable this button + */ + disable : function(){ + if(this.el){ + this.el.addClass("x-btn-disabled"); + } + this.disabled = true; + }, + + /** + * Enable this button + */ + enable : function(){ + if(this.el){ + this.el.removeClass("x-btn-disabled"); + } + this.disabled = false; + }, + + /** + * Convenience function for boolean enable/disable + * @param {Boolean} enabled True to enable, false to disable + */ + setDisabled : function(v){ + this[v !== true ? "enable" : "disable"](); + }, + + // private + onClick : function(e) + { + if(e){ + e.preventDefault(); + } + if(e.button != 0){ + return; + } + if(!this.disabled){ + if(this.enableToggle){ + this.toggle(); + } + if(this.menu && !this.menu.isVisible()){ + this.menu.show(this.el, this.menuAlign); + } + this.fireEvent("click", this, e); + if(this.handler){ + this.el.removeClass("x-btn-over"); + this.handler.call(this.scope || this, this, e); + } + } + }, + // private + onMouseOver : function(e){ + if(!this.disabled){ + this.el.addClass("x-btn-over"); + this.fireEvent('mouseover', this, e); + } + }, + // private + onMouseOut : function(e){ + if(!e.within(this.el, true)){ + this.el.removeClass("x-btn-over"); + this.fireEvent('mouseout', this, e); + } + }, + // private + onFocus : function(e){ + if(!this.disabled){ + this.el.addClass("x-btn-focus"); + } + }, + // private + onBlur : function(e){ + this.el.removeClass("x-btn-focus"); + }, + // private + onMouseDown : function(e){ + if(!this.disabled && e.button == 0){ + this.el.addClass("x-btn-click"); + Roo.get(document).on('mouseup', this.onMouseUp, this); + } + }, + // private + onMouseUp : function(e){ + if(e.button == 0){ + this.el.removeClass("x-btn-click"); + Roo.get(document).un('mouseup', this.onMouseUp, this); + } + }, + // private + onMenuShow : function(e){ + this.el.addClass("x-btn-menu-active"); + }, + // private + onMenuHide : function(e){ + this.el.removeClass("x-btn-menu-active"); + } +}); + +// Private utility class used by Button +Roo.ButtonToggleMgr = function(){ + var groups = {}; + + function toggleGroup(btn, state){ + if(state){ + var g = groups[btn.toggleGroup]; + for(var i = 0, l = g.length; i < l; i++){ + if(g[i] != btn){ + g[i].toggle(false); + } + } + } + } + + return { + register : function(btn){ + if(!btn.toggleGroup){ + return; + } + var g = groups[btn.toggleGroup]; + if(!g){ + g = groups[btn.toggleGroup] = []; + } + g.push(btn); + btn.on("toggle", toggleGroup); + }, + + unregister : function(btn){ + if(!btn.toggleGroup){ + return; + } + var g = groups[btn.toggleGroup]; + if(g){ + g.remove(btn); + btn.un("toggle", toggleGroup); + } + } + }; +}(); \ No newline at end of file diff --git a/docs2/src/Roo_CalendarPanel.js.html b/docs2/src/Roo_CalendarPanel.js.html new file mode 100644 index 0000000000..e9ce472965 --- /dev/null +++ b/docs2/src/Roo_CalendarPanel.js.html @@ -0,0 +1,176 @@ +/home/alan/gitlive/roojs1/Roo/CalendarPanel.js/* + * - LGPL + * + * based on jquery fullcalendar + * + */ + + +/** + * @class Roo.Calendar + * @extends Roo.Component + * Bootstrap Calendar class + + * @constructor + * Create a new Container + * @param {Object} config The config object + */ + +Roo.CalendarPanel = function(config){ + + Roo.log("cal panel ctr"); + + this.wrapper = Roo.DomHelper.append(document.body, // wrapper for IE7 strict & safari scroll issue + {tag: "div", cls: "x-layout-grid-wrapper x-layout-inactive-content"}, true); + + //this.wrapper.dom.appendChild(grid.getGridEl().dom); + + Roo.CalendarPanel.superclass.constructor.call(this, this.wrapper, config); + + Roo.log(this.el); + + if(this.toolbar){ + this.toolbar.el.insertBefore(this.wrapper.dom.firstChild); + } + // xtype created footer. - not sure if will work as we normally have to render first.. + if (this.footer && !this.footer.el && this.footer.xtype) { + + //this.footer.container = this.grid.getView().getFooterPanel(true); + //this.footer.dataSource = this.grid.dataSource; + //this.footer = Roo.factory(this.footer, Roo); + + } + this.view = new Roo.calendar.View(Roo.apply({ + skipNavHeader : true, + skipMonthHeader : false + + },config)); + + + this.on('activate', function() + { + Roo.log('activate'); + + //console.log('render tree'); + this.render(); + },this); + + this.addEvents({ + /** + * @event select + * Fires when a date is selected + * @param {DatePicker} this + * @param {Date} date The selected date + */ + 'select': true, + /** + * @event monthchange + * Fires when the displayed month changes + * @param {DatePicker} this + * @param {Date} date The selected month + */ + 'monthchange': true, + /** + * @event evententer + * Fires when mouse over an event + * @param {Calendar} this + * @param {event} Event + */ + 'evententer': true, + /** + * @event eventleave + * Fires when the mouse leaves an + * @param {Calendar} this + * @param {event} + */ + 'eventleave': true, + /** + * @event eventclick + * Fires when the mouse click an + * @param {Calendar} this + * @param {event} + */ + 'eventclick': true, + /** + * @event rendered + * Fires when the grid is rendered + * @param {Calendar} this + + */ + 'rendered': true + + + }); + this.relayEvents(this.view, ["select","monthchange","evententer","eventleave","rendered"]); + + //this.grid = grid; + //this.grid.getGridEl().replaceClass("x-layout-inactive-content", "x-layout-component-panel"); +}; + + +Roo.extend(Roo.CalendarPanel, Roo.ContentPanel, { + + + render : function() + { + var ct = this.el.appendChild(document.createElement("div")); + this.onRender(this.el, false) + }, + + onRender : function(ct, position) + { + if (this.rendered) { + return; + } + this.rendered = true; + + Roo.log("render calendar"); + + + //Roo.bootstrap.Component.superclass.onRender.call(this, ct, position); + + + var cfg = Roo.apply({}, this.view.getAutoCreate()); + cfg.id = Roo.id(); + + // fill in the extra attributes + if (this.xattr && typeof(this.xattr) =='object') { + for (var i in this.xattr) { + cfg[i] = this.xattr[i]; + } + } + + if(this.dataId){ + cfg.dataId = this.dataId; + } + + if (this.cls) { + cfg.cls = (typeof(cfg.cls) == 'undefined') ? this.cls : cfg.cls + ' ' + this.cls; + } + + if (this.style) { // fixme needs to support more complex style data. + cfg.style = this.style; + } + + if(this.name){ + cfg.name = this.name; + } + + this.view.el = ct.createChild(cfg, position); + + //if(this.tabIndex !== undefined){ + // this.el.dom.setAttribute('tabIndex', this.tabIndex); + //} + + + this.view.initEvents(); + this.fireEvent('rendered'); + } + + + + +}); + + + \ No newline at end of file diff --git a/docs2/src/Roo_CenterLayoutRegion.js.html b/docs2/src/Roo_CenterLayoutRegion.js.html new file mode 100644 index 0000000000..da497cc348 --- /dev/null +++ b/docs2/src/Roo_CenterLayoutRegion.js.html @@ -0,0 +1,204 @@ +/home/alan/gitlive/roojs1/Roo/CenterLayoutRegion.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/* + * These classes are private internal classes + */ +Roo.CenterLayoutRegion = function(mgr, config){ + Roo.LayoutRegion.call(this, mgr, config, "center"); + this.visible = true; + this.minWidth = config.minWidth || 20; + this.minHeight = config.minHeight || 20; +}; + +Roo.extend(Roo.CenterLayoutRegion, Roo.LayoutRegion, { + hide : function(){ + // center panel can't be hidden + }, + + show : function(){ + // center panel can't be hidden + }, + + getMinWidth: function(){ + return this.minWidth; + }, + + getMinHeight: function(){ + return this.minHeight; + } +}); + + +Roo.NorthLayoutRegion = function(mgr, config){ + Roo.LayoutRegion.call(this, mgr, config, "north", "n-resize"); + if(this.split){ + this.split.placement = Roo.SplitBar.TOP; + this.split.orientation = Roo.SplitBar.VERTICAL; + this.split.el.addClass("x-layout-split-v"); + } + var size = config.initialSize || config.height; + if(typeof size != "undefined"){ + this.el.setHeight(size); + } +}; +Roo.extend(Roo.NorthLayoutRegion, Roo.SplitLayoutRegion, { + orientation: Roo.SplitBar.VERTICAL, + getBox : function(){ + if(this.collapsed){ + return this.collapsedEl.getBox(); + } + var box = this.el.getBox(); + if(this.split){ + box.height += this.split.el.getHeight(); + } + return box; + }, + + updateBox : function(box){ + if(this.split && !this.collapsed){ + box.height -= this.split.el.getHeight(); + this.split.el.setLeft(box.x); + this.split.el.setTop(box.y+box.height); + this.split.el.setWidth(box.width); + } + if(this.collapsed){ + this.updateBody(box.width, null); + } + Roo.LayoutRegion.prototype.updateBox.call(this, box); + } +}); + +Roo.SouthLayoutRegion = function(mgr, config){ + Roo.SplitLayoutRegion.call(this, mgr, config, "south", "s-resize"); + if(this.split){ + this.split.placement = Roo.SplitBar.BOTTOM; + this.split.orientation = Roo.SplitBar.VERTICAL; + this.split.el.addClass("x-layout-split-v"); + } + var size = config.initialSize || config.height; + if(typeof size != "undefined"){ + this.el.setHeight(size); + } +}; +Roo.extend(Roo.SouthLayoutRegion, Roo.SplitLayoutRegion, { + orientation: Roo.SplitBar.VERTICAL, + getBox : function(){ + if(this.collapsed){ + return this.collapsedEl.getBox(); + } + var box = this.el.getBox(); + if(this.split){ + var sh = this.split.el.getHeight(); + box.height += sh; + box.y -= sh; + } + return box; + }, + + updateBox : function(box){ + if(this.split && !this.collapsed){ + var sh = this.split.el.getHeight(); + box.height -= sh; + box.y += sh; + this.split.el.setLeft(box.x); + this.split.el.setTop(box.y-sh); + this.split.el.setWidth(box.width); + } + if(this.collapsed){ + this.updateBody(box.width, null); + } + Roo.LayoutRegion.prototype.updateBox.call(this, box); + } +}); + +Roo.EastLayoutRegion = function(mgr, config){ + Roo.SplitLayoutRegion.call(this, mgr, config, "east", "e-resize"); + if(this.split){ + this.split.placement = Roo.SplitBar.RIGHT; + this.split.orientation = Roo.SplitBar.HORIZONTAL; + this.split.el.addClass("x-layout-split-h"); + } + var size = config.initialSize || config.width; + if(typeof size != "undefined"){ + this.el.setWidth(size); + } +}; +Roo.extend(Roo.EastLayoutRegion, Roo.SplitLayoutRegion, { + orientation: Roo.SplitBar.HORIZONTAL, + getBox : function(){ + if(this.collapsed){ + return this.collapsedEl.getBox(); + } + var box = this.el.getBox(); + if(this.split){ + var sw = this.split.el.getWidth(); + box.width += sw; + box.x -= sw; + } + return box; + }, + + updateBox : function(box){ + if(this.split && !this.collapsed){ + var sw = this.split.el.getWidth(); + box.width -= sw; + this.split.el.setLeft(box.x); + this.split.el.setTop(box.y); + this.split.el.setHeight(box.height); + box.x += sw; + } + if(this.collapsed){ + this.updateBody(null, box.height); + } + Roo.LayoutRegion.prototype.updateBox.call(this, box); + } +}); + +Roo.WestLayoutRegion = function(mgr, config){ + Roo.SplitLayoutRegion.call(this, mgr, config, "west", "w-resize"); + if(this.split){ + this.split.placement = Roo.SplitBar.LEFT; + this.split.orientation = Roo.SplitBar.HORIZONTAL; + this.split.el.addClass("x-layout-split-h"); + } + var size = config.initialSize || config.width; + if(typeof size != "undefined"){ + this.el.setWidth(size); + } +}; +Roo.extend(Roo.WestLayoutRegion, Roo.SplitLayoutRegion, { + orientation: Roo.SplitBar.HORIZONTAL, + getBox : function(){ + if(this.collapsed){ + return this.collapsedEl.getBox(); + } + var box = this.el.getBox(); + if(this.split){ + box.width += this.split.el.getWidth(); + } + return box; + }, + + updateBox : function(box){ + if(this.split && !this.collapsed){ + var sw = this.split.el.getWidth(); + box.width -= sw; + this.split.el.setLeft(box.x+box.width); + this.split.el.setTop(box.y); + this.split.el.setHeight(box.height); + } + if(this.collapsed){ + this.updateBody(null, box.height); + } + Roo.LayoutRegion.prototype.updateBox.call(this, box); + } +}); + \ No newline at end of file diff --git a/docs2/src/Roo_ColorPalette.js.html b/docs2/src/Roo_ColorPalette.js.html new file mode 100644 index 0000000000..40304d8d49 --- /dev/null +++ b/docs2/src/Roo_ColorPalette.js.html @@ -0,0 +1,148 @@ +/home/alan/gitlive/roojs1/Roo/ColorPalette.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.ColorPalette + * @extends Roo.Component + * Simple color palette class for choosing colors. The palette can be rendered to any container.<br /> + * Here's an example of typical usage: + * <pre><code> +var cp = new Roo.ColorPalette({value:'993300'}); // initial selected color +cp.render('my-div'); + +cp.on('select', function(palette, selColor){ + // do something with selColor +}); +</code></pre> + * @constructor + * Create a new ColorPalette + * @param {Object} config The config object + */ +Roo.ColorPalette = function(config){ + Roo.ColorPalette.superclass.constructor.call(this, config); + this.addEvents({ + /** + * @event select + * Fires when a color is selected + * @param {ColorPalette} this + * @param {String} color The 6-digit color hex code (without the # symbol) + */ + select: true + }); + + if(this.handler){ + this.on("select", this.handler, this.scope, true); + } +}; +Roo.extend(Roo.ColorPalette, Roo.Component, { + /** + * @cfg {String} itemCls + * The CSS class to apply to the containing element (defaults to "x-color-palette") + */ + itemCls : "x-color-palette", + /** + * @cfg {String} value + * The initial color to highlight (should be a valid 6-digit color hex code without the # symbol). Note that + * the hex codes are case-sensitive. + */ + value : null, + clickEvent:'click', + // private + ctype: "Roo.ColorPalette", + + /** + * @cfg {Boolean} allowReselect If set to true then reselecting a color that is already selected fires the selection event + */ + allowReselect : false, + + /** + * <p>An array of 6-digit color hex code strings (without the # symbol). This array can contain any number + * of colors, and each hex code should be unique. The width of the palette is controlled via CSS by adjusting + * the width property of the 'x-color-palette' class (or assigning a custom class), so you can balance the number + * of colors with the width setting until the box is symmetrical.</p> + * <p>You can override individual colors if needed:</p> + * <pre><code> +var cp = new Roo.ColorPalette(); +cp.colors[0] = "FF0000"; // change the first box to red +</code></pre> + +Or you can provide a custom array of your own for complete control: +<pre><code> +var cp = new Roo.ColorPalette(); +cp.colors = ["000000", "993300", "333300"]; +</code></pre> + * @type Array + */ + colors : [ + "000000", "993300", "333300", "003300", "003366", "000080", "333399", "333333", + "800000", "FF6600", "808000", "008000", "008080", "0000FF", "666699", "808080", + "FF0000", "FF9900", "99CC00", "339966", "33CCCC", "3366FF", "800080", "969696", + "FF00FF", "FFCC00", "FFFF00", "00FF00", "00FFFF", "00CCFF", "993366", "C0C0C0", + "FF99CC", "FFCC99", "FFFF99", "CCFFCC", "CCFFFF", "99CCFF", "CC99FF", "FFFFFF" + ], + + // private + onRender : function(container, position){ + var t = new Roo.MasterTemplate( + '<tpl><a href="#" class="color-{0}" hidefocus="on"><em><span style="background:#{0}" unselectable="on">&#160;</span></em></a></tpl>' + ); + var c = this.colors; + for(var i = 0, len = c.length; i < len; i++){ + t.add([c[i]]); + } + var el = document.createElement("div"); + el.className = this.itemCls; + t.overwrite(el); + container.dom.insertBefore(el, position); + this.el = Roo.get(el); + this.el.on(this.clickEvent, this.handleClick, this, {delegate: "a"}); + if(this.clickEvent != 'click'){ + this.el.on('click', Roo.emptyFn, this, {delegate: "a", preventDefault:true}); + } + }, + + // private + afterRender : function(){ + Roo.ColorPalette.superclass.afterRender.call(this); + if(this.value){ + var s = this.value; + this.value = null; + this.select(s); + } + }, + + // private + handleClick : function(e, t){ + e.preventDefault(); + if(!this.disabled){ + var c = t.className.match(/(?:^|\s)color-(.{6})(?:\s|$)/)[1]; + this.select(c.toUpperCase()); + } + }, + + /** + * Selects the specified color in the palette (fires the select event) + * @param {String} color A valid 6-digit color hex code (# will be stripped if included) + */ + select : function(color){ + color = color.replace("#", ""); + if(color != this.value || this.allowReselect){ + var el = this.el; + if(this.value){ + el.child("a.color-"+this.value).removeClass("x-color-palette-sel"); + } + el.child("a.color-"+color).addClass("x-color-palette-sel"); + this.value = color; + this.fireEvent("select", this, color); + } + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_Component.js.html b/docs2/src/Roo_Component.js.html new file mode 100644 index 0000000000..d7339793a8 --- /dev/null +++ b/docs2/src/Roo_Component.js.html @@ -0,0 +1,431 @@ +/home/alan/gitlive/roojs1/Roo/Component.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.Component + * @extends Roo.util.Observable + * Base class for all major Roo components. All subclasses of Component can automatically participate in the standard + * Roo component lifecycle of creation, rendering and destruction. They also have automatic support for basic hide/show + * and enable/disable behavior. Component allows any subclass to be lazy-rendered into any {@link Roo.Container} and + * to be automatically registered with the {@link Roo.ComponentMgr} so that it can be referenced at any time via {@link Roo.getCmp}. + * All visual components (widgets) that require rendering into a layout should subclass Component. + * @constructor + * @param {Roo.Element/String/Object} config The configuration options. If an element is passed, it is set as the internal + * 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 + * and is used as the component id. Otherwise, it is assumed to be a standard config object and is applied to the component. + */ +Roo.Component = function(config){ + config = config || {}; + if(config.tagName || config.dom || typeof config == "string"){ // element object + config = {el: config, id: config.id || config}; + } + this.initialConfig = config; + + Roo.apply(this, config); + this.addEvents({ + /** + * @event disable + * Fires after the component is disabled. + * @param {Roo.Component} this + */ + disable : true, + /** + * @event enable + * Fires after the component is enabled. + * @param {Roo.Component} this + */ + enable : true, + /** + * @event beforeshow + * Fires before the component is shown. Return false to stop the show. + * @param {Roo.Component} this + */ + beforeshow : true, + /** + * @event show + * Fires after the component is shown. + * @param {Roo.Component} this + */ + show : true, + /** + * @event beforehide + * Fires before the component is hidden. Return false to stop the hide. + * @param {Roo.Component} this + */ + beforehide : true, + /** + * @event hide + * Fires after the component is hidden. + * @param {Roo.Component} this + */ + hide : true, + /** + * @event beforerender + * Fires before the component is rendered. Return false to stop the render. + * @param {Roo.Component} this + */ + beforerender : true, + /** + * @event render + * Fires after the component is rendered. + * @param {Roo.Component} this + */ + render : true, + /** + * @event beforedestroy + * Fires before the component is destroyed. Return false to stop the destroy. + * @param {Roo.Component} this + */ + beforedestroy : true, + /** + * @event destroy + * Fires after the component is destroyed. + * @param {Roo.Component} this + */ + destroy : true + }); + if(!this.id){ + this.id = "roo-comp-" + (++Roo.Component.AUTO_ID); + } + Roo.ComponentMgr.register(this); + Roo.Component.superclass.constructor.call(this); + this.initComponent(); + if(this.renderTo){ // not supported by all components yet. use at your own risk! + this.render(this.renderTo); + delete this.renderTo; + } +}; + +/** @private */ +Roo.Component.AUTO_ID = 1000; + +Roo.extend(Roo.Component, Roo.util.Observable, { + /** + * @scope Roo.Component.prototype + * @type {Boolean} + * true if this component is hidden. Read-only. + */ + hidden : false, + /** + * @type {Boolean} + * true if this component is disabled. Read-only. + */ + disabled : false, + /** + * @type {Boolean} + * true if this component has been rendered. Read-only. + */ + rendered : false, + + /** @cfg {String} disableClass + * CSS class added to the component when it is disabled (defaults to "x-item-disabled"). + */ + disabledClass : "x-item-disabled", + /** @cfg {Boolean} allowDomMove + * Whether the component can move the Dom node when rendering (defaults to true). + */ + allowDomMove : true, + /** @cfg {String} hideMode (display|visibility) + * How this component should hidden. Supported values are + * "visibility" (css visibility), "offsets" (negative offset position) and + * "display" (css display) - defaults to "display". + */ + hideMode: 'display', + + /** @private */ + ctype : "Roo.Component", + + /** + * @cfg {String} actionMode + * which property holds the element that used for hide() / show() / disable() / enable() + * default is 'el' + */ + actionMode : "el", + + /** @private */ + getActionEl : function(){ + return this[this.actionMode]; + }, + + initComponent : Roo.emptyFn, + /** + * If this is a lazy rendering component, render it to its container element. + * @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. + */ + render : function(container, position){ + + if(this.rendered){ + return this; + } + + if(this.fireEvent("beforerender", this) === false){ + return false; + } + + if(!container && this.el){ + this.el = Roo.get(this.el); + container = this.el.dom.parentNode; + this.allowDomMove = false; + } + this.container = Roo.get(container); + this.rendered = true; + if(position !== undefined){ + if(typeof position == 'number'){ + position = this.container.dom.childNodes[position]; + }else{ + position = Roo.getDom(position); + } + } + this.onRender(this.container, position || null); + if(this.cls){ + this.el.addClass(this.cls); + delete this.cls; + } + if(this.style){ + this.el.applyStyles(this.style); + delete this.style; + } + this.fireEvent("render", this); + this.afterRender(this.container); + if(this.hidden){ + this.hide(); + } + if(this.disabled){ + this.disable(); + } + + return this; + + }, + + /** @private */ + // default function is not really useful + onRender : function(ct, position){ + if(this.el){ + this.el = Roo.get(this.el); + if(this.allowDomMove !== false){ + ct.dom.insertBefore(this.el.dom, position); + } + } + }, + + /** @private */ + getAutoCreate : function(){ + var cfg = typeof this.autoCreate == "object" ? + this.autoCreate : Roo.apply({}, this.defaultAutoCreate); + if(this.id && !cfg.id){ + cfg.id = this.id; + } + return cfg; + }, + + /** @private */ + afterRender : Roo.emptyFn, + + /** + * Destroys this component by purging any event listeners, removing the component's element from the DOM, + * removing the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}. + */ + destroy : function(){ + if(this.fireEvent("beforedestroy", this) !== false){ + this.purgeListeners(); + this.beforeDestroy(); + if(this.rendered){ + this.el.removeAllListeners(); + this.el.remove(); + if(this.actionMode == "container"){ + this.container.remove(); + } + } + this.onDestroy(); + Roo.ComponentMgr.unregister(this); + this.fireEvent("destroy", this); + } + }, + + /** @private */ + beforeDestroy : function(){ + + }, + + /** @private */ + onDestroy : function(){ + + }, + + /** + * Returns the underlying {@link Roo.Element}. + * @return {Roo.Element} The element + */ + getEl : function(){ + return this.el; + }, + + /** + * Returns the id of this component. + * @return {String} + */ + getId : function(){ + return this.id; + }, + + /** + * Try to focus this component. + * @param {Boolean} selectText True to also select the text in this component (if applicable) + * @return {Roo.Component} this + */ + focus : function(selectText){ + if(this.rendered){ + this.el.focus(); + if(selectText === true){ + this.el.dom.select(); + } + } + return this; + }, + + /** @private */ + blur : function(){ + if(this.rendered){ + this.el.blur(); + } + return this; + }, + + /** + * Disable this component. + * @return {Roo.Component} this + */ + disable : function(){ + if(this.rendered){ + this.onDisable(); + } + this.disabled = true; + this.fireEvent("disable", this); + return this; + }, + + // private + onDisable : function(){ + this.getActionEl().addClass(this.disabledClass); + this.el.dom.disabled = true; + }, + + /** + * Enable this component. + * @return {Roo.Component} this + */ + enable : function(){ + if(this.rendered){ + this.onEnable(); + } + this.disabled = false; + this.fireEvent("enable", this); + return this; + }, + + // private + onEnable : function(){ + this.getActionEl().removeClass(this.disabledClass); + this.el.dom.disabled = false; + }, + + /** + * Convenience function for setting disabled/enabled by boolean. + * @param {Boolean} disabled + */ + setDisabled : function(disabled){ + this[disabled ? "disable" : "enable"](); + }, + + /** + * Show this component. + * @return {Roo.Component} this + */ + show: function(){ + if(this.fireEvent("beforeshow", this) !== false){ + this.hidden = false; + if(this.rendered){ + this.onShow(); + } + this.fireEvent("show", this); + } + return this; + }, + + // private + onShow : function(){ + var ae = this.getActionEl(); + if(this.hideMode == 'visibility'){ + ae.dom.style.visibility = "visible"; + }else if(this.hideMode == 'offsets'){ + ae.removeClass('x-hidden'); + }else{ + ae.dom.style.display = ""; + } + }, + + /** + * Hide this component. + * @return {Roo.Component} this + */ + hide: function(){ + if(this.fireEvent("beforehide", this) !== false){ + this.hidden = true; + if(this.rendered){ + this.onHide(); + } + this.fireEvent("hide", this); + } + return this; + }, + + // private + onHide : function(){ + var ae = this.getActionEl(); + if(this.hideMode == 'visibility'){ + ae.dom.style.visibility = "hidden"; + }else if(this.hideMode == 'offsets'){ + ae.addClass('x-hidden'); + }else{ + ae.dom.style.display = "none"; + } + }, + + /** + * Convenience function to hide or show this component by boolean. + * @param {Boolean} visible True to show, false to hide + * @return {Roo.Component} this + */ + setVisible: function(visible){ + if(visible) { + this.show(); + }else{ + this.hide(); + } + return this; + }, + + /** + * Returns true if this component is visible. + */ + isVisible : function(){ + return this.getActionEl().isVisible(); + }, + + cloneConfig : function(overrides){ + overrides = overrides || {}; + var id = overrides.id || Roo.id(); + var cfg = Roo.applyIf(overrides, this.initialConfig); + cfg.id = id; // prevent dup id + return new this.constructor(cfg); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_ComponentMgr.js.html b/docs2/src/Roo_ComponentMgr.js.html new file mode 100644 index 0000000000..2ece23d704 --- /dev/null +++ b/docs2/src/Roo_ComponentMgr.js.html @@ -0,0 +1,61 @@ +/home/alan/gitlive/roojs1/Roo/ComponentMgr.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.ComponentMgr + * Provides a common registry of all components on a page so that they can be easily accessed by component id (see {@link Roo.getCmp}). + * @singleton + */ +Roo.ComponentMgr = function(){ + var all = new Roo.util.MixedCollection(); + + return { + /** + * Registers a component. + * @param {Roo.Component} c The component + */ + register : function(c){ + all.add(c); + }, + + /** + * Unregisters a component. + * @param {Roo.Component} c The component + */ + unregister : function(c){ + all.remove(c); + }, + + /** + * Returns a component by id + * @param {String} id The component id + */ + get : function(id){ + return all.get(id); + }, + + /** + * Registers a function that will be called when a specified component is added to ComponentMgr + * @param {String} id The component id + * @param {Funtction} fn The callback function + * @param {Object} scope The scope of the callback + */ + onAvailable : function(id, fn, scope){ + all.on("add", function(index, o){ + if(o.id == id){ + fn.call(scope || o, o); + all.un("add", fn, scope); + } + }); + } + }; +}(); \ No newline at end of file diff --git a/docs2/src/Roo_CompositeElement.js.html b/docs2/src/Roo_CompositeElement.js.html new file mode 100644 index 0000000000..502ce72800 --- /dev/null +++ b/docs2/src/Roo_CompositeElement.js.html @@ -0,0 +1,242 @@ +/home/alan/gitlive/roojs1/Roo/CompositeElement.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.CompositeElement + * Standard composite class. Creates a Roo.Element for every element in the collection. + * <br><br> + * <b>NOTE: Although they are not listed, this class supports all of the set/update methods of Roo.Element. All Roo.Element + * actions will be performed on all the elements in this collection.</b> + * <br><br> + * All methods return <i>this</i> and can be chained. + <pre><code> + var els = Roo.select("#some-el div.some-class", true); + // or select directly from an existing element + var el = Roo.get('some-el'); + el.select('div.some-class', true); + + els.setWidth(100); // all elements become 100 width + els.hide(true); // all elements fade out and hide + // or + els.setWidth(100).hide(true); + </code></pre> + */ +Roo.CompositeElement = function(els){ + this.elements = []; + this.addElements(els); +}; +Roo.CompositeElement.prototype = { + isComposite: true, + addElements : function(els){ + if(!els) { + return this; + } + if(typeof els == "string"){ + els = Roo.Element.selectorFunction(els); + } + var yels = this.elements; + var index = yels.length-1; + for(var i = 0, len = els.length; i < len; i++) { + yels[++index] = Roo.get(els[i]); + } + return this; + }, + + /** + * Clears this composite and adds the elements returned by the passed selector. + * @param {String/Array} els A string CSS selector, an array of elements or an element + * @return {CompositeElement} this + */ + fill : function(els){ + this.elements = []; + this.add(els); + return this; + }, + + /** + * Filters this composite to only elements that match the passed selector. + * @param {String} selector A string CSS selector + * @param {Boolean} inverse return inverse filter (not matches) + * @return {CompositeElement} this + */ + filter : function(selector, inverse){ + var els = []; + inverse = inverse || false; + this.each(function(el){ + var match = inverse ? !el.is(selector) : el.is(selector); + if(match){ + els[els.length] = el.dom; + } + }); + this.fill(els); + return this; + }, + + invoke : function(fn, args){ + var els = this.elements; + for(var i = 0, len = els.length; i < len; i++) { + Roo.Element.prototype[fn].apply(els[i], args); + } + return this; + }, + /** + * Adds elements to this composite. + * @param {String/Array} els A string CSS selector, an array of elements or an element + * @return {CompositeElement} this + */ + add : function(els){ + if(typeof els == "string"){ + this.addElements(Roo.Element.selectorFunction(els)); + }else if(els.length !== undefined){ + this.addElements(els); + }else{ + this.addElements([els]); + } + return this; + }, + /** + * Calls the passed function passing (el, this, index) for each element in this composite. + * @param {Function} fn The function to call + * @param {Object} scope (optional) The <i>this</i> object (defaults to the element) + * @return {CompositeElement} this + */ + each : function(fn, scope){ + var els = this.elements; + for(var i = 0, len = els.length; i < len; i++){ + if(fn.call(scope || els[i], els[i], this, i) === false) { + break; + } + } + return this; + }, + + /** + * Returns the Element object at the specified index + * @param {Number} index + * @return {Roo.Element} + */ + item : function(index){ + return this.elements[index] || null; + }, + + /** + * Returns the first Element + * @return {Roo.Element} + */ + first : function(){ + return this.item(0); + }, + + /** + * Returns the last Element + * @return {Roo.Element} + */ + last : function(){ + return this.item(this.elements.length-1); + }, + + /** + * Returns the number of elements in this composite + * @return Number + */ + getCount : function(){ + return this.elements.length; + }, + + /** + * Returns true if this composite contains the passed element + * @return Boolean + */ + contains : function(el){ + return this.indexOf(el) !== -1; + }, + + /** + * Returns true if this composite contains the passed element + * @return Boolean + */ + indexOf : function(el){ + return this.elements.indexOf(Roo.get(el)); + }, + + + /** + * Removes the specified element(s). + * @param {Mixed} el The id of an element, the Element itself, the index of the element in this composite + * or an array of any of those. + * @param {Boolean} removeDom (optional) True to also remove the element from the document + * @return {CompositeElement} this + */ + removeElement : function(el, removeDom){ + if(el instanceof Array){ + for(var i = 0, len = el.length; i < len; i++){ + this.removeElement(el[i]); + } + return this; + } + var index = typeof el == 'number' ? el : this.indexOf(el); + if(index !== -1){ + if(removeDom){ + var d = this.elements[index]; + if(d.dom){ + d.remove(); + }else{ + d.parentNode.removeChild(d); + } + } + this.elements.splice(index, 1); + } + return this; + }, + + /** + * Replaces the specified element with the passed element. + * @param {String/HTMLElement/Element/Number} el The id of an element, the Element itself, the index of the element in this composite + * to replace. + * @param {String/HTMLElement/Element} replacement The id of an element or the Element itself. + * @param {Boolean} domReplace (Optional) True to remove and replace the element in the document too. + * @return {CompositeElement} this + */ + replaceElement : function(el, replacement, domReplace){ + var index = typeof el == 'number' ? el : this.indexOf(el); + if(index !== -1){ + if(domReplace){ + this.elements[index].replaceWith(replacement); + }else{ + this.elements.splice(index, 1, Roo.get(replacement)) + } + } + return this; + }, + + /** + * Removes all elements. + */ + clear : function(){ + this.elements = []; + } +}; +(function(){ + Roo.CompositeElement.createCall = function(proto, fnName){ + if(!proto[fnName]){ + proto[fnName] = function(){ + return this.invoke(fnName, arguments); + }; + } + }; + for(var fnName in Roo.Element.prototype){ + if(typeof Roo.Element.prototype[fnName] == "function"){ + Roo.CompositeElement.createCall(Roo.CompositeElement.prototype, fnName); + } + }; +})(); + \ No newline at end of file diff --git a/docs2/src/Roo_CompositeElementLite.js.html b/docs2/src/Roo_CompositeElementLite.js.html new file mode 100644 index 0000000000..37813ca1f5 --- /dev/null +++ b/docs2/src/Roo_CompositeElementLite.js.html @@ -0,0 +1,120 @@ +/home/alan/gitlive/roojs1/Roo/CompositeElementLite.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.CompositeElementLite + * @extends Roo.CompositeElement + * Flyweight composite class. Reuses the same Roo.Element for element operations. + <pre><code> + var els = Roo.select("#some-el div.some-class"); + // or select directly from an existing element + var el = Roo.get('some-el'); + el.select('div.some-class'); + + els.setWidth(100); // all elements become 100 width + els.hide(true); // all elements fade out and hide + // or + els.setWidth(100).hide(true); + </code></pre><br><br> + * <b>NOTE: Although they are not listed, this class supports all of the set/update methods of Roo.Element. All Roo.Element + * actions will be performed on all the elements in this collection.</b> + */ +Roo.CompositeElementLite = function(els){ + Roo.CompositeElementLite.superclass.constructor.call(this, els); + this.el = new Roo.Element.Flyweight(); +}; +Roo.extend(Roo.CompositeElementLite, Roo.CompositeElement, { + addElements : function(els){ + if(els){ + if(els instanceof Array){ + this.elements = this.elements.concat(els); + }else{ + var yels = this.elements; + var index = yels.length-1; + for(var i = 0, len = els.length; i < len; i++) { + yels[++index] = els[i]; + } + } + } + return this; + }, + invoke : function(fn, args){ + var els = this.elements; + var el = this.el; + for(var i = 0, len = els.length; i < len; i++) { + el.dom = els[i]; + Roo.Element.prototype[fn].apply(el, args); + } + return this; + }, + /** + * Returns a flyweight Element of the dom element object at the specified index + * @param {Number} index + * @return {Roo.Element} + */ + item : function(index){ + if(!this.elements[index]){ + return null; + } + this.el.dom = this.elements[index]; + return this.el; + }, + + // fixes scope with flyweight + addListener : function(eventName, handler, scope, opt){ + var els = this.elements; + for(var i = 0, len = els.length; i < len; i++) { + Roo.EventManager.on(els[i], eventName, handler, scope || els[i], opt); + } + return this; + }, + + /** + * Calls the passed function passing (el, this, index) for each element in this composite. <b>The element + * passed is the flyweight (shared) Roo.Element instance, so if you require a + * a reference to the dom node, use el.dom.</b> + * @param {Function} fn The function to call + * @param {Object} scope (optional) The <i>this</i> object (defaults to the element) + * @return {CompositeElement} this + */ + each : function(fn, scope){ + var els = this.elements; + var el = this.el; + for(var i = 0, len = els.length; i < len; i++){ + el.dom = els[i]; + if(fn.call(scope || el, el, this, i) === false){ + break; + } + } + return this; + }, + + indexOf : function(el){ + return this.elements.indexOf(Roo.getDom(el)); + }, + + replaceElement : function(el, replacement, domReplace){ + var index = typeof el == 'number' ? el : this.indexOf(el); + if(index !== -1){ + replacement = Roo.getDom(replacement); + if(domReplace){ + var d = this.elements[index]; + d.parentNode.insertBefore(replacement, d); + d.parentNode.removeChild(d); + } + this.elements.splice(index, 1, replacement); + } + return this; + } +}); +Roo.CompositeElementLite.prototype.on = Roo.CompositeElementLite.prototype.addListener; + + \ No newline at end of file diff --git a/docs2/src/Roo_ContentPanel.js.html b/docs2/src/Roo_ContentPanel.js.html new file mode 100644 index 0000000000..9eb1276894 --- /dev/null +++ b/docs2/src/Roo_ContentPanel.js.html @@ -0,0 +1,789 @@ +/home/alan/gitlive/roojs1/Roo/ContentPanel.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.ContentPanel + * @extends Roo.util.Observable + * A basic ContentPanel element. + * @cfg {Boolean} fitToFrame True for this panel to adjust its size to fit when the region resizes (defaults to false) + * @cfg {Boolean} fitContainer When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false) + * @cfg {Boolean/Object} autoCreate True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create + * @cfg {Boolean} closable True if the panel can be closed/removed + * @cfg {Boolean} background True if the panel should not be activated when it is added (defaults to false) + * @cfg {String/HTMLElement/Element} resizeEl An element to resize if {@link #fitToFrame} is true (instead of this panel's element) + * @cfg {Toolbar} toolbar A toolbar for this panel + * @cfg {Boolean} autoScroll True to scroll overflow in this panel (use with {@link #fitToFrame}) + * @cfg {String} title The title for this panel + * @cfg {Array} adjustments Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0]) + * @cfg {String} url Calls {@link #setUrl} with this value + * @cfg {String} region (center|north|south|east|west) which region to put this panel on (when used with xtype constructors) + * @cfg {String/Object} params When used with {@link #url}, calls {@link #setUrl} with this value + * @cfg {Boolean} loadOnce When used with {@link #url}, calls {@link #setUrl} with this value + * @cfg {String} content Raw content to fill content panel with (uses setContent on construction.) + + * @constructor + * Create a new ContentPanel. + * @param {String/HTMLElement/Roo.Element} el The container element for this panel + * @param {String/Object} config A string to set only the title or a config object + * @param {String} content (optional) Set the HTML content for this panel + * @param {String} region (optional) Used by xtype constructors to add to regions. (values center,east,west,south,north) + */ +Roo.ContentPanel = function(el, config, content){ + + + /* + if(el.autoCreate || el.xtype){ // xtype is available if this is called from factory + config = el; + el = Roo.id(); + } + if (config && config.parentLayout) { + el = config.parentLayout.el.createChild(); + } + */ + if(el.autoCreate){ // xtype is available if this is called from factory + config = el; + el = Roo.id(); + } + this.el = Roo.get(el); + if(!this.el && config && config.autoCreate){ + if(typeof config.autoCreate == "object"){ + if(!config.autoCreate.id){ + config.autoCreate.id = config.id||el; + } + this.el = Roo.DomHelper.append(document.body, + config.autoCreate, true); + }else{ + this.el = Roo.DomHelper.append(document.body, + {tag: "div", cls: "x-layout-inactive-content", id: config.id||el}, true); + } + } + this.closable = false; + this.loaded = false; + this.active = false; + if(typeof config == "string"){ + this.title = config; + }else{ + Roo.apply(this, config); + } + + if (this.toolbar && !this.toolbar.el && this.toolbar.xtype) { + this.wrapEl = this.el.wrap(); + this.toolbar.container = this.el.insertSibling(false, 'before'); + this.toolbar = new Roo.Toolbar(this.toolbar); + } + + // xtype created footer. - not sure if will work as we normally have to render first.. + if (this.footer && !this.footer.el && this.footer.xtype) { + if (!this.wrapEl) { + this.wrapEl = this.el.wrap(); + } + + this.footer.container = this.wrapEl.createChild(); + + this.footer = Roo.factory(this.footer, Roo); + + } + + if(this.resizeEl){ + this.resizeEl = Roo.get(this.resizeEl, true); + }else{ + this.resizeEl = this.el; + } + // handle view.xtype + + + + + this.addEvents({ + /** + * @event activate + * Fires when this panel is activated. + * @param {Roo.ContentPanel} this + */ + "activate" : true, + /** + * @event deactivate + * Fires when this panel is activated. + * @param {Roo.ContentPanel} this + */ + "deactivate" : true, + + /** + * @event resize + * Fires when this panel is resized if fitToFrame is true. + * @param {Roo.ContentPanel} this + * @param {Number} width The width after any component adjustments + * @param {Number} height The height after any component adjustments + */ + "resize" : true, + + /** + * @event render + * Fires when this tab is created + * @param {Roo.ContentPanel} this + */ + "render" : true + + + + }); + + + + + if(this.autoScroll){ + this.resizeEl.setStyle("overflow", "auto"); + } else { + // fix randome scrolling + this.el.on('scroll', function() { + Roo.log('fix random scolling'); + this.scrollTo('top',0); + }); + } + content = content || this.content; + if(content){ + this.setContent(content); + } + if(config && config.url){ + this.setUrl(this.url, this.params, this.loadOnce); + } + + + + Roo.ContentPanel.superclass.constructor.call(this); + + if (this.view && typeof(this.view.xtype) != 'undefined') { + this.view.el = this.el.appendChild(document.createElement("div")); + this.view = Roo.factory(this.view); + this.view.render && this.view.render(false, ''); + } + + + this.fireEvent('render', this); +}; + +Roo.extend(Roo.ContentPanel, Roo.util.Observable, { + tabTip:'', + setRegion : function(region){ + this.region = region; + if(region){ + this.el.replaceClass("x-layout-inactive-content", "x-layout-active-content"); + }else{ + this.el.replaceClass("x-layout-active-content", "x-layout-inactive-content"); + } + }, + + /** + * Returns the toolbar for this Panel if one was configured. + * @return {Roo.Toolbar} + */ + getToolbar : function(){ + return this.toolbar; + }, + + setActiveState : function(active){ + this.active = active; + if(!active){ + this.fireEvent("deactivate", this); + }else{ + this.fireEvent("activate", this); + } + }, + /** + * Updates this panel's element + * @param {String} content The new content + * @param {Boolean} loadScripts (optional) true to look for and process scripts + */ + setContent : function(content, loadScripts){ + this.el.update(content, loadScripts); + }, + + ignoreResize : function(w, h){ + if(this.lastSize && this.lastSize.width == w && this.lastSize.height == h){ + return true; + }else{ + this.lastSize = {width: w, height: h}; + return false; + } + }, + /** + * Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates. + * @return {Roo.UpdateManager} The UpdateManager + */ + getUpdateManager : function(){ + return this.el.getUpdateManager(); + }, + /** + * Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}. + * @param {Object/String/Function} url The url for this request or a function to call to get the url or a config object containing any of the following options: +<pre><code> +panel.load({ + url: "your-url.php", + params: {param1: "foo", param2: "bar"}, // or a URL encoded string + callback: yourFunction, + scope: yourObject, //(optional scope) + discardUrl: false, + nocache: false, + text: "Loading...", + timeout: 30, + scripts: false +}); +</code></pre> + * The only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i> + * are shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance. + * @param {String/Object} params (optional) The parameters to pass as either a URL encoded string "param1=1&amp;param2=2" or an object {param1: 1, param2: 2} + * @param {Function} callback (optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse) + * @param {Boolean} discardUrl (optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL. + * @return {Roo.ContentPanel} this + */ + load : function(){ + var um = this.el.getUpdateManager(); + um.update.apply(um, arguments); + return this; + }, + + + /** + * Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL. + * @param {String/Function} url The URL to load the content from or a function to call to get the URL + * @param {String/Object} params (optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null) + * @param {Boolean} loadOnce (optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false) + * @return {Roo.UpdateManager} The UpdateManager + */ + setUrl : function(url, params, loadOnce){ + if(this.refreshDelegate){ + this.removeListener("activate", this.refreshDelegate); + } + this.refreshDelegate = this._handleRefresh.createDelegate(this, [url, params, loadOnce]); + this.on("activate", this.refreshDelegate); + return this.el.getUpdateManager(); + }, + + _handleRefresh : function(url, params, loadOnce){ + if(!loadOnce || !this.loaded){ + var updater = this.el.getUpdateManager(); + updater.update(url, params, this._setLoaded.createDelegate(this)); + } + }, + + _setLoaded : function(){ + this.loaded = true; + }, + + /** + * Returns this panel's id + * @return {String} + */ + getId : function(){ + return this.el.id; + }, + + /** + * Returns this panel's element - used by regiosn to add. + * @return {Roo.Element} + */ + getEl : function(){ + return this.wrapEl || this.el; + }, + + adjustForComponents : function(width, height) + { + //Roo.log('adjustForComponents '); + if(this.resizeEl != this.el){ + width -= this.el.getFrameWidth('lr'); + height -= this.el.getFrameWidth('tb'); + } + if(this.toolbar){ + var te = this.toolbar.getEl(); + height -= te.getHeight(); + te.setWidth(width); + } + if(this.footer){ + var te = this.footer.getEl(); + Roo.log("footer:" + te.getHeight()); + + height -= te.getHeight(); + te.setWidth(width); + } + + + if(this.adjustments){ + width += this.adjustments[0]; + height += this.adjustments[1]; + } + return {"width": width, "height": height}; + }, + + setSize : function(width, height){ + if(this.fitToFrame && !this.ignoreResize(width, height)){ + if(this.fitContainer && this.resizeEl != this.el){ + this.el.setSize(width, height); + } + var size = this.adjustForComponents(width, height); + this.resizeEl.setSize(this.autoWidth ? "auto" : size.width, this.autoHeight ? "auto" : size.height); + this.fireEvent('resize', this, size.width, size.height); + } + }, + + /** + * Returns this panel's title + * @return {String} + */ + getTitle : function(){ + return this.title; + }, + + /** + * Set this panel's title + * @param {String} title + */ + setTitle : function(title){ + this.title = title; + if(this.region){ + this.region.updatePanelTitle(this, title); + } + }, + + /** + * Returns true is this panel was configured to be closable + * @return {Boolean} + */ + isClosable : function(){ + return this.closable; + }, + + beforeSlide : function(){ + this.el.clip(); + this.resizeEl.clip(); + }, + + afterSlide : function(){ + this.el.unclip(); + this.resizeEl.unclip(); + }, + + /** + * Force a content refresh from the URL specified in the {@link #setUrl} method. + * Will fail silently if the {@link #setUrl} method has not been called. + * This does not activate the panel, just updates its content. + */ + refresh : function(){ + if(this.refreshDelegate){ + this.loaded = false; + this.refreshDelegate(); + } + }, + + /** + * Destroys this panel + */ + destroy : function(){ + this.el.removeAllListeners(); + var tempEl = document.createElement("span"); + tempEl.appendChild(this.el.dom); + tempEl.innerHTML = ""; + this.el.remove(); + this.el = null; + }, + + /** + * form - if the content panel contains a form - this is a reference to it. + * @type {Roo.form.Form} + */ + form : false, + /** + * view - if the content panel contains a view (Roo.DatePicker / Roo.View / Roo.JsonView) + * This contains a reference to it. + * @type {Roo.View} + */ + view : false, + + /** + * Adds a xtype elements to the panel - currently only supports Forms, View, JsonView. + * <pre><code> + +layout.addxtype({ + xtype : 'Form', + items: [ .... ] + } +); + +</code></pre> + * @param {Object} cfg Xtype definition of item to add. + */ + + addxtype : function(cfg) { + // add form.. + if (cfg.xtype.match(/^Form$/)) { + + var el; + //if (this.footer) { + // el = this.footer.container.insertSibling(false, 'before'); + //} else { + el = this.el.createChild(); + //} + + this.form = new Roo.form.Form(cfg); + + + if ( this.form.allItems.length) { + this.form.render(el.dom); + } + return this.form; + } + // should only have one of theses.. + if ([ 'View', 'JsonView', 'DatePicker'].indexOf(cfg.xtype) > -1) { + // views.. should not be just added - used named prop 'view'' + + cfg.el = this.el.appendChild(document.createElement("div")); + // factory? + + var ret = new Roo.factory(cfg); + + ret.render && ret.render(false, ''); // render blank.. + this.view = ret; + return ret; + } + return false; + } +}); + +/** + * @class Roo.GridPanel + * @extends Roo.ContentPanel + * @constructor + * Create a new GridPanel. + * @param {Roo.grid.Grid} grid The grid for this panel + * @param {String/Object} config A string to set only the panel's title, or a config object + */ +Roo.GridPanel = function(grid, config){ + + + this.wrapper = Roo.DomHelper.append(document.body, // wrapper for IE7 strict & safari scroll issue + {tag: "div", cls: "x-layout-grid-wrapper x-layout-inactive-content"}, true); + + this.wrapper.dom.appendChild(grid.getGridEl().dom); + + Roo.GridPanel.superclass.constructor.call(this, this.wrapper, config); + + if(this.toolbar){ + this.toolbar.el.insertBefore(this.wrapper.dom.firstChild); + } + // xtype created footer. - not sure if will work as we normally have to render first.. + if (this.footer && !this.footer.el && this.footer.xtype) { + + this.footer.container = this.grid.getView().getFooterPanel(true); + this.footer.dataSource = this.grid.dataSource; + this.footer = Roo.factory(this.footer, Roo); + + } + + grid.monitorWindowResize = false; // turn off autosizing + grid.autoHeight = false; + grid.autoWidth = false; + this.grid = grid; + this.grid.getGridEl().replaceClass("x-layout-inactive-content", "x-layout-component-panel"); +}; + +Roo.extend(Roo.GridPanel, Roo.ContentPanel, { + getId : function(){ + return this.grid.id; + }, + + /** + * Returns the grid for this panel + * @return {Roo.grid.Grid} + */ + getGrid : function(){ + return this.grid; + }, + + setSize : function(width, height){ + if(!this.ignoreResize(width, height)){ + var grid = this.grid; + var size = this.adjustForComponents(width, height); + grid.getGridEl().setSize(size.width, size.height); + grid.autoSize(); + } + }, + + beforeSlide : function(){ + this.grid.getView().scroller.clip(); + }, + + afterSlide : function(){ + this.grid.getView().scroller.unclip(); + }, + + destroy : function(){ + this.grid.destroy(); + delete this.grid; + Roo.GridPanel.superclass.destroy.call(this); + } +}); + + +/** + * @class Roo.NestedLayoutPanel + * @extends Roo.ContentPanel + * @constructor + * Create a new NestedLayoutPanel. + * + * + * @param {Roo.BorderLayout} layout The layout for this panel + * @param {String/Object} config A string to set only the title or a config object + */ +Roo.NestedLayoutPanel = function(layout, config) +{ + // construct with only one argument.. + /* FIXME - implement nicer consturctors + if (layout.layout) { + config = layout; + layout = config.layout; + delete config.layout; + } + if (layout.xtype && !layout.getEl) { + // then layout needs constructing.. + layout = Roo.factory(layout, Roo); + } + */ + + + Roo.NestedLayoutPanel.superclass.constructor.call(this, layout.getEl(), config); + + layout.monitorWindowResize = false; // turn off autosizing + this.layout = layout; + this.layout.getEl().addClass("x-layout-nested-layout"); + + + + +}; + +Roo.extend(Roo.NestedLayoutPanel, Roo.ContentPanel, { + + setSize : function(width, height){ + if(!this.ignoreResize(width, height)){ + var size = this.adjustForComponents(width, height); + var el = this.layout.getEl(); + el.setSize(size.width, size.height); + var touch = el.dom.offsetWidth; + this.layout.layout(); + // ie requires a double layout on the first pass + if(Roo.isIE && !this.initialized){ + this.initialized = true; + this.layout.layout(); + } + } + }, + + // activate all subpanels if not currently active.. + + setActiveState : function(active){ + this.active = active; + if(!active){ + this.fireEvent("deactivate", this); + return; + } + + this.fireEvent("activate", this); + // not sure if this should happen before or after.. + if (!this.layout) { + return; // should not happen.. + } + var reg = false; + for (var r in this.layout.regions) { + reg = this.layout.getRegion(r); + if (reg.getActivePanel()) { + //reg.showPanel(reg.getActivePanel()); // force it to activate.. + reg.setActivePanel(reg.getActivePanel()); + continue; + } + if (!reg.panels.length) { + continue; + } + reg.showPanel(reg.getPanel(0)); + } + + + + + }, + + /** + * Returns the nested BorderLayout for this panel + * @return {Roo.BorderLayout} + */ + getLayout : function(){ + return this.layout; + }, + + /** + * Adds a xtype elements to the layout of the nested panel + * <pre><code> + +panel.addxtype({ + xtype : 'ContentPanel', + region: 'west', + items: [ .... ] + } +); + +panel.addxtype({ + xtype : 'NestedLayoutPanel', + region: 'west', + layout: { + center: { }, + west: { } + }, + items : [ ... list of content panels or nested layout panels.. ] + } +); +</code></pre> + * @param {Object} cfg Xtype definition of item to add. + */ + addxtype : function(cfg) { + return this.layout.addxtype(cfg); + + } +}); + +Roo.ScrollPanel = function(el, config, content){ + config = config || {}; + config.fitToFrame = true; + Roo.ScrollPanel.superclass.constructor.call(this, el, config, content); + + this.el.dom.style.overflow = "hidden"; + var wrap = this.el.wrap({cls: "x-scroller x-layout-inactive-content"}); + this.el.removeClass("x-layout-inactive-content"); + this.el.on("mousewheel", this.onWheel, this); + + var up = wrap.createChild({cls: "x-scroller-up", html: "&#160;"}, this.el.dom); + var down = wrap.createChild({cls: "x-scroller-down", html: "&#160;"}); + up.unselectable(); down.unselectable(); + up.on("click", this.scrollUp, this); + down.on("click", this.scrollDown, this); + up.addClassOnOver("x-scroller-btn-over"); + down.addClassOnOver("x-scroller-btn-over"); + up.addClassOnClick("x-scroller-btn-click"); + down.addClassOnClick("x-scroller-btn-click"); + this.adjustments = [0, -(up.getHeight() + down.getHeight())]; + + this.resizeEl = this.el; + this.el = wrap; this.up = up; this.down = down; +}; + +Roo.extend(Roo.ScrollPanel, Roo.ContentPanel, { + increment : 100, + wheelIncrement : 5, + scrollUp : function(){ + this.resizeEl.scroll("up", this.increment, {callback: this.afterScroll, scope: this}); + }, + + scrollDown : function(){ + this.resizeEl.scroll("down", this.increment, {callback: this.afterScroll, scope: this}); + }, + + afterScroll : function(){ + var el = this.resizeEl; + var t = el.dom.scrollTop, h = el.dom.scrollHeight, ch = el.dom.clientHeight; + this.up[t == 0 ? "addClass" : "removeClass"]("x-scroller-btn-disabled"); + this.down[h - t <= ch ? "addClass" : "removeClass"]("x-scroller-btn-disabled"); + }, + + setSize : function(){ + Roo.ScrollPanel.superclass.setSize.apply(this, arguments); + this.afterScroll(); + }, + + onWheel : function(e){ + var d = e.getWheelDelta(); + this.resizeEl.dom.scrollTop -= (d*this.wheelIncrement); + this.afterScroll(); + e.stopEvent(); + }, + + setContent : function(content, loadScripts){ + this.resizeEl.update(content, loadScripts); + } + +}); + + + + + + + + + +/** + * @class Roo.TreePanel + * @extends Roo.ContentPanel + * @constructor + * Create a new TreePanel. - defaults to fit/scoll contents. + * @param {String/Object} config A string to set only the panel's title, or a config object + * @cfg {Roo.tree.TreePanel} tree The tree TreePanel, with config etc. + */ +Roo.TreePanel = function(config){ + var el = config.el; + var tree = config.tree; + delete config.tree; + delete config.el; // hopefull! + + // wrapper for IE7 strict & safari scroll issue + + var treeEl = el.createChild(); + config.resizeEl = treeEl; + + + + Roo.TreePanel.superclass.constructor.call(this, el, config); + + + this.tree = new Roo.tree.TreePanel(treeEl , tree); + //console.log(tree); + this.on('activate', function() + { + if (this.tree.rendered) { + return; + } + //console.log('render tree'); + this.tree.render(); + }); + // this should not be needed.. - it's actually the 'el' that resizes? + // actuall it breaks the containerScroll - dragging nodes auto scroll at top + + //this.on('resize', function (cp, w, h) { + // this.tree.innerCt.setWidth(w); + // this.tree.innerCt.setHeight(h); + // //this.tree.innerCt.setStyle('overflow-y', 'auto'); + //}); + + + +}; + +Roo.extend(Roo.TreePanel, Roo.ContentPanel, { + fitToFrame : true, + autoScroll : true +}); + + + + + + + + + + + + \ No newline at end of file diff --git a/docs2/src/Roo_DDView.js.html b/docs2/src/Roo_DDView.js.html new file mode 100644 index 0000000000..8776c44dd3 --- /dev/null +++ b/docs2/src/Roo_DDView.js.html @@ -0,0 +1,418 @@ +/home/alan/gitlive/roojs1/Roo/DDView.js//<script type="text/javasscript"> + + +/** + * @class Roo.DDView + * A DnD enabled version of Roo.View. + * @param {Element/String} container The Element in which to create the View. + * @param {String} tpl The template string used to create the markup for each element of the View + * @param {Object} config The configuration properties. These include all the config options of + * {@link Roo.View} plus some specific to this class.<br> + * <p> + * Drag/drop is implemented by adding {@link Roo.data.Record}s to the target DDView. If copying is + * not being performed, the original {@link Roo.data.Record} is removed from the source DDView.<br> + * <p> + * The following extra CSS rules are needed to provide insertion point highlighting:<pre><code> +.x-view-drag-insert-above { + border-top:1px dotted #3366cc; +} +.x-view-drag-insert-below { + border-bottom:1px dotted #3366cc; +} +</code></pre> + * + */ + +Roo.DDView = function(container, tpl, config) { + Roo.DDView.superclass.constructor.apply(this, arguments); + this.getEl().setStyle("outline", "0px none"); + this.getEl().unselectable(); + if (this.dragGroup) { + this.setDraggable(this.dragGroup.split(",")); + } + if (this.dropGroup) { + this.setDroppable(this.dropGroup.split(",")); + } + if (this.deletable) { + this.setDeletable(); + } + this.isDirtyFlag = false; + this.addEvents({ + "drop" : true + }); +}; + +Roo.extend(Roo.DDView, Roo.View, { +/** @cfg {String/Array} dragGroup The ddgroup name(s) for the View's DragZone. */ +/** @cfg {String/Array} dropGroup The ddgroup name(s) for the View's DropZone. */ +/** @cfg {Boolean} copy Causes drag operations to copy nodes rather than move. */ +/** @cfg {Boolean} allowCopy Causes ctrl/drag operations to copy nodes rather than move. */ + + isFormField: true, + + reset: Roo.emptyFn, + + clearInvalid: Roo.form.Field.prototype.clearInvalid, + + validate: function() { + return true; + }, + + destroy: function() { + this.purgeListeners(); + this.getEl.removeAllListeners(); + this.getEl().remove(); + if (this.dragZone) { + if (this.dragZone.destroy) { + this.dragZone.destroy(); + } + } + if (this.dropZone) { + if (this.dropZone.destroy) { + this.dropZone.destroy(); + } + } + }, + +/** Allows this class to be an Roo.form.Field so it can be found using {@link Roo.form.BasicForm#findField}. */ + getName: function() { + return this.name; + }, + +/** Loads the View from a JSON string representing the Records to put into the Store. */ + setValue: function(v) { + if (!this.store) { + throw "DDView.setValue(). DDView must be constructed with a valid Store"; + } + var data = {}; + data[this.store.reader.meta.root] = v ? [].concat(v) : []; + this.store.proxy = new Roo.data.MemoryProxy(data); + this.store.load(); + }, + +/** @return {String} a parenthesised list of the ids of the Records in the View. */ + getValue: function() { + var result = '('; + this.store.each(function(rec) { + result += rec.id + ','; + }); + return result.substr(0, result.length - 1) + ')'; + }, + + getIds: function() { + var i = 0, result = new Array(this.store.getCount()); + this.store.each(function(rec) { + result[i++] = rec.id; + }); + return result; + }, + + isDirty: function() { + return this.isDirtyFlag; + }, + +/** + * Part of the Roo.dd.DropZone interface. If no target node is found, the + * whole Element becomes the target, and this causes the drop gesture to append. + */ + getTargetFromEvent : function(e) { + var target = e.getTarget(); + while ((target !== null) && (target.parentNode != this.el.dom)) { + target = target.parentNode; + } + if (!target) { + target = this.el.dom.lastChild || this.el.dom; + } + return target; + }, + +/** + * Create the drag data which consists of an object which has the property "ddel" as + * the drag proxy element. + */ + getDragData : function(e) { + var target = this.findItemFromChild(e.getTarget()); + if(target) { + this.handleSelection(e); + var selNodes = this.getSelectedNodes(); + var dragData = { + source: this, + copy: this.copy || (this.allowCopy && e.ctrlKey), + nodes: selNodes, + records: [] + }; + var selectedIndices = this.getSelectedIndexes(); + for (var i = 0; i < selectedIndices.length; i++) { + dragData.records.push(this.store.getAt(selectedIndices[i])); + } + if (selNodes.length == 1) { + dragData.ddel = target.cloneNode(true); // the div element + } else { + var div = document.createElement('div'); // create the multi element drag "ghost" + div.className = 'multi-proxy'; + for (var i = 0, len = selNodes.length; i < len; i++) { + div.appendChild(selNodes[i].cloneNode(true)); + } + dragData.ddel = div; + } + //console.log(dragData) + //console.log(dragData.ddel.innerHTML) + return dragData; + } + //console.log('nodragData') + return false; + }, + +/** Specify to which ddGroup items in this DDView may be dragged. */ + setDraggable: function(ddGroup) { + if (ddGroup instanceof Array) { + Roo.each(ddGroup, this.setDraggable, this); + return; + } + if (this.dragZone) { + this.dragZone.addToGroup(ddGroup); + } else { + this.dragZone = new Roo.dd.DragZone(this.getEl(), { + containerScroll: true, + ddGroup: ddGroup + + }); +// Draggability implies selection. DragZone's mousedown selects the element. + if (!this.multiSelect) { this.singleSelect = true; } + +// Wire the DragZone's handlers up to methods in *this* + this.dragZone.getDragData = this.getDragData.createDelegate(this); + } + }, + +/** Specify from which ddGroup this DDView accepts drops. */ + setDroppable: function(ddGroup) { + if (ddGroup instanceof Array) { + Roo.each(ddGroup, this.setDroppable, this); + return; + } + if (this.dropZone) { + this.dropZone.addToGroup(ddGroup); + } else { + this.dropZone = new Roo.dd.DropZone(this.getEl(), { + containerScroll: true, + ddGroup: ddGroup + }); + +// Wire the DropZone's handlers up to methods in *this* + this.dropZone.getTargetFromEvent = this.getTargetFromEvent.createDelegate(this); + this.dropZone.onNodeEnter = this.onNodeEnter.createDelegate(this); + this.dropZone.onNodeOver = this.onNodeOver.createDelegate(this); + this.dropZone.onNodeOut = this.onNodeOut.createDelegate(this); + this.dropZone.onNodeDrop = this.onNodeDrop.createDelegate(this); + } + }, + +/** Decide whether to drop above or below a View node. */ + getDropPoint : function(e, n, dd){ + if (n == this.el.dom) { return "above"; } + var t = Roo.lib.Dom.getY(n), b = t + n.offsetHeight; + var c = t + (b - t) / 2; + var y = Roo.lib.Event.getPageY(e); + if(y <= c) { + return "above"; + }else{ + return "below"; + } + }, + + onNodeEnter : function(n, dd, e, data){ + return false; + }, + + onNodeOver : function(n, dd, e, data){ + var pt = this.getDropPoint(e, n, dd); + // set the insert point style on the target node + var dragElClass = this.dropNotAllowed; + if (pt) { + var targetElClass; + if (pt == "above"){ + dragElClass = n.previousSibling ? "x-tree-drop-ok-between" : "x-tree-drop-ok-above"; + targetElClass = "x-view-drag-insert-above"; + } else { + dragElClass = n.nextSibling ? "x-tree-drop-ok-between" : "x-tree-drop-ok-below"; + targetElClass = "x-view-drag-insert-below"; + } + if (this.lastInsertClass != targetElClass){ + Roo.fly(n).replaceClass(this.lastInsertClass, targetElClass); + this.lastInsertClass = targetElClass; + } + } + return dragElClass; + }, + + onNodeOut : function(n, dd, e, data){ + this.removeDropIndicators(n); + }, + + onNodeDrop : function(n, dd, e, data){ + if (this.fireEvent("drop", this, n, dd, e, data) === false) { + return false; + } + var pt = this.getDropPoint(e, n, dd); + var insertAt = (n == this.el.dom) ? this.nodes.length : n.nodeIndex; + if (pt == "below") { insertAt++; } + for (var i = 0; i < data.records.length; i++) { + var r = data.records[i]; + var dup = this.store.getById(r.id); + if (dup && (dd != this.dragZone)) { + Roo.fly(this.getNode(this.store.indexOf(dup))).frame("red", 1); + } else { + if (data.copy) { + this.store.insert(insertAt++, r.copy()); + } else { + data.source.isDirtyFlag = true; + r.store.remove(r); + this.store.insert(insertAt++, r); + } + this.isDirtyFlag = true; + } + } + this.dragZone.cachedTarget = null; + return true; + }, + + removeDropIndicators : function(n){ + if(n){ + Roo.fly(n).removeClass([ + "x-view-drag-insert-above", + "x-view-drag-insert-below"]); + this.lastInsertClass = "_noclass"; + } + }, + +/** + * Utility method. Add a delete option to the DDView's context menu. + * @param {String} imageUrl The URL of the "delete" icon image. + */ + setDeletable: function(imageUrl) { + if (!this.singleSelect && !this.multiSelect) { + this.singleSelect = true; + } + var c = this.getContextMenu(); + this.contextMenu.on("itemclick", function(item) { + switch (item.id) { + case "delete": + this.remove(this.getSelectedIndexes()); + break; + } + }, this); + this.contextMenu.add({ + icon: imageUrl, + id: "delete", + text: 'Delete' + }); + }, + +/** Return the context menu for this DDView. */ + getContextMenu: function() { + if (!this.contextMenu) { +// Create the View's context menu + this.contextMenu = new Roo.menu.Menu({ + id: this.id + "-contextmenu" + }); + this.el.on("contextmenu", this.showContextMenu, this); + } + return this.contextMenu; + }, + + disableContextMenu: function() { + if (this.contextMenu) { + this.el.un("contextmenu", this.showContextMenu, this); + } + }, + + showContextMenu: function(e, item) { + item = this.findItemFromChild(e.getTarget()); + if (item) { + e.stopEvent(); + this.select(this.getNode(item), this.multiSelect && e.ctrlKey, true); + this.contextMenu.showAt(e.getXY()); + } + }, + +/** + * Remove {@link Roo.data.Record}s at the specified indices. + * @param {Array/Number} selectedIndices The index (or Array of indices) of Records to remove. + */ + remove: function(selectedIndices) { + selectedIndices = [].concat(selectedIndices); + for (var i = 0; i < selectedIndices.length; i++) { + var rec = this.store.getAt(selectedIndices[i]); + this.store.remove(rec); + } + }, + +/** + * Double click fires the event, but also, if this is draggable, and there is only one other + * related DropZone, it transfers the selected node. + */ + onDblClick : function(e){ + var item = this.findItemFromChild(e.getTarget()); + if(item){ + if (this.fireEvent("dblclick", this, this.indexOf(item), item, e) === false) { + return false; + } + if (this.dragGroup) { + var targets = Roo.dd.DragDropMgr.getRelated(this.dragZone, true); + while (targets.indexOf(this.dropZone) > -1) { + targets.remove(this.dropZone); + } + if (targets.length == 1) { + this.dragZone.cachedTarget = null; + var el = Roo.get(targets[0].getEl()); + var box = el.getBox(true); + targets[0].onNodeDrop(el.dom, { + target: el.dom, + xy: [box.x, box.y + box.height - 1] + }, null, this.getDragData(e)); + } + } + } + }, + + handleSelection: function(e) { + this.dragZone.cachedTarget = null; + var item = this.findItemFromChild(e.getTarget()); + if (!item) { + this.clearSelections(true); + return; + } + if (item && (this.multiSelect || this.singleSelect)){ + if(this.multiSelect && e.shiftKey && (!e.ctrlKey) && this.lastSelection){ + this.select(this.getNodes(this.indexOf(this.lastSelection), item.nodeIndex), false); + }else if (this.isSelected(this.getNode(item)) && e.ctrlKey){ + this.unselect(item); + } else { + this.select(item, this.multiSelect && e.ctrlKey); + this.lastSelection = item; + } + } + }, + + onItemClick : function(item, index, e){ + if(this.fireEvent("beforeclick", this, index, item, e) === false){ + return false; + } + return true; + }, + + unselect : function(nodeInfo, suppressEvent){ + var node = this.getNode(nodeInfo); + if(node && this.isSelected(node)){ + if(this.fireEvent("beforeselect", this, node, this.selections) !== false){ + Roo.fly(node).removeClass(this.selectedClass); + this.selections.remove(node); + if(!suppressEvent){ + this.fireEvent("selectionchange", this, this.selections); + } + } + } + } +}); + \ No newline at end of file diff --git a/docs2/src/Roo_DatePicker.js.html b/docs2/src/Roo_DatePicker.js.html new file mode 100644 index 0000000000..6f51ec9b36 --- /dev/null +++ b/docs2/src/Roo_DatePicker.js.html @@ -0,0 +1,665 @@ +/home/alan/gitlive/roojs1/Roo/DatePicker.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.DatePicker + * @extends Roo.Component + * Simple date picker class. + * @constructor + * Create a new DatePicker + * @param {Object} config The config object + */ +Roo.DatePicker = function(config){ + Roo.DatePicker.superclass.constructor.call(this, config); + + this.value = config && config.value ? + config.value.clearTime() : new Date().clearTime(); + + this.addEvents({ + /** + * @event select + * Fires when a date is selected + * @param {DatePicker} this + * @param {Date} date The selected date + */ + 'select': true, + /** + * @event monthchange + * Fires when the displayed month changes + * @param {DatePicker} this + * @param {Date} date The selected month + */ + 'monthchange': true + }); + + if(this.handler){ + this.on("select", this.handler, this.scope || this); + } + // build the disabledDatesRE + if(!this.disabledDatesRE && this.disabledDates){ + var dd = this.disabledDates; + var re = "(?:"; + for(var i = 0; i < dd.length; i++){ + re += dd[i]; + if(i != dd.length-1) { + re += "|"; + } + } + this.disabledDatesRE = new RegExp(re + ")"); + } +}; + +Roo.extend(Roo.DatePicker, Roo.Component, { + /** + * @cfg {String} todayText + * The text to display on the button that selects the current date (defaults to "Today") + */ + todayText : "Today", + /** + * @cfg {String} okText + * The text to display on the ok button + */ + okText : "&#160;OK&#160;", // &#160; to give the user extra clicking room + /** + * @cfg {String} cancelText + * The text to display on the cancel button + */ + cancelText : "Cancel", + /** + * @cfg {String} todayTip + * The tooltip to display for the button that selects the current date (defaults to "{current date} (Spacebar)") + */ + todayTip : "{0} (Spacebar)", + /** + * @cfg {Date} minDate + * Minimum allowable date (JavaScript date object, defaults to null) + */ + minDate : null, + /** + * @cfg {Date} maxDate + * Maximum allowable date (JavaScript date object, defaults to null) + */ + maxDate : null, + /** + * @cfg {String} minText + * The error text to display if the minDate validation fails (defaults to "This date is before the minimum date") + */ + minText : "This date is before the minimum date", + /** + * @cfg {String} maxText + * The error text to display if the maxDate validation fails (defaults to "This date is after the maximum date") + */ + maxText : "This date is after the maximum date", + /** + * @cfg {String} format + * The default date format string which can be overriden for localization support. The format must be + * valid according to {@link Date#parseDate} (defaults to 'm/d/y'). + */ + format : "m/d/y", + /** + * @cfg {Array} disabledDays + * An array of days to disable, 0-based. For example, [0, 6] disables Sunday and Saturday (defaults to null). + */ + disabledDays : null, + /** + * @cfg {String} disabledDaysText + * The tooltip to display when the date falls on a disabled day (defaults to "") + */ + disabledDaysText : "", + /** + * @cfg {RegExp} disabledDatesRE + * JavaScript regular expression used to disable a pattern of dates (defaults to null) + */ + disabledDatesRE : null, + /** + * @cfg {String} disabledDatesText + * The tooltip text to display when the date falls on a disabled date (defaults to "") + */ + disabledDatesText : "", + /** + * @cfg {Boolean} constrainToViewport + * True to constrain the date picker to the viewport (defaults to true) + */ + constrainToViewport : true, + /** + * @cfg {Array} monthNames + * An array of textual month names which can be overriden for localization support (defaults to Date.monthNames) + */ + monthNames : Date.monthNames, + /** + * @cfg {Array} dayNames + * An array of textual day names which can be overriden for localization support (defaults to Date.dayNames) + */ + dayNames : Date.dayNames, + /** + * @cfg {String} nextText + * The next month navigation button tooltip (defaults to 'Next Month (Control+Right)') + */ + nextText: 'Next Month (Control+Right)', + /** + * @cfg {String} prevText + * The previous month navigation button tooltip (defaults to 'Previous Month (Control+Left)') + */ + prevText: 'Previous Month (Control+Left)', + /** + * @cfg {String} monthYearText + * The header month selector tooltip (defaults to 'Choose a month (Control+Up/Down to move years)') + */ + monthYearText: 'Choose a month (Control+Up/Down to move years)', + /** + * @cfg {Number} startDay + * Day index at which the week should begin, 0-based (defaults to 0, which is Sunday) + */ + startDay : 0, + /** + * @cfg {Bool} showClear + * Show a clear button (usefull for date form elements that can be blank.) + */ + + showClear: false, + + /** + * Sets the value of the date field + * @param {Date} value The date to set + */ + setValue : function(value){ + var old = this.value; + + if (typeof(value) == 'string') { + + value = Date.parseDate(value, this.format); + } + if (!value) { + value = new Date(); + } + + this.value = value.clearTime(true); + if(this.el){ + this.update(this.value); + } + }, + + /** + * Gets the current selected value of the date field + * @return {Date} The selected date + */ + getValue : function(){ + return this.value; + }, + + // private + focus : function(){ + if(this.el){ + this.update(this.activeDate); + } + }, + + // privateval + onRender : function(container, position){ + + var m = [ + '<table cellspacing="0">', + '<tr><td class="x-date-left"><a href="#" title="', this.prevText ,'">&#160;</a></td><td class="x-date-middle" align="center"></td><td class="x-date-right"><a href="#" title="', this.nextText ,'">&#160;</a></td></tr>', + '<tr><td colspan="3"><table class="x-date-inner" cellspacing="0"><thead><tr>']; + var dn = this.dayNames; + for(var i = 0; i < 7; i++){ + var d = this.startDay+i; + if(d > 6){ + d = d-7; + } + m.push("<th><span>", dn[d].substr(0,1), "</span></th>"); + } + m[m.length] = "</tr></thead><tbody><tr>"; + for(var i = 0; i < 42; i++) { + if(i % 7 == 0 && i != 0){ + m[m.length] = "</tr><tr>"; + } + m[m.length] = '<td><a href="#" hidefocus="on" class="x-date-date" tabIndex="1"><em><span></span></em></a></td>'; + } + m[m.length] = '</tr></tbody></table></td></tr><tr>'+ + '<td colspan="3" class="x-date-bottom" align="center"></td></tr></table><div class="x-date-mp"></div>'; + + var el = document.createElement("div"); + el.className = "x-date-picker"; + el.innerHTML = m.join(""); + + container.dom.insertBefore(el, position); + + this.el = Roo.get(el); + this.eventEl = Roo.get(el.firstChild); + + new Roo.util.ClickRepeater(this.el.child("td.x-date-left a"), { + handler: this.showPrevMonth, + scope: this, + preventDefault:true, + stopDefault:true + }); + + new Roo.util.ClickRepeater(this.el.child("td.x-date-right a"), { + handler: this.showNextMonth, + scope: this, + preventDefault:true, + stopDefault:true + }); + + this.eventEl.on("mousewheel", this.handleMouseWheel, this); + + this.monthPicker = this.el.down('div.x-date-mp'); + this.monthPicker.enableDisplayMode('block'); + + var kn = new Roo.KeyNav(this.eventEl, { + "left" : function(e){ + e.ctrlKey ? + this.showPrevMonth() : + this.update(this.activeDate.add("d", -1)); + }, + + "right" : function(e){ + e.ctrlKey ? + this.showNextMonth() : + this.update(this.activeDate.add("d", 1)); + }, + + "up" : function(e){ + e.ctrlKey ? + this.showNextYear() : + this.update(this.activeDate.add("d", -7)); + }, + + "down" : function(e){ + e.ctrlKey ? + this.showPrevYear() : + this.update(this.activeDate.add("d", 7)); + }, + + "pageUp" : function(e){ + this.showNextMonth(); + }, + + "pageDown" : function(e){ + this.showPrevMonth(); + }, + + "enter" : function(e){ + e.stopPropagation(); + return true; + }, + + scope : this + }); + + this.eventEl.on("click", this.handleDateClick, this, {delegate: "a.x-date-date"}); + + this.eventEl.addKeyListener(Roo.EventObject.SPACE, this.selectToday, this); + + this.el.unselectable(); + + this.cells = this.el.select("table.x-date-inner tbody td"); + this.textNodes = this.el.query("table.x-date-inner tbody span"); + + this.mbtn = new Roo.Button(this.el.child("td.x-date-middle", true), { + text: "&#160;", + tooltip: this.monthYearText + }); + + this.mbtn.on('click', this.showMonthPicker, this); + this.mbtn.el.child(this.mbtn.menuClassTarget).addClass("x-btn-with-menu"); + + + var today = (new Date()).dateFormat(this.format); + + var baseTb = new Roo.Toolbar(this.el.child("td.x-date-bottom", true)); + if (this.showClear) { + baseTb.add( new Roo.Toolbar.Fill()); + } + baseTb.add({ + text: String.format(this.todayText, today), + tooltip: String.format(this.todayTip, today), + handler: this.selectToday, + scope: this + }); + + //var todayBtn = new Roo.Button(this.el.child("td.x-date-bottom", true), { + + //}); + if (this.showClear) { + + baseTb.add( new Roo.Toolbar.Fill()); + baseTb.add({ + text: '&#160;', + cls: 'x-btn-icon x-btn-clear', + handler: function() { + //this.value = ''; + this.fireEvent("select", this, ''); + }, + scope: this + }); + } + + + if(Roo.isIE){ + this.el.repaint(); + } + this.update(this.value); + }, + + createMonthPicker : function(){ + if(!this.monthPicker.dom.firstChild){ + var buf = ['<table border="0" cellspacing="0">']; + for(var i = 0; i < 6; i++){ + buf.push( + '<tr><td class="x-date-mp-month"><a href="#">', this.monthNames[i].substr(0, 3), '</a></td>', + '<td class="x-date-mp-month x-date-mp-sep"><a href="#">', this.monthNames[i+6].substr(0, 3), '</a></td>', + i == 0 ? + '<td class="x-date-mp-ybtn" align="center"><a class="x-date-mp-prev"></a></td><td class="x-date-mp-ybtn" align="center"><a class="x-date-mp-next"></a></td></tr>' : + '<td class="x-date-mp-year"><a href="#"></a></td><td class="x-date-mp-year"><a href="#"></a></td></tr>' + ); + } + buf.push( + '<tr class="x-date-mp-btns"><td colspan="4"><button type="button" class="x-date-mp-ok">', + this.okText, + '</button><button type="button" class="x-date-mp-cancel">', + this.cancelText, + '</button></td></tr>', + '</table>' + ); + this.monthPicker.update(buf.join('')); + this.monthPicker.on('click', this.onMonthClick, this); + this.monthPicker.on('dblclick', this.onMonthDblClick, this); + + this.mpMonths = this.monthPicker.select('td.x-date-mp-month'); + this.mpYears = this.monthPicker.select('td.x-date-mp-year'); + + this.mpMonths.each(function(m, a, i){ + i += 1; + if((i%2) == 0){ + m.dom.xmonth = 5 + Math.round(i * .5); + }else{ + m.dom.xmonth = Math.round((i-1) * .5); + } + }); + } + }, + + showMonthPicker : function(){ + this.createMonthPicker(); + var size = this.el.getSize(); + this.monthPicker.setSize(size); + this.monthPicker.child('table').setSize(size); + + this.mpSelMonth = (this.activeDate || this.value).getMonth(); + this.updateMPMonth(this.mpSelMonth); + this.mpSelYear = (this.activeDate || this.value).getFullYear(); + this.updateMPYear(this.mpSelYear); + + this.monthPicker.slideIn('t', {duration:.2}); + }, + + updateMPYear : function(y){ + this.mpyear = y; + var ys = this.mpYears.elements; + for(var i = 1; i <= 10; i++){ + var td = ys[i-1], y2; + if((i%2) == 0){ + y2 = y + Math.round(i * .5); + td.firstChild.innerHTML = y2; + td.xyear = y2; + }else{ + y2 = y - (5-Math.round(i * .5)); + td.firstChild.innerHTML = y2; + td.xyear = y2; + } + this.mpYears.item(i-1)[y2 == this.mpSelYear ? 'addClass' : 'removeClass']('x-date-mp-sel'); + } + }, + + updateMPMonth : function(sm){ + this.mpMonths.each(function(m, a, i){ + m[m.dom.xmonth == sm ? 'addClass' : 'removeClass']('x-date-mp-sel'); + }); + }, + + selectMPMonth: function(m){ + + }, + + onMonthClick : function(e, t){ + e.stopEvent(); + var el = new Roo.Element(t), pn; + if(el.is('button.x-date-mp-cancel')){ + this.hideMonthPicker(); + } + else if(el.is('button.x-date-mp-ok')){ + this.update(new Date(this.mpSelYear, this.mpSelMonth, (this.activeDate || this.value).getDate())); + this.hideMonthPicker(); + } + else if(pn = el.up('td.x-date-mp-month', 2)){ + this.mpMonths.removeClass('x-date-mp-sel'); + pn.addClass('x-date-mp-sel'); + this.mpSelMonth = pn.dom.xmonth; + } + else if(pn = el.up('td.x-date-mp-year', 2)){ + this.mpYears.removeClass('x-date-mp-sel'); + pn.addClass('x-date-mp-sel'); + this.mpSelYear = pn.dom.xyear; + } + else if(el.is('a.x-date-mp-prev')){ + this.updateMPYear(this.mpyear-10); + } + else if(el.is('a.x-date-mp-next')){ + this.updateMPYear(this.mpyear+10); + } + }, + + onMonthDblClick : function(e, t){ + e.stopEvent(); + var el = new Roo.Element(t), pn; + if(pn = el.up('td.x-date-mp-month', 2)){ + this.update(new Date(this.mpSelYear, pn.dom.xmonth, (this.activeDate || this.value).getDate())); + this.hideMonthPicker(); + } + else if(pn = el.up('td.x-date-mp-year', 2)){ + this.update(new Date(pn.dom.xyear, this.mpSelMonth, (this.activeDate || this.value).getDate())); + this.hideMonthPicker(); + } + }, + + hideMonthPicker : function(disableAnim){ + if(this.monthPicker){ + if(disableAnim === true){ + this.monthPicker.hide(); + }else{ + this.monthPicker.slideOut('t', {duration:.2}); + } + } + }, + + // private + showPrevMonth : function(e){ + this.update(this.activeDate.add("mo", -1)); + }, + + // private + showNextMonth : function(e){ + this.update(this.activeDate.add("mo", 1)); + }, + + // private + showPrevYear : function(){ + this.update(this.activeDate.add("y", -1)); + }, + + // private + showNextYear : function(){ + this.update(this.activeDate.add("y", 1)); + }, + + // private + handleMouseWheel : function(e){ + var delta = e.getWheelDelta(); + if(delta > 0){ + this.showPrevMonth(); + e.stopEvent(); + } else if(delta < 0){ + this.showNextMonth(); + e.stopEvent(); + } + }, + + // private + handleDateClick : function(e, t){ + e.stopEvent(); + if(t.dateValue && !Roo.fly(t.parentNode).hasClass("x-date-disabled")){ + this.setValue(new Date(t.dateValue)); + this.fireEvent("select", this, this.value); + } + }, + + // private + selectToday : function(){ + this.setValue(new Date().clearTime()); + this.fireEvent("select", this, this.value); + }, + + // private + update : function(date) + { + var vd = this.activeDate; + this.activeDate = date; + if(vd && this.el){ + var t = date.getTime(); + if(vd.getMonth() == date.getMonth() && vd.getFullYear() == date.getFullYear()){ + this.cells.removeClass("x-date-selected"); + this.cells.each(function(c){ + if(c.dom.firstChild.dateValue == t){ + c.addClass("x-date-selected"); + setTimeout(function(){ + try{c.dom.firstChild.focus();}catch(e){} + }, 50); + return false; + } + }); + return; + } + } + + var days = date.getDaysInMonth(); + var firstOfMonth = date.getFirstDateOfMonth(); + var startingPos = firstOfMonth.getDay()-this.startDay; + + if(startingPos <= this.startDay){ + startingPos += 7; + } + + var pm = date.add("mo", -1); + var prevStart = pm.getDaysInMonth()-startingPos; + + var cells = this.cells.elements; + var textEls = this.textNodes; + days += startingPos; + + // convert everything to numbers so it's fast + var day = 86400000; + var d = (new Date(pm.getFullYear(), pm.getMonth(), prevStart)).clearTime(); + var today = new Date().clearTime().getTime(); + var sel = date.clearTime().getTime(); + var min = this.minDate ? this.minDate.clearTime() : Number.NEGATIVE_INFINITY; + var max = this.maxDate ? this.maxDate.clearTime() : Number.POSITIVE_INFINITY; + var ddMatch = this.disabledDatesRE; + var ddText = this.disabledDatesText; + var ddays = this.disabledDays ? this.disabledDays.join("") : false; + var ddaysText = this.disabledDaysText; + var format = this.format; + + var setCellClass = function(cal, cell){ + cell.title = ""; + var t = d.getTime(); + cell.firstChild.dateValue = t; + if(t == today){ + cell.className += " x-date-today"; + cell.title = cal.todayText; + } + if(t == sel){ + cell.className += " x-date-selected"; + setTimeout(function(){ + try{cell.firstChild.focus();}catch(e){} + }, 50); + } + // disabling + if(t < min) { + cell.className = " x-date-disabled"; + cell.title = cal.minText; + return; + } + if(t > max) { + cell.className = " x-date-disabled"; + cell.title = cal.maxText; + return; + } + if(ddays){ + if(ddays.indexOf(d.getDay()) != -1){ + cell.title = ddaysText; + cell.className = " x-date-disabled"; + } + } + if(ddMatch && format){ + var fvalue = d.dateFormat(format); + if(ddMatch.test(fvalue)){ + cell.title = ddText.replace("%0", fvalue); + cell.className = " x-date-disabled"; + } + } + }; + + var i = 0; + for(; i < startingPos; i++) { + textEls[i].innerHTML = (++prevStart); + d.setDate(d.getDate()+1); + cells[i].className = "x-date-prevday"; + setCellClass(this, cells[i]); + } + for(; i < days; i++){ + intDay = i - startingPos + 1; + textEls[i].innerHTML = (intDay); + d.setDate(d.getDate()+1); + cells[i].className = "x-date-active"; + setCellClass(this, cells[i]); + } + var extraDays = 0; + for(; i < 42; i++) { + textEls[i].innerHTML = (++extraDays); + d.setDate(d.getDate()+1); + cells[i].className = "x-date-nextday"; + setCellClass(this, cells[i]); + } + + this.mbtn.setText(this.monthNames[date.getMonth()] + " " + date.getFullYear()); + this.fireEvent('monthchange', this, date); + + if(!this.internalRender){ + var main = this.el.dom.firstChild; + var w = main.offsetWidth; + this.el.setWidth(w + this.el.getBorderWidth("lr")); + Roo.fly(main).setWidth(w); + this.internalRender = true; + // opera does not respect the auto grow header center column + // then, after it gets a width opera refuses to recalculate + // without a second pass + if(Roo.isOpera && !this.secondPass){ + main.rows[0].cells[1].style.width = (w - (main.rows[0].cells[0].offsetWidth+main.rows[0].cells[2].offsetWidth)) + "px"; + this.secondPass = true; + this.update.defer(10, this, [date]); + } + } + + + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_Document.js.html b/docs2/src/Roo_Document.js.html new file mode 100644 index 0000000000..1324fea67d --- /dev/null +++ b/docs2/src/Roo_Document.js.html @@ -0,0 +1,46 @@ +/home/alan/gitlive/roojs1/Roo/Document.js/* + * RooJS Library + * Copyright(c) 2007-2017, Roo J Solutions Ltd + * + * Licence LGPL + * + */ + +/** + * @class Roo.Document + * @extends Roo.util.Observable + * This is a convience class to wrap up the main document loading code.. , rather than adding Roo.onReady(......) + * + * @param {Object} config the methods and properties of the 'base' class for the application. + * + * Generic Page handler - implement this to start your app.. + * + * eg. + * MyProject = new Roo.Document({ + events : { + 'load' : true // your events.. + }, + listeners : { + 'ready' : function() { + // fired on Roo.onReady() + } + } + * + */ +Roo.Document = function(cfg) { + + this.addEvents({ + 'ready' : true + }); + Roo.util.Observable.call(this,cfg); + + var _this = this; + + Roo.onReady(function() { + _this.fireEvent('ready'); + },null,false); + + +} + +Roo.extend(Roo.Document, Roo.util.Observable, {}); \ No newline at end of file diff --git a/docs2/src/Roo_DomHelper.js.html b/docs2/src/Roo_DomHelper.js.html new file mode 100644 index 0000000000..d3b98f5933 --- /dev/null +++ b/docs2/src/Roo_DomHelper.js.html @@ -0,0 +1,456 @@ +/home/alan/gitlive/roojs1/Roo/DomHelper.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +// nasty IE9 hack - what a pile of crap that is.. + + if (typeof Range != "undefined" && typeof Range.prototype.createContextualFragment == "undefined") { + Range.prototype.createContextualFragment = function (html) { + var doc = window.document; + var container = doc.createElement("div"); + container.innerHTML = html; + var frag = doc.createDocumentFragment(), n; + while ((n = container.firstChild)) { + frag.appendChild(n); + } + return frag; + }; +} + +/** + * @class Roo.DomHelper + * Utility class for working with DOM and/or Templates. It transparently supports using HTML fragments or DOM. + * For more information see <a href="http://web.archive.org/web/20071221063734/http://www.jackslocum.com/blog/2006/10/06/domhelper-create-elements-using-dom-html-fragments-or-templates/">this blog post with examples</a>. + * @singleton + */ +Roo.DomHelper = function(){ + var tempTableEl = null; + var emptyTags = /^(?:br|frame|hr|img|input|link|meta|range|spacer|wbr|area|param|col)$/i; + var tableRe = /^table|tbody|tr|td$/i; + var xmlns = {}; + // build as innerHTML where available + /** @ignore */ + var createHtml = function(o){ + if(typeof o == 'string'){ + return o; + } + var b = ""; + if(!o.tag){ + o.tag = "div"; + } + b += "<" + o.tag; + for(var attr in o){ + if(attr == "tag" || attr == "children" || attr == "cn" || attr == "html" || typeof o[attr] == "function") { continue; } + if(attr == "style"){ + var s = o["style"]; + if(typeof s == "function"){ + s = s.call(); + } + if(typeof s == "string"){ + b += ' style="' + s + '"'; + }else if(typeof s == "object"){ + b += ' style="'; + for(var key in s){ + if(typeof s[key] != "function"){ + b += key + ":" + s[key] + ";"; + } + } + b += '"'; + } + }else{ + if(attr == "cls"){ + b += ' class="' + o["cls"] + '"'; + }else if(attr == "htmlFor"){ + b += ' for="' + o["htmlFor"] + '"'; + }else{ + b += " " + attr + '="' + o[attr] + '"'; + } + } + } + if(emptyTags.test(o.tag)){ + b += "/>"; + }else{ + b += ">"; + var cn = o.children || o.cn; + if(cn){ + //http://bugs.kde.org/show_bug.cgi?id=71506 + if((cn instanceof Array) || (Roo.isSafari && typeof(cn.join) == "function")){ + for(var i = 0, len = cn.length; i < len; i++) { + b += createHtml(cn[i], b); + } + }else{ + b += createHtml(cn, b); + } + } + if(o.html){ + b += o.html; + } + b += "</" + o.tag + ">"; + } + return b; + }; + + // build as dom + /** @ignore */ + var createDom = function(o, parentNode){ + + // defininition craeted.. + var ns = false; + if (o.ns && o.ns != 'html') { + + if (o.xmlns && typeof(xmlns[o.ns]) == 'undefined') { + xmlns[o.ns] = o.xmlns; + ns = o.xmlns; + } + if (typeof(xmlns[o.ns]) == 'undefined') { + console.log("Trying to create namespace element " + o.ns + ", however no xmlns was sent to builder previously"); + } + ns = xmlns[o.ns]; + } + + + if (typeof(o) == 'string') { + return parentNode.appendChild(document.createTextNode(o)); + } + o.tag = o.tag || div; + if (o.ns && Roo.isIE) { + ns = false; + o.tag = o.ns + ':' + o.tag; + + } + var el = ns ? document.createElementNS( ns, o.tag||'div') : document.createElement(o.tag||'div'); + var useSet = el.setAttribute ? true : false; // In IE some elements don't have setAttribute + for(var attr in o){ + + if(attr == "tag" || attr == "ns" ||attr == "xmlns" ||attr == "children" || attr == "cn" || attr == "html" || + attr == "style" || typeof o[attr] == "function") { continue; } + + if(attr=="cls" && Roo.isIE){ + el.className = o["cls"]; + }else{ + if(useSet) { el.setAttribute(attr=="cls" ? 'class' : attr, o[attr]);} + else { + el[attr] = o[attr]; + } + } + } + Roo.DomHelper.applyStyles(el, o.style); + var cn = o.children || o.cn; + if(cn){ + //http://bugs.kde.org/show_bug.cgi?id=71506 + if((cn instanceof Array) || (Roo.isSafari && typeof(cn.join) == "function")){ + for(var i = 0, len = cn.length; i < len; i++) { + createDom(cn[i], el); + } + }else{ + createDom(cn, el); + } + } + if(o.html){ + el.innerHTML = o.html; + } + if(parentNode){ + parentNode.appendChild(el); + } + return el; + }; + + var ieTable = function(depth, s, h, e){ + tempTableEl.innerHTML = [s, h, e].join(''); + var i = -1, el = tempTableEl; + while(++i < depth){ + el = el.firstChild; + } + return el; + }; + + // kill repeat to save bytes + var ts = '<table>', + te = '</table>', + tbs = ts+'<tbody>', + tbe = '</tbody>'+te, + trs = tbs + '<tr>', + tre = '</tr>'+tbe; + + /** + * @ignore + * Nasty code for IE's broken table implementation + */ + var insertIntoTable = function(tag, where, el, html){ + if(!tempTableEl){ + tempTableEl = document.createElement('div'); + } + var node; + var before = null; + if(tag == 'td'){ + if(where == 'afterbegin' || where == 'beforeend'){ // INTO a TD + return; + } + if(where == 'beforebegin'){ + before = el; + el = el.parentNode; + } else{ + before = el.nextSibling; + el = el.parentNode; + } + node = ieTable(4, trs, html, tre); + } + else if(tag == 'tr'){ + if(where == 'beforebegin'){ + before = el; + el = el.parentNode; + node = ieTable(3, tbs, html, tbe); + } else if(where == 'afterend'){ + before = el.nextSibling; + el = el.parentNode; + node = ieTable(3, tbs, html, tbe); + } else{ // INTO a TR + if(where == 'afterbegin'){ + before = el.firstChild; + } + node = ieTable(4, trs, html, tre); + } + } else if(tag == 'tbody'){ + if(where == 'beforebegin'){ + before = el; + el = el.parentNode; + node = ieTable(2, ts, html, te); + } else if(where == 'afterend'){ + before = el.nextSibling; + el = el.parentNode; + node = ieTable(2, ts, html, te); + } else{ + if(where == 'afterbegin'){ + before = el.firstChild; + } + node = ieTable(3, tbs, html, tbe); + } + } else{ // TABLE + if(where == 'beforebegin' || where == 'afterend'){ // OUTSIDE the table + return; + } + if(where == 'afterbegin'){ + before = el.firstChild; + } + node = ieTable(2, ts, html, te); + } + el.insertBefore(node, before); + return node; + }; + + return { + /** True to force the use of DOM instead of html fragments @type Boolean */ + useDom : false, + + /** + * Returns the markup for the passed Element(s) config + * @param {Object} o The Dom object spec (and children) + * @return {String} + */ + markup : function(o){ + return createHtml(o); + }, + + /** + * Applies a style specification to an element + * @param {String/HTMLElement} el The element to apply styles to + * @param {String/Object/Function} styles A style specification string eg "width:100px", or object in the form {width:"100px"}, or + * a function which returns such a specification. + */ + applyStyles : function(el, styles){ + if(styles){ + el = Roo.fly(el); + if(typeof styles == "string"){ + var re = /\s?([a-z\-]*)\:\s?([^;]*);?/gi; + var matches; + while ((matches = re.exec(styles)) != null){ + el.setStyle(matches[1], matches[2]); + } + }else if (typeof styles == "object"){ + for (var style in styles){ + el.setStyle(style, styles[style]); + } + }else if (typeof styles == "function"){ + Roo.DomHelper.applyStyles(el, styles.call()); + } + } + }, + + /** + * Inserts an HTML fragment into the Dom + * @param {String} where Where to insert the html in relation to el - beforeBegin, afterBegin, beforeEnd, afterEnd. + * @param {HTMLElement} el The context element + * @param {String} html The HTML fragmenet + * @return {HTMLElement} The new node + */ + insertHtml : function(where, el, html){ + where = where.toLowerCase(); + if(el.insertAdjacentHTML){ + if(tableRe.test(el.tagName)){ + var rs; + if(rs = insertIntoTable(el.tagName.toLowerCase(), where, el, html)){ + return rs; + } + } + switch(where){ + case "beforebegin": + el.insertAdjacentHTML('BeforeBegin', html); + return el.previousSibling; + case "afterbegin": + el.insertAdjacentHTML('AfterBegin', html); + return el.firstChild; + case "beforeend": + el.insertAdjacentHTML('BeforeEnd', html); + return el.lastChild; + case "afterend": + el.insertAdjacentHTML('AfterEnd', html); + return el.nextSibling; + } + throw 'Illegal insertion point -> "' + where + '"'; + } + var range = el.ownerDocument.createRange(); + var frag; + switch(where){ + case "beforebegin": + range.setStartBefore(el); + frag = range.createContextualFragment(html); + el.parentNode.insertBefore(frag, el); + return el.previousSibling; + case "afterbegin": + if(el.firstChild){ + range.setStartBefore(el.firstChild); + frag = range.createContextualFragment(html); + el.insertBefore(frag, el.firstChild); + return el.firstChild; + }else{ + el.innerHTML = html; + return el.firstChild; + } + case "beforeend": + if(el.lastChild){ + range.setStartAfter(el.lastChild); + frag = range.createContextualFragment(html); + el.appendChild(frag); + return el.lastChild; + }else{ + el.innerHTML = html; + return el.lastChild; + } + case "afterend": + range.setStartAfter(el); + frag = range.createContextualFragment(html); + el.parentNode.insertBefore(frag, el.nextSibling); + return el.nextSibling; + } + throw 'Illegal insertion point -> "' + where + '"'; + }, + + /** + * Creates new Dom element(s) and inserts them before el + * @param {String/HTMLElement/Element} el The context element + * @param {Object/String} o The Dom object spec (and children) or raw HTML blob + * @param {Boolean} returnElement (optional) true to return a Roo.Element + * @return {HTMLElement/Roo.Element} The new node + */ + insertBefore : function(el, o, returnElement){ + return this.doInsert(el, o, returnElement, "beforeBegin"); + }, + + /** + * Creates new Dom element(s) and inserts them after el + * @param {String/HTMLElement/Element} el The context element + * @param {Object} o The Dom object spec (and children) + * @param {Boolean} returnElement (optional) true to return a Roo.Element + * @return {HTMLElement/Roo.Element} The new node + */ + insertAfter : function(el, o, returnElement){ + return this.doInsert(el, o, returnElement, "afterEnd", "nextSibling"); + }, + + /** + * Creates new Dom element(s) and inserts them as the first child of el + * @param {String/HTMLElement/Element} el The context element + * @param {Object/String} o The Dom object spec (and children) or raw HTML blob + * @param {Boolean} returnElement (optional) true to return a Roo.Element + * @return {HTMLElement/Roo.Element} The new node + */ + insertFirst : function(el, o, returnElement){ + return this.doInsert(el, o, returnElement, "afterBegin"); + }, + + // private + doInsert : function(el, o, returnElement, pos, sibling){ + el = Roo.getDom(el); + var newNode; + if(this.useDom || o.ns){ + newNode = createDom(o, null); + el.parentNode.insertBefore(newNode, sibling ? el[sibling] : el); + }else{ + var html = createHtml(o); + newNode = this.insertHtml(pos, el, html); + } + return returnElement ? Roo.get(newNode, true) : newNode; + }, + + /** + * Creates new Dom element(s) and appends them to el + * @param {String/HTMLElement/Element} el The context element + * @param {Object/String} o The Dom object spec (and children) or raw HTML blob + * @param {Boolean} returnElement (optional) true to return a Roo.Element + * @return {HTMLElement/Roo.Element} The new node + */ + append : function(el, o, returnElement){ + el = Roo.getDom(el); + var newNode; + if(this.useDom || o.ns){ + newNode = createDom(o, null); + el.appendChild(newNode); + }else{ + var html = createHtml(o); + newNode = this.insertHtml("beforeEnd", el, html); + } + return returnElement ? Roo.get(newNode, true) : newNode; + }, + + /** + * Creates new Dom element(s) and overwrites the contents of el with them + * @param {String/HTMLElement/Element} el The context element + * @param {Object/String} o The Dom object spec (and children) or raw HTML blob + * @param {Boolean} returnElement (optional) true to return a Roo.Element + * @return {HTMLElement/Roo.Element} The new node + */ + overwrite : function(el, o, returnElement){ + el = Roo.getDom(el); + if (o.ns) { + + while (el.childNodes.length) { + el.removeChild(el.firstChild); + } + createDom(o, el); + } else { + el.innerHTML = createHtml(o); + } + + return returnElement ? Roo.get(el.firstChild, true) : el.firstChild; + }, + + /** + * Creates a new Roo.DomHelper.Template from the Dom object spec + * @param {Object} o The Dom object spec (and children) + * @return {Roo.DomHelper.Template} The new template + */ + createTemplate : function(o){ + var html = createHtml(o); + return new Roo.Template(html); + } + }; +}(); + \ No newline at end of file diff --git a/docs2/src/Roo_DomQuery.js.html b/docs2/src/Roo_DomQuery.js.html new file mode 100644 index 0000000000..f44d8522ca --- /dev/null +++ b/docs2/src/Roo_DomQuery.js.html @@ -0,0 +1,824 @@ +/home/alan/gitlive/roojs1/Roo/DomQuery.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/* + * This is code is also distributed under MIT license for use + * with jQuery and prototype JavaScript libraries. + */ +/** + * @class Roo.DomQuery +Provides high performance selector/xpath processing by compiling queries into reusable functions. New pseudo classes and matchers can be plugged. It works on HTML and XML documents (if a content node is passed in). +<p> +DomQuery supports most of the <a href="http://www.w3.org/TR/2005/WD-css3-selectors-20051215/">CSS3 selectors spec</a>, along with some custom selectors and basic XPath.</p> + +<p> +All selectors, attribute filters and pseudos below can be combined infinitely in any order. For example "div.foo:nth-child(odd)[@foo=bar].bar:first" would be a perfectly valid selector. Node filters are processed in the order in which they appear, which allows you to optimize your queries for your document structure. +</p> +<h4>Element Selectors:</h4> +<ul class="list"> + <li> <b>*</b> any element</li> + <li> <b>E</b> an element with the tag E</li> + <li> <b>E F</b> All descendent elements of E that have the tag F</li> + <li> <b>E > F</b> or <b>E/F</b> all direct children elements of E that have the tag F</li> + <li> <b>E + F</b> all elements with the tag F that are immediately preceded by an element with the tag E</li> + <li> <b>E ~ F</b> all elements with the tag F that are preceded by a sibling element with the tag E</li> +</ul> +<h4>Attribute Selectors:</h4> +<p>The use of @ and quotes are optional. For example, div[@foo='bar'] is also a valid attribute selector.</p> +<ul class="list"> + <li> <b>E[foo]</b> has an attribute "foo"</li> + <li> <b>E[foo=bar]</b> has an attribute "foo" that equals "bar"</li> + <li> <b>E[foo^=bar]</b> has an attribute "foo" that starts with "bar"</li> + <li> <b>E[foo$=bar]</b> has an attribute "foo" that ends with "bar"</li> + <li> <b>E[foo*=bar]</b> has an attribute "foo" that contains the substring "bar"</li> + <li> <b>E[foo%=2]</b> has an attribute "foo" that is evenly divisible by 2</li> + <li> <b>E[foo!=bar]</b> has an attribute "foo" that does not equal "bar"</li> +</ul> +<h4>Pseudo Classes:</h4> +<ul class="list"> + <li> <b>E:first-child</b> E is the first child of its parent</li> + <li> <b>E:last-child</b> E is the last child of its parent</li> + <li> <b>E:nth-child(<i>n</i>)</b> E is the <i>n</i>th child of its parent (1 based as per the spec)</li> + <li> <b>E:nth-child(odd)</b> E is an odd child of its parent</li> + <li> <b>E:nth-child(even)</b> E is an even child of its parent</li> + <li> <b>E:only-child</b> E is the only child of its parent</li> + <li> <b>E:checked</b> E is an element that is has a checked attribute that is true (e.g. a radio or checkbox) </li> + <li> <b>E:first</b> the first E in the resultset</li> + <li> <b>E:last</b> the last E in the resultset</li> + <li> <b>E:nth(<i>n</i>)</b> the <i>n</i>th E in the resultset (1 based)</li> + <li> <b>E:odd</b> shortcut for :nth-child(odd)</li> + <li> <b>E:even</b> shortcut for :nth-child(even)</li> + <li> <b>E:contains(foo)</b> E's innerHTML contains the substring "foo"</li> + <li> <b>E:nodeValue(foo)</b> E contains a textNode with a nodeValue that equals "foo"</li> + <li> <b>E:not(S)</b> an E element that does not match simple selector S</li> + <li> <b>E:has(S)</b> an E element that has a descendent that matches simple selector S</li> + <li> <b>E:next(S)</b> an E element whose next sibling matches simple selector S</li> + <li> <b>E:prev(S)</b> an E element whose previous sibling matches simple selector S</li> +</ul> +<h4>CSS Value Selectors:</h4> +<ul class="list"> + <li> <b>E{display=none}</b> css value "display" that equals "none"</li> + <li> <b>E{display^=none}</b> css value "display" that starts with "none"</li> + <li> <b>E{display$=none}</b> css value "display" that ends with "none"</li> + <li> <b>E{display*=none}</b> css value "display" that contains the substring "none"</li> + <li> <b>E{display%=2}</b> css value "display" that is evenly divisible by 2</li> + <li> <b>E{display!=none}</b> css value "display" that does not equal "none"</li> +</ul> + * @singleton + */ +Roo.DomQuery = function(){ + var cache = {}, simpleCache = {}, valueCache = {}; + var nonSpace = /\S/; + var trimRe = /^\s+|\s+$/g; + var tplRe = /\{(\d+)\}/g; + var modeRe = /^(\s?[\/>+~]\s?|\s|$)/; + var tagTokenRe = /^(#)?([\w-\*]+)/; + var nthRe = /(\d*)n\+?(\d*)/, nthRe2 = /\D/; + + function child(p, index){ + var i = 0; + var n = p.firstChild; + while(n){ + if(n.nodeType == 1){ + if(++i == index){ + return n; + } + } + n = n.nextSibling; + } + return null; + }; + + function next(n){ + while((n = n.nextSibling) && n.nodeType != 1); + return n; + }; + + function prev(n){ + while((n = n.previousSibling) && n.nodeType != 1); + return n; + }; + + function children(d){ + var n = d.firstChild, ni = -1; + while(n){ + var nx = n.nextSibling; + if(n.nodeType == 3 && !nonSpace.test(n.nodeValue)){ + d.removeChild(n); + }else{ + n.nodeIndex = ++ni; + } + n = nx; + } + return this; + }; + + function byClassName(c, a, v){ + if(!v){ + return c; + } + var r = [], ri = -1, cn; + for(var i = 0, ci; ci = c[i]; i++){ + if((' '+ci.className+' ').indexOf(v) != -1){ + r[++ri] = ci; + } + } + return r; + }; + + function attrValue(n, attr){ + if(!n.tagName && typeof n.length != "undefined"){ + n = n[0]; + } + if(!n){ + return null; + } + if(attr == "for"){ + return n.htmlFor; + } + if(attr == "class" || attr == "className"){ + return n.className; + } + return n.getAttribute(attr) || n[attr]; + + }; + + function getNodes(ns, mode, tagName){ + var result = [], ri = -1, cs; + if(!ns){ + return result; + } + tagName = tagName || "*"; + if(typeof ns.getElementsByTagName != "undefined"){ + ns = [ns]; + } + if(!mode){ + for(var i = 0, ni; ni = ns[i]; i++){ + cs = ni.getElementsByTagName(tagName); + for(var j = 0, ci; ci = cs[j]; j++){ + result[++ri] = ci; + } + } + }else if(mode == "/" || mode == ">"){ + var utag = tagName.toUpperCase(); + for(var i = 0, ni, cn; ni = ns[i]; i++){ + cn = ni.children || ni.childNodes; + for(var j = 0, cj; cj = cn[j]; j++){ + if(cj.nodeName == utag || cj.nodeName == tagName || tagName == '*'){ + result[++ri] = cj; + } + } + } + }else if(mode == "+"){ + var utag = tagName.toUpperCase(); + for(var i = 0, n; n = ns[i]; i++){ + while((n = n.nextSibling) && n.nodeType != 1); + if(n && (n.nodeName == utag || n.nodeName == tagName || tagName == '*')){ + result[++ri] = n; + } + } + }else if(mode == "~"){ + for(var i = 0, n; n = ns[i]; i++){ + while((n = n.nextSibling) && (n.nodeType != 1 || (tagName == '*' || n.tagName.toLowerCase()!=tagName))); + if(n){ + result[++ri] = n; + } + } + } + return result; + }; + + function concat(a, b){ + if(b.slice){ + return a.concat(b); + } + for(var i = 0, l = b.length; i < l; i++){ + a[a.length] = b[i]; + } + return a; + } + + function byTag(cs, tagName){ + if(cs.tagName || cs == document){ + cs = [cs]; + } + if(!tagName){ + return cs; + } + var r = [], ri = -1; + tagName = tagName.toLowerCase(); + for(var i = 0, ci; ci = cs[i]; i++){ + if(ci.nodeType == 1 && ci.tagName.toLowerCase()==tagName){ + r[++ri] = ci; + } + } + return r; + }; + + function byId(cs, attr, id){ + if(cs.tagName || cs == document){ + cs = [cs]; + } + if(!id){ + return cs; + } + var r = [], ri = -1; + for(var i = 0,ci; ci = cs[i]; i++){ + if(ci && ci.id == id){ + r[++ri] = ci; + return r; + } + } + return r; + }; + + function byAttribute(cs, attr, value, op, custom){ + var r = [], ri = -1, st = custom=="{"; + var f = Roo.DomQuery.operators[op]; + for(var i = 0, ci; ci = cs[i]; i++){ + var a; + if(st){ + a = Roo.DomQuery.getStyle(ci, attr); + } + else if(attr == "class" || attr == "className"){ + a = ci.className; + }else if(attr == "for"){ + a = ci.htmlFor; + }else if(attr == "href"){ + a = ci.getAttribute("href", 2); + }else{ + a = ci.getAttribute(attr); + } + if((f && f(a, value)) || (!f && a)){ + r[++ri] = ci; + } + } + return r; + }; + + function byPseudo(cs, name, value){ + return Roo.DomQuery.pseudos[name](cs, value); + }; + + // This is for IE MSXML which does not support expandos. + // IE runs the same speed using setAttribute, however FF slows way down + // and Safari completely fails so they need to continue to use expandos. + var isIE = window.ActiveXObject ? true : false; + + // this eval is stop the compressor from + // renaming the variable to something shorter + + /** eval:var:batch */ + var batch = 30803; + + var key = 30803; + + function nodupIEXml(cs){ + var d = ++key; + cs[0].setAttribute("_nodup", d); + var r = [cs[0]]; + for(var i = 1, len = cs.length; i < len; i++){ + var c = cs[i]; + if(!c.getAttribute("_nodup") != d){ + c.setAttribute("_nodup", d); + r[r.length] = c; + } + } + for(var i = 0, len = cs.length; i < len; i++){ + cs[i].removeAttribute("_nodup"); + } + return r; + } + + function nodup(cs){ + if(!cs){ + return []; + } + var len = cs.length, c, i, r = cs, cj, ri = -1; + if(!len || typeof cs.nodeType != "undefined" || len == 1){ + return cs; + } + if(isIE && typeof cs[0].selectSingleNode != "undefined"){ + return nodupIEXml(cs); + } + var d = ++key; + cs[0]._nodup = d; + for(i = 1; c = cs[i]; i++){ + if(c._nodup != d){ + c._nodup = d; + }else{ + r = []; + for(var j = 0; j < i; j++){ + r[++ri] = cs[j]; + } + for(j = i+1; cj = cs[j]; j++){ + if(cj._nodup != d){ + cj._nodup = d; + r[++ri] = cj; + } + } + return r; + } + } + return r; + } + + function quickDiffIEXml(c1, c2){ + var d = ++key; + for(var i = 0, len = c1.length; i < len; i++){ + c1[i].setAttribute("_qdiff", d); + } + var r = []; + for(var i = 0, len = c2.length; i < len; i++){ + if(c2[i].getAttribute("_qdiff") != d){ + r[r.length] = c2[i]; + } + } + for(var i = 0, len = c1.length; i < len; i++){ + c1[i].removeAttribute("_qdiff"); + } + return r; + } + + function quickDiff(c1, c2){ + var len1 = c1.length; + if(!len1){ + return c2; + } + if(isIE && c1[0].selectSingleNode){ + return quickDiffIEXml(c1, c2); + } + var d = ++key; + for(var i = 0; i < len1; i++){ + c1[i]._qdiff = d; + } + var r = []; + for(var i = 0, len = c2.length; i < len; i++){ + if(c2[i]._qdiff != d){ + r[r.length] = c2[i]; + } + } + return r; + } + + function quickId(ns, mode, root, id){ + if(ns == root){ + var d = root.ownerDocument || root; + return d.getElementById(id); + } + ns = getNodes(ns, mode, "*"); + return byId(ns, null, id); + } + + return { + getStyle : function(el, name){ + return Roo.fly(el).getStyle(name); + }, + /** + * Compiles a selector/xpath query into a reusable function. The returned function + * takes one parameter "root" (optional), which is the context node from where the query should start. + * @param {String} selector The selector/xpath query + * @param {String} type (optional) Either "select" (the default) or "simple" for a simple selector match + * @return {Function} + */ + compile : function(path, type){ + type = type || "select"; + + var fn = ["var f = function(root){\n var mode; ++batch; var n = root || document;\n"]; + var q = path, mode, lq; + var tk = Roo.DomQuery.matchers; + var tklen = tk.length; + var mm; + + // accept leading mode switch + var lmode = q.match(modeRe); + if(lmode && lmode[1]){ + fn[fn.length] = 'mode="'+lmode[1].replace(trimRe, "")+'";'; + q = q.replace(lmode[1], ""); + } + // strip leading slashes + while(path.substr(0, 1)=="/"){ + path = path.substr(1); + } + + while(q && lq != q){ + lq = q; + var tm = q.match(tagTokenRe); + if(type == "select"){ + if(tm){ + if(tm[1] == "#"){ + fn[fn.length] = 'n = quickId(n, mode, root, "'+tm[2]+'");'; + }else{ + fn[fn.length] = 'n = getNodes(n, mode, "'+tm[2]+'");'; + } + q = q.replace(tm[0], ""); + }else if(q.substr(0, 1) != '@'){ + fn[fn.length] = 'n = getNodes(n, mode, "*");'; + } + }else{ + if(tm){ + if(tm[1] == "#"){ + fn[fn.length] = 'n = byId(n, null, "'+tm[2]+'");'; + }else{ + fn[fn.length] = 'n = byTag(n, "'+tm[2]+'");'; + } + q = q.replace(tm[0], ""); + } + } + while(!(mm = q.match(modeRe))){ + var matched = false; + for(var j = 0; j < tklen; j++){ + var t = tk[j]; + var m = q.match(t.re); + if(m){ + fn[fn.length] = t.select.replace(tplRe, function(x, i){ + return m[i]; + }); + q = q.replace(m[0], ""); + matched = true; + break; + } + } + // prevent infinite loop on bad selector + if(!matched){ + throw 'Error parsing selector, parsing failed at "' + q + '"'; + } + } + if(mm[1]){ + fn[fn.length] = 'mode="'+mm[1].replace(trimRe, "")+'";'; + q = q.replace(mm[1], ""); + } + } + fn[fn.length] = "return nodup(n);\n}"; + + /** + * list of variables that need from compression as they are used by eval. + * eval:var:batch + * eval:var:nodup + * eval:var:byTag + * eval:var:ById + * eval:var:getNodes + * eval:var:quickId + * eval:var:mode + * eval:var:root + * eval:var:n + * eval:var:byClassName + * eval:var:byPseudo + * eval:var:byAttribute + * eval:var:attrValue + * + **/ + eval(fn.join("")); + return f; + }, + + /** + * Selects a group of elements. + * @param {String} selector The selector/xpath query (can be a comma separated list of selectors) + * @param {Node} root (optional) The start of the query (defaults to document). + * @return {Array} + */ + select : function(path, root, type){ + if(!root || root == document){ + root = document; + } + if(typeof root == "string"){ + root = document.getElementById(root); + } + var paths = path.split(","); + var results = []; + for(var i = 0, len = paths.length; i < len; i++){ + var p = paths[i].replace(trimRe, ""); + if(!cache[p]){ + cache[p] = Roo.DomQuery.compile(p); + if(!cache[p]){ + throw p + " is not a valid selector"; + } + } + var result = cache[p](root); + if(result && result != document){ + results = results.concat(result); + } + } + if(paths.length > 1){ + return nodup(results); + } + return results; + }, + + /** + * Selects a single element. + * @param {String} selector The selector/xpath query + * @param {Node} root (optional) The start of the query (defaults to document). + * @return {Element} + */ + selectNode : function(path, root){ + return Roo.DomQuery.select(path, root)[0]; + }, + + /** + * Selects the value of a node, optionally replacing null with the defaultValue. + * @param {String} selector The selector/xpath query + * @param {Node} root (optional) The start of the query (defaults to document). + * @param {String} defaultValue + */ + selectValue : function(path, root, defaultValue){ + path = path.replace(trimRe, ""); + if(!valueCache[path]){ + valueCache[path] = Roo.DomQuery.compile(path, "select"); + } + var n = valueCache[path](root); + n = n[0] ? n[0] : n; + var v = (n && n.firstChild ? n.firstChild.nodeValue : null); + return ((v === null||v === undefined||v==='') ? defaultValue : v); + }, + + /** + * Selects the value of a node, parsing integers and floats. + * @param {String} selector The selector/xpath query + * @param {Node} root (optional) The start of the query (defaults to document). + * @param {Number} defaultValue + * @return {Number} + */ + selectNumber : function(path, root, defaultValue){ + var v = Roo.DomQuery.selectValue(path, root, defaultValue || 0); + return parseFloat(v); + }, + + /** + * Returns true if the passed element(s) match the passed simple selector (e.g. div.some-class or span:first-child) + * @param {String/HTMLElement/Array} el An element id, element or array of elements + * @param {String} selector The simple selector to test + * @return {Boolean} + */ + is : function(el, ss){ + if(typeof el == "string"){ + el = document.getElementById(el); + } + var isArray = (el instanceof Array); + var result = Roo.DomQuery.filter(isArray ? el : [el], ss); + return isArray ? (result.length == el.length) : (result.length > 0); + }, + + /** + * Filters an array of elements to only include matches of a simple selector (e.g. div.some-class or span:first-child) + * @param {Array} el An array of elements to filter + * @param {String} selector The simple selector to test + * @param {Boolean} nonMatches If true, it returns the elements that DON'T match + * the selector instead of the ones that match + * @return {Array} + */ + filter : function(els, ss, nonMatches){ + ss = ss.replace(trimRe, ""); + if(!simpleCache[ss]){ + simpleCache[ss] = Roo.DomQuery.compile(ss, "simple"); + } + var result = simpleCache[ss](els); + return nonMatches ? quickDiff(result, els) : result; + }, + + /** + * Collection of matching regular expressions and code snippets. + */ + matchers : [{ + re: /^\.([\w-]+)/, + select: 'n = byClassName(n, null, " {1} ");' + }, { + re: /^\:([\w-]+)(?:\(((?:[^\s>\/]*|.*?))\))?/, + select: 'n = byPseudo(n, "{1}", "{2}");' + },{ + re: /^(?:([\[\{])(?:@)?([\w-]+)\s?(?:(=|.=)\s?['"]?(.*?)["']?)?[\]\}])/, + select: 'n = byAttribute(n, "{2}", "{4}", "{3}", "{1}");' + }, { + re: /^#([\w-]+)/, + select: 'n = byId(n, null, "{1}");' + },{ + re: /^@([\w-]+)/, + select: 'return {firstChild:{nodeValue:attrValue(n, "{1}")}};' + } + ], + + /** + * Collection of operator comparison functions. The default operators are =, !=, ^=, $=, *=, %=, |= and ~=. + * New operators can be added as long as the match the format <i>c</i>= where <i>c</i> is any character other than space, &gt; &lt;. + */ + operators : { + "=" : function(a, v){ + return a == v; + }, + "!=" : function(a, v){ + return a != v; + }, + "^=" : function(a, v){ + return a && a.substr(0, v.length) == v; + }, + "$=" : function(a, v){ + return a && a.substr(a.length-v.length) == v; + }, + "*=" : function(a, v){ + return a && a.indexOf(v) !== -1; + }, + "%=" : function(a, v){ + return (a % v) == 0; + }, + "|=" : function(a, v){ + return a && (a == v || a.substr(0, v.length+1) == v+'-'); + }, + "~=" : function(a, v){ + return a && (' '+a+' ').indexOf(' '+v+' ') != -1; + } + }, + + /** + * Collection of "pseudo class" processors. Each processor is passed the current nodeset (array) + * and the argument (if any) supplied in the selector. + */ + pseudos : { + "first-child" : function(c){ + var r = [], ri = -1, n; + for(var i = 0, ci; ci = n = c[i]; i++){ + while((n = n.previousSibling) && n.nodeType != 1); + if(!n){ + r[++ri] = ci; + } + } + return r; + }, + + "last-child" : function(c){ + var r = [], ri = -1, n; + for(var i = 0, ci; ci = n = c[i]; i++){ + while((n = n.nextSibling) && n.nodeType != 1); + if(!n){ + r[++ri] = ci; + } + } + return r; + }, + + "nth-child" : function(c, a) { + var r = [], ri = -1; + var m = nthRe.exec(a == "even" && "2n" || a == "odd" && "2n+1" || !nthRe2.test(a) && "n+" + a || a); + var f = (m[1] || 1) - 0, l = m[2] - 0; + for(var i = 0, n; n = c[i]; i++){ + var pn = n.parentNode; + if (batch != pn._batch) { + var j = 0; + for(var cn = pn.firstChild; cn; cn = cn.nextSibling){ + if(cn.nodeType == 1){ + cn.nodeIndex = ++j; + } + } + pn._batch = batch; + } + if (f == 1) { + if (l == 0 || n.nodeIndex == l){ + r[++ri] = n; + } + } else if ((n.nodeIndex + l) % f == 0){ + r[++ri] = n; + } + } + + return r; + }, + + "only-child" : function(c){ + var r = [], ri = -1;; + for(var i = 0, ci; ci = c[i]; i++){ + if(!prev(ci) && !next(ci)){ + r[++ri] = ci; + } + } + return r; + }, + + "empty" : function(c){ + var r = [], ri = -1; + for(var i = 0, ci; ci = c[i]; i++){ + var cns = ci.childNodes, j = 0, cn, empty = true; + while(cn = cns[j]){ + ++j; + if(cn.nodeType == 1 || cn.nodeType == 3){ + empty = false; + break; + } + } + if(empty){ + r[++ri] = ci; + } + } + return r; + }, + + "contains" : function(c, v){ + var r = [], ri = -1; + for(var i = 0, ci; ci = c[i]; i++){ + if((ci.textContent||ci.innerText||'').indexOf(v) != -1){ + r[++ri] = ci; + } + } + return r; + }, + + "nodeValue" : function(c, v){ + var r = [], ri = -1; + for(var i = 0, ci; ci = c[i]; i++){ + if(ci.firstChild && ci.firstChild.nodeValue == v){ + r[++ri] = ci; + } + } + return r; + }, + + "checked" : function(c){ + var r = [], ri = -1; + for(var i = 0, ci; ci = c[i]; i++){ + if(ci.checked == true){ + r[++ri] = ci; + } + } + return r; + }, + + "not" : function(c, ss){ + return Roo.DomQuery.filter(c, ss, true); + }, + + "odd" : function(c){ + return this["nth-child"](c, "odd"); + }, + + "even" : function(c){ + return this["nth-child"](c, "even"); + }, + + "nth" : function(c, a){ + return c[a-1] || []; + }, + + "first" : function(c){ + return c[0] || []; + }, + + "last" : function(c){ + return c[c.length-1] || []; + }, + + "has" : function(c, ss){ + var s = Roo.DomQuery.select; + var r = [], ri = -1; + for(var i = 0, ci; ci = c[i]; i++){ + if(s(ss, ci).length > 0){ + r[++ri] = ci; + } + } + return r; + }, + + "next" : function(c, ss){ + var is = Roo.DomQuery.is; + var r = [], ri = -1; + for(var i = 0, ci; ci = c[i]; i++){ + var n = next(ci); + if(n && is(n, ss)){ + r[++ri] = ci; + } + } + return r; + }, + + "prev" : function(c, ss){ + var is = Roo.DomQuery.is; + var r = [], ri = -1; + for(var i = 0, ci; ci = c[i]; i++){ + var n = prev(ci); + if(n && is(n, ss)){ + r[++ri] = ci; + } + } + return r; + } + } + }; +}(); + +/** + * Selects an array of DOM nodes by CSS/XPath selector. Shorthand of {@link Roo.DomQuery#select} + * @param {String} path The selector/xpath query + * @param {Node} root (optional) The start of the query (defaults to document). + * @return {Array} + * @member Roo + * @method query + */ +Roo.query = Roo.DomQuery.select; + \ No newline at end of file diff --git a/docs2/src/Roo_DomTemplate.js.html b/docs2/src/Roo_DomTemplate.js.html new file mode 100644 index 0000000000..331ec4f3c8 --- /dev/null +++ b/docs2/src/Roo_DomTemplate.js.html @@ -0,0 +1,456 @@ +/home/alan/gitlive/roojs1/Roo/DomTemplate.js/* + * Based on: + * Roo JS + * (c)) Alan Knowles + * Licence : LGPL + */ + + +/** + * @class Roo.DomTemplate + * @extends Roo.Template + * An effort at a dom based template engine.. + * + * Similar to XTemplate, except it uses dom parsing to create the template.. + * + * Supported features: + * + * Tags: + +<pre><code> + {a_variable} - output encoded. + {a_variable.format:("Y-m-d")} - call a method on the variable + {a_variable:raw} - unencoded output + {a_variable:toFixed(1,2)} - Roo.util.Format."toFixed" + {a_variable:this.method_on_template(...)} - call a method on the template object. + +</code></pre> + * The tpl tag: +<pre><code> + &lt;div roo-for="a_variable or condition.."&gt;&lt;/div&gt; + &lt;div roo-if="a_variable or condition"&gt;&lt;/div&gt; + &lt;div roo-exec="some javascript"&gt;&lt;/div&gt; + &lt;div roo-name="named_template"&gt;&lt;/div&gt; + +</code></pre> + * + */ +Roo.DomTemplate = function() +{ + Roo.DomTemplate.superclass.constructor.apply(this, arguments); + if (this.html) { + this.compile(); + } +}; + + +Roo.extend(Roo.DomTemplate, Roo.Template, { + /** + * id counter for sub templates. + */ + id : 0, + /** + * flag to indicate if dom parser is inside a pre, + * it will strip whitespace if not. + */ + inPre : false, + + /** + * The various sub templates + */ + tpls : false, + + + + /** + * + * basic tag replacing syntax + * WORD:WORD() + * + * // you can fake an object call by doing this + * x.t:(test,tesT) + * + */ + re : /(\{|\%7B)([\w-\.]+)(?:\:([\w\.]*)(?:\(([^)]*?)?\))?)?(\}|\%7D)/g, + //re : /\{([\w-\.]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?\}/g, + + iterChild : function (node, method) { + + var oldPre = this.inPre; + if (node.tagName == 'PRE') { + this.inPre = true; + } + for( var i = 0; i < node.childNodes.length; i++) { + method.call(this, node.childNodes[i]); + } + this.inPre = oldPre; + }, + + + + /** + * compile the template + * + * This is not recursive, so I'm not sure how nested templates are really going to be handled.. + * + */ + compile: function() + { + var s = this.html; + + // covert the html into DOM... + var doc = false; + var div =false; + try { + doc = document.implementation.createHTMLDocument(""); + doc.documentElement.innerHTML = this.html ; + div = doc.documentElement; + } catch (e) { + // old IE... - nasty -- it causes all sorts of issues.. with + // images getting pulled from server.. + div = document.createElement('div'); + div.innerHTML = this.html; + } + //doc.documentElement.innerHTML = htmlBody + + + + this.tpls = []; + var _t = this; + this.iterChild(div, function(n) {_t.compileNode(n, true); }); + + var tpls = this.tpls; + + // create a top level template from the snippet.. + + //Roo.log(div.innerHTML); + + var tpl = { + uid : 'master', + id : this.id++, + attr : false, + value : false, + body : div.innerHTML, + + forCall : false, + execCall : false, + dom : div, + isTop : true + + }; + tpls.unshift(tpl); + + + // compile them... + this.tpls = []; + Roo.each(tpls, function(tp){ + this.compileTpl(tp); + this.tpls[tp.id] = tp; + }, this); + + this.master = tpls[0]; + return this; + + + }, + + compileNode : function(node, istop) { + // test for + //Roo.log(node); + + + // skip anything not a tag.. + if (node.nodeType != 1) { + if (node.nodeType == 3 && !this.inPre) { + // reduce white space.. + node.nodeValue = node.nodeValue.replace(/\s+/g, ' '); + + } + return; + } + + var tpl = { + uid : false, + id : false, + attr : false, + value : false, + body : '', + + forCall : false, + execCall : false, + dom : false, + isTop : istop + + + }; + + + switch(true) { + case (node.hasAttribute('roo-for')): tpl.attr = 'for'; break; + case (node.hasAttribute('roo-if')): tpl.attr = 'if'; break; + case (node.hasAttribute('roo-name')): tpl.attr = 'name'; break; + case (node.hasAttribute('roo-exec')): tpl.attr = 'exec'; break; + // no default.. + } + + + if (!tpl.attr) { + // just itterate children.. + this.iterChild(node,this.compileNode); + return; + } + tpl.uid = this.id++; + tpl.value = node.getAttribute('roo-' + tpl.attr); + node.removeAttribute('roo-'+ tpl.attr); + if (tpl.attr != 'name') { + var placeholder = document.createTextNode('{domtpl' + tpl.uid + '}'); + node.parentNode.replaceChild(placeholder, node); + } else { + + var placeholder = document.createElement('span'); + placeholder.className = 'roo-tpl-' + tpl.value; + node.parentNode.replaceChild(placeholder, node); + } + + // parent now sees '{domtplXXXX} + this.iterChild(node,this.compileNode); + + // we should now have node body... + var div = document.createElement('div'); + div.appendChild(node); + tpl.dom = node; + // this has the unfortunate side effect of converting tagged attributes + // eg. href="{...}" into %7C...%7D + // this has been fixed by searching for those combo's although it's a bit hacky.. + + + tpl.body = div.innerHTML; + + + + tpl.id = tpl.uid; + switch(tpl.attr) { + case 'for' : + switch (tpl.value) { + case '.': tpl.forCall = new Function('values', 'parent', 'with(values){ return values; }'); break; + case '..': tpl.forCall= new Function('values', 'parent', 'with(values){ return parent; }'); break; + default: tpl.forCall= new Function('values', 'parent', 'with(values){ return '+tpl.value+'; }'); + } + break; + + case 'exec': + tpl.execCall = new Function('values', 'parent', 'with(values){ '+(Roo.util.Format.htmlDecode(tpl.value))+'; }'); + break; + + case 'if': + tpl.ifCall = new Function('values', 'parent', 'with(values){ return '+(Roo.util.Format.htmlDecode(tpl.value))+'; }'); + break; + + case 'name': + tpl.id = tpl.value; // replace non characters??? + break; + + } + + + this.tpls.push(tpl); + + + + }, + + + + + /** + * Compile a segment of the template into a 'sub-template' + * + * + * + * + */ + compileTpl : function(tpl) + { + var fm = Roo.util.Format; + var useF = this.disableFormats !== true; + + var sep = Roo.isGecko ? "+\n" : ",\n"; + + var undef = function(str) { + Roo.debug && Roo.log("Property not found :" + str); + return ''; + }; + + //Roo.log(tpl.body); + + + + var fn = function(m, lbrace, name, format, args) + { + //Roo.log("ARGS"); + //Roo.log(arguments); + args = args ? args.replace(/\\'/g,"'") : args; + //["{TEST:(a,b,c)}", "TEST", "", "a,b,c", 0, "{TEST:(a,b,c)}"] + if (typeof(format) == 'undefined') { + format = 'htmlEncode'; + } + if (format == 'raw' ) { + format = false; + } + + if(name.substr(0, 6) == 'domtpl'){ + return "'"+ sep +'this.applySubTemplate('+name.substr(6)+', values, parent)'+sep+"'"; + } + + // build an array of options to determine if value is undefined.. + + // basically get 'xxxx.yyyy' then do + // (typeof(xxxx) == 'undefined' || typeof(xxx.yyyy) == 'undefined') ? + // (function () { Roo.log("Property not found"); return ''; })() : + // ...... + + var udef_ar = []; + var lookfor = ''; + Roo.each(name.split('.'), function(st) { + lookfor += (lookfor.length ? '.': '') + st; + udef_ar.push( "(typeof(" + lookfor + ") == 'undefined')" ); + }); + + var udef_st = '((' + udef_ar.join(" || ") +") ? undef('" + name + "') : "; // .. needs ) + + + if(format && useF){ + + args = args ? ',' + args : ""; + + if(format.substr(0, 5) != "this."){ + format = "fm." + format + '('; + }else{ + format = 'this.call("'+ format.substr(5) + '", '; + args = ", values"; + } + + return "'"+ sep + udef_st + format + name + args + "))"+sep+"'"; + } + + if (args && args.length) { + // called with xxyx.yuu:(test,test) + // change to () + return "'"+ sep + udef_st + name + '(' + args + "))"+sep+"'"; + } + // raw.. - :raw modifier.. + return "'"+ sep + udef_st + name + ")"+sep+"'"; + + }; + var body; + // branched to use + in gecko and [].join() in others + if(Roo.isGecko){ + body = "tpl.compiled = function(values, parent){ with(values) { return '" + + tpl.body.replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn) + + "';};};"; + }else{ + body = ["tpl.compiled = function(values, parent){ with (values) { return ['"]; + body.push(tpl.body.replace(/(\r\n|\n)/g, + '\\n').replace(/'/g, "\\'").replace(this.re, fn)); + body.push("'].join('');};};"); + body = body.join(''); + } + + Roo.debug && Roo.log(body.replace(/\\n/,'\n')); + + /** eval:var:tpl eval:var:fm eval:var:useF eval:var:undef */ + eval(body); + + return this; + }, + + /** + * same as applyTemplate, except it's done to one of the subTemplates + * when using named templates, you can do: + * + * var str = pl.applySubTemplate('your-name', values); + * + * + * @param {Number} id of the template + * @param {Object} values to apply to template + * @param {Object} parent (normaly the instance of this object) + */ + applySubTemplate : function(id, values, parent) + { + + + var t = this.tpls[id]; + + + try { + if(t.ifCall && !t.ifCall.call(this, values, parent)){ + Roo.debug && Roo.log('if call on ' + t.value + ' return false'); + return ''; + } + } catch(e) { + Roo.log('Xtemplate.applySubTemplate('+ id+ '): Exception thrown on roo-if="' + t.value + '" - ' + e.toString()); + Roo.log(values); + + return ''; + } + try { + + if(t.execCall && t.execCall.call(this, values, parent)){ + return ''; + } + } catch(e) { + Roo.log('Xtemplate.applySubTemplate('+ id+ '): Exception thrown on roo-for="' + t.value + '" - ' + e.toString()); + Roo.log(values); + return ''; + } + + try { + var vs = t.forCall ? t.forCall.call(this, values, parent) : values; + parent = t.target ? values : parent; + if(t.forCall && vs instanceof Array){ + var buf = []; + for(var i = 0, len = vs.length; i < len; i++){ + try { + buf[buf.length] = t.compiled.call(this, vs[i], parent); + } catch (e) { + Roo.log('Xtemplate.applySubTemplate('+ id+ '): Exception thrown on body="' + t.value + '" - ' + e.toString()); + Roo.log(e.body); + //Roo.log(t.compiled); + Roo.log(vs[i]); + } + } + return buf.join(''); + } + } catch (e) { + Roo.log('Xtemplate.applySubTemplate('+ id+ '): Exception thrown on roo-for="' + t.value + '" - ' + e.toString()); + Roo.log(values); + return ''; + } + try { + return t.compiled.call(this, vs, parent); + } catch (e) { + Roo.log('Xtemplate.applySubTemplate('+ id+ '): Exception thrown on body="' + t.value + '" - ' + e.toString()); + Roo.log(e.body); + //Roo.log(t.compiled); + Roo.log(values); + return ''; + } + }, + + + + applyTemplate : function(values){ + return this.master.compiled.call(this, values, {}); + //var s = this.subs; + }, + + apply : function(){ + return this.applyTemplate.apply(this, arguments); + } + + }); + +Roo.DomTemplate.from = function(el){ + el = Roo.getDom(el); + return new Roo.Domtemplate(el.value || el.innerHTML); +}; \ No newline at end of file diff --git a/docs2/src/Roo_Editor.js.html b/docs2/src/Roo_Editor.js.html new file mode 100644 index 0000000000..4104a0fc59 --- /dev/null +++ b/docs2/src/Roo_Editor.js.html @@ -0,0 +1,342 @@ +/home/alan/gitlive/roojs1/Roo/Editor.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.Editor + * @extends Roo.Component + * A base editor field that handles displaying/hiding on demand and has some built-in sizing and event handling logic. + * @constructor + * Create a new Editor + * @param {Roo.form.Field} field The Field object (or descendant) + * @param {Object} config The config object + */ +Roo.Editor = function(field, config){ + Roo.Editor.superclass.constructor.call(this, config); + this.field = field; + this.addEvents({ + /** + * @event beforestartedit + * Fires when editing is initiated, but before the value changes. Editing can be canceled by returning + * false from the handler of this event. + * @param {Editor} this + * @param {Roo.Element} boundEl The underlying element bound to this editor + * @param {Mixed} value The field value being set + */ + "beforestartedit" : true, + /** + * @event startedit + * Fires when this editor is displayed + * @param {Roo.Element} boundEl The underlying element bound to this editor + * @param {Mixed} value The starting field value + */ + "startedit" : true, + /** + * @event beforecomplete + * Fires after a change has been made to the field, but before the change is reflected in the underlying + * field. Saving the change to the field can be canceled by returning false from the handler of this event. + * Note that if the value has not changed and ignoreNoChange = true, the editing will still end but this + * event will not fire since no edit actually occurred. + * @param {Editor} this + * @param {Mixed} value The current field value + * @param {Mixed} startValue The original field value + */ + "beforecomplete" : true, + /** + * @event complete + * Fires after editing is complete and any changed value has been written to the underlying field. + * @param {Editor} this + * @param {Mixed} value The current field value + * @param {Mixed} startValue The original field value + */ + "complete" : true, + /** + * @event specialkey + * Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check + * {@link Roo.EventObject#getKey} to determine which key was pressed. + * @param {Roo.form.Field} this + * @param {Roo.EventObject} e The event object + */ + "specialkey" : true + }); +}; + +Roo.extend(Roo.Editor, Roo.Component, { + /** + * @cfg {Boolean/String} autosize + * True for the editor to automatically adopt the size of the underlying field, "width" to adopt the width only, + * or "height" to adopt the height only (defaults to false) + */ + /** + * @cfg {Boolean} revertInvalid + * True to automatically revert the field value and cancel the edit when the user completes an edit and the field + * validation fails (defaults to true) + */ + /** + * @cfg {Boolean} ignoreNoChange + * True to skip the the edit completion process (no save, no events fired) if the user completes an edit and + * the value has not changed (defaults to false). Applies only to string values - edits for other data types + * will never be ignored. + */ + /** + * @cfg {Boolean} hideEl + * False to keep the bound element visible while the editor is displayed (defaults to true) + */ + /** + * @cfg {Mixed} value + * The data value of the underlying field (defaults to "") + */ + value : "", + /** + * @cfg {String} alignment + * The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to "c-c?"). + */ + alignment: "c-c?", + /** + * @cfg {Boolean/String} shadow "sides" for sides/bottom only, "frame" for 4-way shadow, and "drop" + * for bottom-right shadow (defaults to "frame") + */ + shadow : "frame", + /** + * @cfg {Boolean} constrain True to constrain the editor to the viewport + */ + constrain : false, + /** + * @cfg {Boolean} completeOnEnter True to complete the edit when the enter key is pressed (defaults to false) + */ + completeOnEnter : false, + /** + * @cfg {Boolean} cancelOnEsc True to cancel the edit when the escape key is pressed (defaults to false) + */ + cancelOnEsc : false, + /** + * @cfg {Boolean} updateEl True to update the innerHTML of the bound element when the update completes (defaults to false) + */ + updateEl : false, + + // private + onRender : function(ct, position){ + this.el = new Roo.Layer({ + shadow: this.shadow, + cls: "x-editor", + parentEl : ct, + shim : this.shim, + shadowOffset:4, + id: this.id, + constrain: this.constrain + }); + this.el.setStyle("overflow", Roo.isGecko ? "auto" : "hidden"); + if(this.field.msgTarget != 'title'){ + this.field.msgTarget = 'qtip'; + } + this.field.render(this.el); + if(Roo.isGecko){ + this.field.el.dom.setAttribute('autocomplete', 'off'); + } + this.field.on("specialkey", this.onSpecialKey, this); + if(this.swallowKeys){ + this.field.el.swallowEvent(['keydown','keypress']); + } + this.field.show(); + this.field.on("blur", this.onBlur, this); + if(this.field.grow){ + this.field.on("autosize", this.el.sync, this.el, {delay:1}); + } + }, + + onSpecialKey : function(field, e) + { + //Roo.log('editor onSpecialKey'); + if(this.completeOnEnter && e.getKey() == e.ENTER){ + e.stopEvent(); + this.completeEdit(); + return; + } + // do not fire special key otherwise it might hide close the editor... + if(e.getKey() == e.ENTER){ + return; + } + if(this.cancelOnEsc && e.getKey() == e.ESC){ + this.cancelEdit(); + return; + } + this.fireEvent('specialkey', field, e); + + }, + + /** + * Starts the editing process and shows the editor. + * @param {String/HTMLElement/Element} el The element to edit + * @param {String} value (optional) A value to initialize the editor with. If a value is not provided, it defaults + * to the innerHTML of el. + */ + startEdit : function(el, value){ + if(this.editing){ + this.completeEdit(); + } + this.boundEl = Roo.get(el); + var v = value !== undefined ? value : this.boundEl.dom.innerHTML; + if(!this.rendered){ + this.render(this.parentEl || document.body); + } + if(this.fireEvent("beforestartedit", this, this.boundEl, v) === false){ + return; + } + this.startValue = v; + this.field.setValue(v); + if(this.autoSize){ + var sz = this.boundEl.getSize(); + switch(this.autoSize){ + case "width": + this.setSize(sz.width, ""); + break; + case "height": + this.setSize("", sz.height); + break; + default: + this.setSize(sz.width, sz.height); + } + } + this.el.alignTo(this.boundEl, this.alignment); + this.editing = true; + if(Roo.QuickTips){ + Roo.QuickTips.disable(); + } + this.show(); + }, + + /** + * Sets the height and width of this editor. + * @param {Number} width The new width + * @param {Number} height The new height + */ + setSize : function(w, h){ + this.field.setSize(w, h); + if(this.el){ + this.el.sync(); + } + }, + + /** + * Realigns the editor to the bound field based on the current alignment config value. + */ + realign : function(){ + this.el.alignTo(this.boundEl, this.alignment); + }, + + /** + * Ends the editing process, persists the changed value to the underlying field, and hides the editor. + * @param {Boolean} remainVisible Override the default behavior and keep the editor visible after edit (defaults to false) + */ + completeEdit : function(remainVisible){ + if(!this.editing){ + return; + } + var v = this.getValue(); + if(this.revertInvalid !== false && !this.field.isValid()){ + v = this.startValue; + this.cancelEdit(true); + } + if(String(v) === String(this.startValue) && this.ignoreNoChange){ + this.editing = false; + this.hide(); + return; + } + if(this.fireEvent("beforecomplete", this, v, this.startValue) !== false){ + this.editing = false; + if(this.updateEl && this.boundEl){ + this.boundEl.update(v); + } + if(remainVisible !== true){ + this.hide(); + } + this.fireEvent("complete", this, v, this.startValue); + } + }, + + // private + onShow : function(){ + this.el.show(); + if(this.hideEl !== false){ + this.boundEl.hide(); + } + this.field.show(); + if(Roo.isIE && !this.fixIEFocus){ // IE has problems with focusing the first time + this.fixIEFocus = true; + this.deferredFocus.defer(50, this); + }else{ + this.field.focus(); + } + this.fireEvent("startedit", this.boundEl, this.startValue); + }, + + deferredFocus : function(){ + if(this.editing){ + this.field.focus(); + } + }, + + /** + * Cancels the editing process and hides the editor without persisting any changes. The field value will be + * reverted to the original starting value. + * @param {Boolean} remainVisible Override the default behavior and keep the editor visible after + * cancel (defaults to false) + */ + cancelEdit : function(remainVisible){ + if(this.editing){ + this.setValue(this.startValue); + if(remainVisible !== true){ + this.hide(); + } + } + }, + + // private + onBlur : function(){ + if(this.allowBlur !== true && this.editing){ + this.completeEdit(); + } + }, + + // private + onHide : function(){ + if(this.editing){ + this.completeEdit(); + return; + } + this.field.blur(); + if(this.field.collapse){ + this.field.collapse(); + } + this.el.hide(); + if(this.hideEl !== false){ + this.boundEl.show(); + } + if(Roo.QuickTips){ + Roo.QuickTips.enable(); + } + }, + + /** + * Sets the data value of the editor + * @param {Mixed} value Any valid value supported by the underlying field + */ + setValue : function(v){ + this.field.setValue(v); + }, + + /** + * Gets the data value of the editor + * @return {Mixed} The data value + */ + getValue : function(){ + return this.field.getValue(); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_Element.js.html b/docs2/src/Roo_Element.js.html new file mode 100644 index 0000000000..3b52fa4fce --- /dev/null +++ b/docs2/src/Roo_Element.js.html @@ -0,0 +1,3081 @@ +/home/alan/gitlive/roojs1/Roo/Element.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +// was in Composite Element!??!?! + +(function(){ + var D = Roo.lib.Dom; + var E = Roo.lib.Event; + var A = Roo.lib.Anim; + + // local style camelizing for speed + var propCache = {}; + var camelRe = /(-[a-z])/gi; + var camelFn = function(m, a){ return a.charAt(1).toUpperCase(); }; + var view = document.defaultView; + +/** + * @class Roo.Element + * Represents an Element in the DOM.<br><br> + * Usage:<br> +<pre><code> +var el = Roo.get("my-div"); + +// or with getEl +var el = getEl("my-div"); + +// or with a DOM element +var el = Roo.get(myDivElement); +</code></pre> + * Using Roo.get() or getEl() instead of calling the constructor directly ensures you get the same object + * each call instead of constructing a new one.<br><br> + * <b>Animations</b><br /> + * Many of the functions for manipulating an element have an optional "animate" parameter. The animate parameter + * should either be a boolean (true) or an object literal with animation options. The animation options are: +<pre> +Option Default Description +--------- -------- --------------------------------------------- +duration .35 The duration of the animation in seconds +easing easeOut The YUI easing method +callback none A function to execute when the anim completes +scope this The scope (this) of the callback function +</pre> +* Also, the Anim object being used for the animation will be set on your options object as "anim", which allows you to stop or +* manipulate the animation. Here's an example: +<pre><code> +var el = Roo.get("my-div"); + +// no animation +el.setWidth(100); + +// default animation +el.setWidth(100, true); + +// animation with some options set +el.setWidth(100, { + duration: 1, + callback: this.foo, + scope: this +}); + +// using the "anim" property to get the Anim object +var opt = { + duration: 1, + callback: this.foo, + scope: this +}; +el.setWidth(100, opt); +... +if(opt.anim.isAnimated()){ + opt.anim.stop(); +} +</code></pre> +* <b> Composite (Collections of) Elements</b><br /> + * For working with collections of Elements, see <a href="Roo.CompositeElement.html">Roo.CompositeElement</a> + * @constructor Create a new Element directly. + * @param {String/HTMLElement} element + * @param {Boolean} forceNew (optional) By default the constructor checks to see if there is already an instance of this element in the cache and if there is it returns the same instance. This will skip that check (useful for extending this class). + */ + Roo.Element = function(element, forceNew){ + var dom = typeof element == "string" ? + document.getElementById(element) : element; + if(!dom){ // invalid id/element + return null; + } + var id = dom.id; + if(forceNew !== true && id && Roo.Element.cache[id]){ // element object already exists + return Roo.Element.cache[id]; + } + + /** + * The DOM element + * @type HTMLElement + */ + this.dom = dom; + + /** + * The DOM element ID + * @type String + */ + this.id = id || Roo.id(dom); + }; + + var El = Roo.Element; + + El.prototype = { + /** + * The element's default display mode (defaults to "") + * @type String + */ + originalDisplay : "", + + visibilityMode : 1, + /** + * The default unit to append to CSS values where a unit isn't provided (defaults to px). + * @type String + */ + defaultUnit : "px", + + /** + * Sets the element's visibility mode. When setVisible() is called it + * will use this to determine whether to set the visibility or the display property. + * @param visMode Element.VISIBILITY or Element.DISPLAY + * @return {Roo.Element} this + */ + setVisibilityMode : function(visMode){ + this.visibilityMode = visMode; + return this; + }, + /** + * Convenience method for setVisibilityMode(Element.DISPLAY) + * @param {String} display (optional) What to set display to when visible + * @return {Roo.Element} this + */ + enableDisplayMode : function(display){ + this.setVisibilityMode(El.DISPLAY); + if(typeof display != "undefined") { this.originalDisplay = display; } + return this; + }, + + /** + * Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child) + * @param {String} selector The simple selector to test + * @param {Number/String/HTMLElement/Element} maxDepth (optional) The max depth to + search as a number or element (defaults to 10 || document.body) + * @param {Boolean} returnEl (optional) True to return a Roo.Element object instead of DOM node + * @return {HTMLElement} The matching DOM node (or null if no match was found) + */ + findParent : function(simpleSelector, maxDepth, returnEl){ + var p = this.dom, b = document.body, depth = 0, dq = Roo.DomQuery, stopEl; + maxDepth = maxDepth || 50; + if(typeof maxDepth != "number"){ + stopEl = Roo.getDom(maxDepth); + maxDepth = 10; + } + while(p && p.nodeType == 1 && depth < maxDepth && p != b && p != stopEl){ + if(dq.is(p, simpleSelector)){ + return returnEl ? Roo.get(p) : p; + } + depth++; + p = p.parentNode; + } + return null; + }, + + + /** + * Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child) + * @param {String} selector The simple selector to test + * @param {Number/String/HTMLElement/Element} maxDepth (optional) The max depth to + search as a number or element (defaults to 10 || document.body) + * @param {Boolean} returnEl (optional) True to return a Roo.Element object instead of DOM node + * @return {HTMLElement} The matching DOM node (or null if no match was found) + */ + findParentNode : function(simpleSelector, maxDepth, returnEl){ + var p = Roo.fly(this.dom.parentNode, '_internal'); + return p ? p.findParent(simpleSelector, maxDepth, returnEl) : null; + }, + + /** + * Looks at the scrollable parent element + */ + findScrollableParent : function() + { + var overflowRegex = /(auto|scroll)/; + + if(this.getStyle('position') === 'fixed'){ + return Roo.isAndroid ? Roo.get(document.documentElement) : Roo.get(document.body); + } + + var excludeStaticParent = this.getStyle('position') === "absolute"; + + for (var parent = this; (parent = Roo.get(parent.dom.parentNode));){ + + if (excludeStaticParent && parent.getStyle('position') === "static") { + continue; + } + + if (overflowRegex.test(parent.getStyle('overflow') + parent.getStyle('overflow-x') + parent.getStyle('overflow-y'))){ + return parent; + } + + if(parent.dom.nodeName.toLowerCase() == 'body'){ + return Roo.isAndroid ? Roo.get(document.documentElement) : Roo.get(document.body); + } + } + + return Roo.isAndroid ? Roo.get(document.documentElement) : Roo.get(document.body); + }, + + /** + * Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child). + * This is a shortcut for findParentNode() that always returns an Roo.Element. + * @param {String} selector The simple selector to test + * @param {Number/String/HTMLElement/Element} maxDepth (optional) The max depth to + search as a number or element (defaults to 10 || document.body) + * @return {Roo.Element} The matching DOM node (or null if no match was found) + */ + up : function(simpleSelector, maxDepth){ + return this.findParentNode(simpleSelector, maxDepth, true); + }, + + + + /** + * Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child) + * @param {String} selector The simple selector to test + * @return {Boolean} True if this element matches the selector, else false + */ + is : function(simpleSelector){ + return Roo.DomQuery.is(this.dom, simpleSelector); + }, + + /** + * Perform animation on this element. + * @param {Object} args The YUI animation control args + * @param {Float} duration (optional) How long the animation lasts in seconds (defaults to .35) + * @param {Function} onComplete (optional) Function to call when animation completes + * @param {String} easing (optional) Easing method to use (defaults to 'easeOut') + * @param {String} animType (optional) 'run' is the default. Can also be 'color', 'motion', or 'scroll' + * @return {Roo.Element} this + */ + animate : function(args, duration, onComplete, easing, animType){ + this.anim(args, {duration: duration, callback: onComplete, easing: easing}, animType); + return this; + }, + + /* + * @private Internal animation call + */ + anim : function(args, opt, animType, defaultDur, defaultEase, cb){ + animType = animType || 'run'; + opt = opt || {}; + var anim = Roo.lib.Anim[animType]( + this.dom, args, + (opt.duration || defaultDur) || .35, + (opt.easing || defaultEase) || 'easeOut', + function(){ + Roo.callback(cb, this); + Roo.callback(opt.callback, opt.scope || this, [this, opt]); + }, + this + ); + opt.anim = anim; + return anim; + }, + + // private legacy anim prep + preanim : function(a, i){ + return !a[i] ? false : (typeof a[i] == "object" ? a[i]: {duration: a[i+1], callback: a[i+2], easing: a[i+3]}); + }, + + /** + * Removes worthless text nodes + * @param {Boolean} forceReclean (optional) By default the element + * keeps track if it has been cleaned already so + * you can call this over and over. However, if you update the element and + * need to force a reclean, you can pass true. + */ + clean : function(forceReclean){ + if(this.isCleaned && forceReclean !== true){ + return this; + } + var ns = /\S/; + var d = this.dom, n = d.firstChild, ni = -1; + while(n){ + var nx = n.nextSibling; + if(n.nodeType == 3 && !ns.test(n.nodeValue)){ + d.removeChild(n); + }else{ + n.nodeIndex = ++ni; + } + n = nx; + } + this.isCleaned = true; + return this; + }, + + // private + calcOffsetsTo : function(el){ + el = Roo.get(el); + var d = el.dom; + var restorePos = false; + if(el.getStyle('position') == 'static'){ + el.position('relative'); + restorePos = true; + } + var x = 0, y =0; + var op = this.dom; + while(op && op != d && op.tagName != 'HTML'){ + x+= op.offsetLeft; + y+= op.offsetTop; + op = op.offsetParent; + } + if(restorePos){ + el.position('static'); + } + return [x, y]; + }, + + /** + * Scrolls this element into view within the passed container. + * @param {String/HTMLElement/Element} container (optional) The container element to scroll (defaults to document.body) + * @param {Boolean} hscroll (optional) False to disable horizontal scroll (defaults to true) + * @return {Roo.Element} this + */ + scrollIntoView : function(container, hscroll){ + var c = Roo.getDom(container) || document.body; + var el = this.dom; + + var o = this.calcOffsetsTo(c), + l = o[0], + t = o[1], + b = t+el.offsetHeight, + r = l+el.offsetWidth; + + var ch = c.clientHeight; + var ct = parseInt(c.scrollTop, 10); + var cl = parseInt(c.scrollLeft, 10); + var cb = ct + ch; + var cr = cl + c.clientWidth; + + if(t < ct){ + c.scrollTop = t; + }else if(b > cb){ + c.scrollTop = b-ch; + } + + if(hscroll !== false){ + if(l < cl){ + c.scrollLeft = l; + }else if(r > cr){ + c.scrollLeft = r-c.clientWidth; + } + } + return this; + }, + + // private + scrollChildIntoView : function(child, hscroll){ + Roo.fly(child, '_scrollChildIntoView').scrollIntoView(this, hscroll); + }, + + /** + * Measures the element's content height and updates height to match. Note: this function uses setTimeout so + * the new height may not be available immediately. + * @param {Boolean} animate (optional) Animate the transition (defaults to false) + * @param {Float} duration (optional) Length of the animation in seconds (defaults to .35) + * @param {Function} onComplete (optional) Function to call when animation completes + * @param {String} easing (optional) Easing method to use (defaults to easeOut) + * @return {Roo.Element} this + */ + autoHeight : function(animate, duration, onComplete, easing){ + var oldHeight = this.getHeight(); + this.clip(); + this.setHeight(1); // force clipping + setTimeout(function(){ + var height = parseInt(this.dom.scrollHeight, 10); // parseInt for Safari + if(!animate){ + this.setHeight(height); + this.unclip(); + if(typeof onComplete == "function"){ + onComplete(); + } + }else{ + this.setHeight(oldHeight); // restore original height + this.setHeight(height, animate, duration, function(){ + this.unclip(); + if(typeof onComplete == "function") { onComplete(); } + }.createDelegate(this), easing); + } + }.createDelegate(this), 0); + return this; + }, + + /** + * Returns true if this element is an ancestor of the passed element + * @param {HTMLElement/String} el The element to check + * @return {Boolean} True if this element is an ancestor of el, else false + */ + contains : function(el){ + if(!el){return false;} + return D.isAncestor(this.dom, el.dom ? el.dom : el); + }, + + /** + * Checks whether the element is currently visible using both visibility and display properties. + * @param {Boolean} deep (optional) True to walk the dom and see if parent elements are hidden (defaults to false) + * @return {Boolean} True if the element is currently visible, else false + */ + isVisible : function(deep) { + var vis = !(this.getStyle("visibility") == "hidden" || this.getStyle("display") == "none"); + if(deep !== true || !vis){ + return vis; + } + var p = this.dom.parentNode; + while(p && p.tagName.toLowerCase() != "body"){ + if(!Roo.fly(p, '_isVisible').isVisible()){ + return false; + } + p = p.parentNode; + } + return true; + }, + + /** + * Creates a {@link Roo.CompositeElement} for child nodes based on the passed CSS selector (the selector should not contain an id). + * @param {String} selector The CSS selector + * @param {Boolean} unique (optional) True to create a unique Roo.Element for each child (defaults to false, which creates a single shared flyweight object) + * @return {CompositeElement/CompositeElementLite} The composite element + */ + select : function(selector, unique){ + return El.select(selector, unique, this.dom); + }, + + /** + * Selects child nodes based on the passed CSS selector (the selector should not contain an id). + * @param {String} selector The CSS selector + * @return {Array} An array of the matched nodes + */ + query : function(selector, unique){ + return Roo.DomQuery.select(selector, this.dom); + }, + + /** + * Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id). + * @param {String} selector The CSS selector + * @param {Boolean} returnDom (optional) True to return the DOM node instead of Roo.Element (defaults to false) + * @return {HTMLElement/Roo.Element} The child Roo.Element (or DOM node if returnDom = true) + */ + child : function(selector, returnDom){ + var n = Roo.DomQuery.selectNode(selector, this.dom); + return returnDom ? n : Roo.get(n); + }, + + /** + * Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id). + * @param {String} selector The CSS selector + * @param {Boolean} returnDom (optional) True to return the DOM node instead of Roo.Element (defaults to false) + * @return {HTMLElement/Roo.Element} The child Roo.Element (or DOM node if returnDom = true) + */ + down : function(selector, returnDom){ + var n = Roo.DomQuery.selectNode(" > " + selector, this.dom); + return returnDom ? n : Roo.get(n); + }, + + /** + * Initializes a {@link Roo.dd.DD} drag drop object for this element. + * @param {String} group The group the DD object is member of + * @param {Object} config The DD config object + * @param {Object} overrides An object containing methods to override/implement on the DD object + * @return {Roo.dd.DD} The DD object + */ + initDD : function(group, config, overrides){ + var dd = new Roo.dd.DD(Roo.id(this.dom), group, config); + return Roo.apply(dd, overrides); + }, + + /** + * Initializes a {@link Roo.dd.DDProxy} object for this element. + * @param {String} group The group the DDProxy object is member of + * @param {Object} config The DDProxy config object + * @param {Object} overrides An object containing methods to override/implement on the DDProxy object + * @return {Roo.dd.DDProxy} The DDProxy object + */ + initDDProxy : function(group, config, overrides){ + var dd = new Roo.dd.DDProxy(Roo.id(this.dom), group, config); + return Roo.apply(dd, overrides); + }, + + /** + * Initializes a {@link Roo.dd.DDTarget} object for this element. + * @param {String} group The group the DDTarget object is member of + * @param {Object} config The DDTarget config object + * @param {Object} overrides An object containing methods to override/implement on the DDTarget object + * @return {Roo.dd.DDTarget} The DDTarget object + */ + initDDTarget : function(group, config, overrides){ + var dd = new Roo.dd.DDTarget(Roo.id(this.dom), group, config); + return Roo.apply(dd, overrides); + }, + + /** + * Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use + * the display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property. + * @param {Boolean} visible Whether the element is visible + * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object + * @return {Roo.Element} this + */ + setVisible : function(visible, animate){ + if(!animate || !A){ + if(this.visibilityMode == El.DISPLAY){ + this.setDisplayed(visible); + }else{ + this.fixDisplay(); + this.dom.style.visibility = visible ? "visible" : "hidden"; + } + }else{ + // closure for composites + var dom = this.dom; + var visMode = this.visibilityMode; + if(visible){ + this.setOpacity(.01); + this.setVisible(true); + } + this.anim({opacity: { to: (visible?1:0) }}, + this.preanim(arguments, 1), + null, .35, 'easeIn', function(){ + if(!visible){ + if(visMode == El.DISPLAY){ + dom.style.display = "none"; + }else{ + dom.style.visibility = "hidden"; + } + Roo.get(dom).setOpacity(1); + } + }); + } + return this; + }, + + /** + * Returns true if display is not "none" + * @return {Boolean} + */ + isDisplayed : function() { + return this.getStyle("display") != "none"; + }, + + /** + * Toggles the element's visibility or display, depending on visibility mode. + * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object + * @return {Roo.Element} this + */ + toggle : function(animate){ + this.setVisible(!this.isVisible(), this.preanim(arguments, 0)); + return this; + }, + + /** + * Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true. + * @param {Boolean} value Boolean value to display the element using its default display, or a string to set the display directly + * @return {Roo.Element} this + */ + setDisplayed : function(value) { + if(typeof value == "boolean"){ + value = value ? this.originalDisplay : "none"; + } + this.setStyle("display", value); + return this; + }, + + /** + * Tries to focus the element. Any exceptions are caught and ignored. + * @return {Roo.Element} this + */ + focus : function() { + try{ + this.dom.focus(); + }catch(e){} + return this; + }, + + /** + * Tries to blur the element. Any exceptions are caught and ignored. + * @return {Roo.Element} this + */ + blur : function() { + try{ + this.dom.blur(); + }catch(e){} + return this; + }, + + /** + * Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out. + * @param {String/Array} className The CSS class to add, or an array of classes + * @return {Roo.Element} this + */ + addClass : function(className){ + if(className instanceof Array){ + for(var i = 0, len = className.length; i < len; i++) { + this.addClass(className[i]); + } + }else{ + if(className && !this.hasClass(className)){ + this.dom.className = this.dom.className + " " + className; + } + } + return this; + }, + + /** + * Adds one or more CSS classes to this element and removes the same class(es) from all siblings. + * @param {String/Array} className The CSS class to add, or an array of classes + * @return {Roo.Element} this + */ + radioClass : function(className){ + var siblings = this.dom.parentNode.childNodes; + for(var i = 0; i < siblings.length; i++) { + var s = siblings[i]; + if(s.nodeType == 1){ + Roo.get(s).removeClass(className); + } + } + this.addClass(className); + return this; + }, + + /** + * Removes one or more CSS classes from the element. + * @param {String/Array} className The CSS class to remove, or an array of classes + * @return {Roo.Element} this + */ + removeClass : function(className){ + if(!className || !this.dom.className){ + return this; + } + if(className instanceof Array){ + for(var i = 0, len = className.length; i < len; i++) { + this.removeClass(className[i]); + } + }else{ + if(this.hasClass(className)){ + var re = this.classReCache[className]; + if (!re) { + re = new RegExp('(?:^|\\s+)' + className + '(?:\\s+|$)', "g"); + this.classReCache[className] = re; + } + this.dom.className = + this.dom.className.replace(re, " "); + } + } + return this; + }, + + // private + classReCache: {}, + + /** + * Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it). + * @param {String} className The CSS class to toggle + * @return {Roo.Element} this + */ + toggleClass : function(className){ + if(this.hasClass(className)){ + this.removeClass(className); + }else{ + this.addClass(className); + } + return this; + }, + + /** + * Checks if the specified CSS class exists on this element's DOM node. + * @param {String} className The CSS class to check for + * @return {Boolean} True if the class exists, else false + */ + hasClass : function(className){ + return className && (' '+this.dom.className+' ').indexOf(' '+className+' ') != -1; + }, + + /** + * Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added. + * @param {String} oldClassName The CSS class to replace + * @param {String} newClassName The replacement CSS class + * @return {Roo.Element} this + */ + replaceClass : function(oldClassName, newClassName){ + this.removeClass(oldClassName); + this.addClass(newClassName); + return this; + }, + + /** + * Returns an object with properties matching the styles requested. + * For example, el.getStyles('color', 'font-size', 'width') might return + * {'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}. + * @param {String} style1 A style name + * @param {String} style2 A style name + * @param {String} etc. + * @return {Object} The style object + */ + getStyles : function(){ + var a = arguments, len = a.length, r = {}; + for(var i = 0; i < len; i++){ + r[a[i]] = this.getStyle(a[i]); + } + return r; + }, + + /** + * Normalizes currentStyle and computedStyle. This is not YUI getStyle, it is an optimised version. + * @param {String} property The style property whose value is returned. + * @return {String} The current value of the style property for this element. + */ + getStyle : function(){ + return view && view.getComputedStyle ? + function(prop){ + var el = this.dom, v, cs, camel; + if(prop == 'float'){ + prop = "cssFloat"; + } + if(el.style && (v = el.style[prop])){ + return v; + } + if(cs = view.getComputedStyle(el, "")){ + if(!(camel = propCache[prop])){ + camel = propCache[prop] = prop.replace(camelRe, camelFn); + } + return cs[camel]; + } + return null; + } : + function(prop){ + var el = this.dom, v, cs, camel; + if(prop == 'opacity'){ + if(typeof el.style.filter == 'string'){ + var m = el.style.filter.match(/alpha\(opacity=(.*)\)/i); + if(m){ + var fv = parseFloat(m[1]); + if(!isNaN(fv)){ + return fv ? fv / 100 : 0; + } + } + } + return 1; + }else if(prop == 'float'){ + prop = "styleFloat"; + } + if(!(camel = propCache[prop])){ + camel = propCache[prop] = prop.replace(camelRe, camelFn); + } + if(v = el.style[camel]){ + return v; + } + if(cs = el.currentStyle){ + return cs[camel]; + } + return null; + }; + }(), + + /** + * Wrapper for setting style properties, also takes single object parameter of multiple styles. + * @param {String/Object} property The style property to be set, or an object of multiple styles. + * @param {String} value (optional) The value to apply to the given property, or null if an object was passed. + * @return {Roo.Element} this + */ + setStyle : function(prop, value){ + if(typeof prop == "string"){ + + if (prop == 'float') { + this.setStyle(Roo.isIE ? 'styleFloat' : 'cssFloat', value); + return this; + } + + var camel; + if(!(camel = propCache[prop])){ + camel = propCache[prop] = prop.replace(camelRe, camelFn); + } + + if(camel == 'opacity') { + this.setOpacity(value); + }else{ + this.dom.style[camel] = value; + } + }else{ + for(var style in prop){ + if(typeof prop[style] != "function"){ + this.setStyle(style, prop[style]); + } + } + } + return this; + }, + + /** + * More flexible version of {@link #setStyle} for setting style properties. + * @param {String/Object/Function} styles A style specification string, e.g. "width:100px", or object in the form {width:"100px"}, or + * a function which returns such a specification. + * @return {Roo.Element} this + */ + applyStyles : function(style){ + Roo.DomHelper.applyStyles(this.dom, style); + return this; + }, + + /** + * Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). + * @return {Number} The X position of the element + */ + getX : function(){ + return D.getX(this.dom); + }, + + /** + * Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). + * @return {Number} The Y position of the element + */ + getY : function(){ + return D.getY(this.dom); + }, + + /** + * Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). + * @return {Array} The XY position of the element + */ + getXY : function(){ + return D.getXY(this.dom); + }, + + /** + * Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). + * @param {Number} The X position of the element + * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object + * @return {Roo.Element} this + */ + setX : function(x, animate){ + if(!animate || !A){ + D.setX(this.dom, x); + }else{ + this.setXY([x, this.getY()], this.preanim(arguments, 1)); + } + return this; + }, + + /** + * Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). + * @param {Number} The Y position of the element + * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object + * @return {Roo.Element} this + */ + setY : function(y, animate){ + if(!animate || !A){ + D.setY(this.dom, y); + }else{ + this.setXY([this.getX(), y], this.preanim(arguments, 1)); + } + return this; + }, + + /** + * Sets the element's left position directly using CSS style (instead of {@link #setX}). + * @param {String} left The left CSS property value + * @return {Roo.Element} this + */ + setLeft : function(left){ + this.setStyle("left", this.addUnits(left)); + return this; + }, + + /** + * Sets the element's top position directly using CSS style (instead of {@link #setY}). + * @param {String} top The top CSS property value + * @return {Roo.Element} this + */ + setTop : function(top){ + this.setStyle("top", this.addUnits(top)); + return this; + }, + + /** + * Sets the element's CSS right style. + * @param {String} right The right CSS property value + * @return {Roo.Element} this + */ + setRight : function(right){ + this.setStyle("right", this.addUnits(right)); + return this; + }, + + /** + * Sets the element's CSS bottom style. + * @param {String} bottom The bottom CSS property value + * @return {Roo.Element} this + */ + setBottom : function(bottom){ + this.setStyle("bottom", this.addUnits(bottom)); + return this; + }, + + /** + * Sets the position of the element in page coordinates, regardless of how the element is positioned. + * The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). + * @param {Array} pos Contains X & Y [x, y] values for new position (coordinates are page-based) + * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object + * @return {Roo.Element} this + */ + setXY : function(pos, animate){ + if(!animate || !A){ + D.setXY(this.dom, pos); + }else{ + this.anim({points: {to: pos}}, this.preanim(arguments, 1), 'motion'); + } + return this; + }, + + /** + * Sets the position of the element in page coordinates, regardless of how the element is positioned. + * The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). + * @param {Number} x X value for new position (coordinates are page-based) + * @param {Number} y Y value for new position (coordinates are page-based) + * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object + * @return {Roo.Element} this + */ + setLocation : function(x, y, animate){ + this.setXY([x, y], this.preanim(arguments, 2)); + return this; + }, + + /** + * Sets the position of the element in page coordinates, regardless of how the element is positioned. + * The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). + * @param {Number} x X value for new position (coordinates are page-based) + * @param {Number} y Y value for new position (coordinates are page-based) + * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object + * @return {Roo.Element} this + */ + moveTo : function(x, y, animate){ + this.setXY([x, y], this.preanim(arguments, 2)); + return this; + }, + + /** + * Returns the region of the given element. + * The element must be part of the DOM tree to have a region (display:none or elements not appended return false). + * @return {Region} A Roo.lib.Region containing "top, left, bottom, right" member data. + */ + getRegion : function(){ + return D.getRegion(this.dom); + }, + + /** + * Returns the offset height of the element + * @param {Boolean} contentHeight (optional) true to get the height minus borders and padding + * @return {Number} The element's height + */ + getHeight : function(contentHeight){ + var h = this.dom.offsetHeight || 0; + return contentHeight !== true ? h : h-this.getBorderWidth("tb")-this.getPadding("tb"); + }, + + /** + * Returns the offset width of the element + * @param {Boolean} contentWidth (optional) true to get the width minus borders and padding + * @return {Number} The element's width + */ + getWidth : function(contentWidth){ + var w = this.dom.offsetWidth || 0; + return contentWidth !== true ? w : w-this.getBorderWidth("lr")-this.getPadding("lr"); + }, + + /** + * Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders + * when needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements + * if a height has not been set using CSS. + * @return {Number} + */ + getComputedHeight : function(){ + var h = Math.max(this.dom.offsetHeight, this.dom.clientHeight); + if(!h){ + h = parseInt(this.getStyle('height'), 10) || 0; + if(!this.isBorderBox()){ + h += this.getFrameWidth('tb'); + } + } + return h; + }, + + /** + * Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders + * when needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements + * if a width has not been set using CSS. + * @return {Number} + */ + getComputedWidth : function(){ + var w = Math.max(this.dom.offsetWidth, this.dom.clientWidth); + if(!w){ + w = parseInt(this.getStyle('width'), 10) || 0; + if(!this.isBorderBox()){ + w += this.getFrameWidth('lr'); + } + } + return w; + }, + + /** + * Returns the size of the element. + * @param {Boolean} contentSize (optional) true to get the width/size minus borders and padding + * @return {Object} An object containing the element's size {width: (element width), height: (element height)} + */ + getSize : function(contentSize){ + return {width: this.getWidth(contentSize), height: this.getHeight(contentSize)}; + }, + + /** + * Returns the width and height of the viewport. + * @return {Object} An object containing the viewport's size {width: (viewport width), height: (viewport height)} + */ + getViewSize : function(){ + var d = this.dom, doc = document, aw = 0, ah = 0; + if(d == doc || d == doc.body){ + return {width : D.getViewWidth(), height: D.getViewHeight()}; + }else{ + return { + width : d.clientWidth, + height: d.clientHeight + }; + } + }, + + /** + * Returns the value of the "value" attribute + * @param {Boolean} asNumber true to parse the value as a number + * @return {String/Number} + */ + getValue : function(asNumber){ + return asNumber ? parseInt(this.dom.value, 10) : this.dom.value; + }, + + // private + adjustWidth : function(width){ + if(typeof width == "number"){ + if(this.autoBoxAdjust && !this.isBorderBox()){ + width -= (this.getBorderWidth("lr") + this.getPadding("lr")); + } + if(width < 0){ + width = 0; + } + } + return width; + }, + + // private + adjustHeight : function(height){ + if(typeof height == "number"){ + if(this.autoBoxAdjust && !this.isBorderBox()){ + height -= (this.getBorderWidth("tb") + this.getPadding("tb")); + } + if(height < 0){ + height = 0; + } + } + return height; + }, + + /** + * Set the width of the element + * @param {Number} width The new width + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Roo.Element} this + */ + setWidth : function(width, animate){ + width = this.adjustWidth(width); + if(!animate || !A){ + this.dom.style.width = this.addUnits(width); + }else{ + this.anim({width: {to: width}}, this.preanim(arguments, 1)); + } + return this; + }, + + /** + * Set the height of the element + * @param {Number} height The new height + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Roo.Element} this + */ + setHeight : function(height, animate){ + height = this.adjustHeight(height); + if(!animate || !A){ + this.dom.style.height = this.addUnits(height); + }else{ + this.anim({height: {to: height}}, this.preanim(arguments, 1)); + } + return this; + }, + + /** + * Set the size of the element. If animation is true, both width an height will be animated concurrently. + * @param {Number} width The new width + * @param {Number} height The new height + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Roo.Element} this + */ + setSize : function(width, height, animate){ + if(typeof width == "object"){ // in case of object from getSize() + height = width.height; width = width.width; + } + width = this.adjustWidth(width); height = this.adjustHeight(height); + if(!animate || !A){ + this.dom.style.width = this.addUnits(width); + this.dom.style.height = this.addUnits(height); + }else{ + this.anim({width: {to: width}, height: {to: height}}, this.preanim(arguments, 2)); + } + return this; + }, + + /** + * Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently. + * @param {Number} x X value for new position (coordinates are page-based) + * @param {Number} y Y value for new position (coordinates are page-based) + * @param {Number} width The new width + * @param {Number} height The new height + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Roo.Element} this + */ + setBounds : function(x, y, width, height, animate){ + if(!animate || !A){ + this.setSize(width, height); + this.setLocation(x, y); + }else{ + width = this.adjustWidth(width); height = this.adjustHeight(height); + this.anim({points: {to: [x, y]}, width: {to: width}, height: {to: height}}, + this.preanim(arguments, 4), 'motion'); + } + return this; + }, + + /** + * Sets the element's position and size the the specified region. If animation is true then width, height, x and y will be animated concurrently. + * @param {Roo.lib.Region} region The region to fill + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Roo.Element} this + */ + setRegion : function(region, animate){ + this.setBounds(region.left, region.top, region.right-region.left, region.bottom-region.top, this.preanim(arguments, 1)); + return this; + }, + + /** + * Appends an event handler + * + * @param {String} eventName The type of event to append + * @param {Function} fn The method the event invokes + * @param {Object} scope (optional) The scope (this object) of the fn + * @param {Object} options (optional)An object with standard {@link Roo.EventManager#addListener} options + */ + addListener : function(eventName, fn, scope, options){ + if (this.dom) { + Roo.EventManager.on(this.dom, eventName, fn, scope || this, options); + } + }, + + /** + * Removes an event handler from this element + * @param {String} eventName the type of event to remove + * @param {Function} fn the method the event invokes + * @return {Roo.Element} this + */ + removeListener : function(eventName, fn){ + Roo.EventManager.removeListener(this.dom, eventName, fn); + return this; + }, + + /** + * Removes all previous added listeners from this element + * @return {Roo.Element} this + */ + removeAllListeners : function(){ + E.purgeElement(this.dom); + return this; + }, + + relayEvent : function(eventName, observable){ + this.on(eventName, function(e){ + observable.fireEvent(eventName, e); + }); + }, + + /** + * Set the opacity of the element + * @param {Float} opacity The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Roo.Element} this + */ + setOpacity : function(opacity, animate){ + if(!animate || !A){ + var s = this.dom.style; + if(Roo.isIE){ + s.zoom = 1; + s.filter = (s.filter || '').replace(/alpha\([^\)]*\)/gi,"") + + (opacity == 1 ? "" : "alpha(opacity=" + opacity * 100 + ")"); + }else{ + s.opacity = opacity; + } + }else{ + this.anim({opacity: {to: opacity}}, this.preanim(arguments, 1), null, .35, 'easeIn'); + } + return this; + }, + + /** + * Gets the left X coordinate + * @param {Boolean} local True to get the local css position instead of page coordinate + * @return {Number} + */ + getLeft : function(local){ + if(!local){ + return this.getX(); + }else{ + return parseInt(this.getStyle("left"), 10) || 0; + } + }, + + /** + * Gets the right X coordinate of the element (element X position + element width) + * @param {Boolean} local True to get the local css position instead of page coordinate + * @return {Number} + */ + getRight : function(local){ + if(!local){ + return this.getX() + this.getWidth(); + }else{ + return (this.getLeft(true) + this.getWidth()) || 0; + } + }, + + /** + * Gets the top Y coordinate + * @param {Boolean} local True to get the local css position instead of page coordinate + * @return {Number} + */ + getTop : function(local) { + if(!local){ + return this.getY(); + }else{ + return parseInt(this.getStyle("top"), 10) || 0; + } + }, + + /** + * Gets the bottom Y coordinate of the element (element Y position + element height) + * @param {Boolean} local True to get the local css position instead of page coordinate + * @return {Number} + */ + getBottom : function(local){ + if(!local){ + return this.getY() + this.getHeight(); + }else{ + return (this.getTop(true) + this.getHeight()) || 0; + } + }, + + /** + * Initializes positioning on this element. If a desired position is not passed, it will make the + * the element positioned relative IF it is not already positioned. + * @param {String} pos (optional) Positioning to use "relative", "absolute" or "fixed" + * @param {Number} zIndex (optional) The zIndex to apply + * @param {Number} x (optional) Set the page X position + * @param {Number} y (optional) Set the page Y position + */ + position : function(pos, zIndex, x, y){ + if(!pos){ + if(this.getStyle('position') == 'static'){ + this.setStyle('position', 'relative'); + } + }else{ + this.setStyle("position", pos); + } + if(zIndex){ + this.setStyle("z-index", zIndex); + } + if(x !== undefined && y !== undefined){ + this.setXY([x, y]); + }else if(x !== undefined){ + this.setX(x); + }else if(y !== undefined){ + this.setY(y); + } + }, + + /** + * Clear positioning back to the default when the document was loaded + * @param {String} value (optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'. + * @return {Roo.Element} this + */ + clearPositioning : function(value){ + value = value ||''; + this.setStyle({ + "left": value, + "right": value, + "top": value, + "bottom": value, + "z-index": "", + "position" : "static" + }); + return this; + }, + + /** + * Gets an object with all CSS positioning properties. Useful along with setPostioning to get + * snapshot before performing an update and then restoring the element. + * @return {Object} + */ + getPositioning : function(){ + var l = this.getStyle("left"); + var t = this.getStyle("top"); + return { + "position" : this.getStyle("position"), + "left" : l, + "right" : l ? "" : this.getStyle("right"), + "top" : t, + "bottom" : t ? "" : this.getStyle("bottom"), + "z-index" : this.getStyle("z-index") + }; + }, + + /** + * Gets the width of the border(s) for the specified side(s) + * @param {String} side Can be t, l, r, b or any combination of those to add multiple values. For example, + * passing lr would get the border (l)eft width + the border (r)ight width. + * @return {Number} The width of the sides passed added together + */ + getBorderWidth : function(side){ + return this.addStyles(side, El.borders); + }, + + /** + * Gets the width of the padding(s) for the specified side(s) + * @param {String} side Can be t, l, r, b or any combination of those to add multiple values. For example, + * passing lr would get the padding (l)eft + the padding (r)ight. + * @return {Number} The padding of the sides passed added together + */ + getPadding : function(side){ + return this.addStyles(side, El.paddings); + }, + + /** + * Set positioning with an object returned by getPositioning(). + * @param {Object} posCfg + * @return {Roo.Element} this + */ + setPositioning : function(pc){ + this.applyStyles(pc); + if(pc.right == "auto"){ + this.dom.style.right = ""; + } + if(pc.bottom == "auto"){ + this.dom.style.bottom = ""; + } + return this; + }, + + // private + fixDisplay : function(){ + if(this.getStyle("display") == "none"){ + this.setStyle("visibility", "hidden"); + this.setStyle("display", this.originalDisplay); // first try reverting to default + if(this.getStyle("display") == "none"){ // if that fails, default to block + this.setStyle("display", "block"); + } + } + }, + + /** + * Quick set left and top adding default units + * @param {String} left The left CSS property value + * @param {String} top The top CSS property value + * @return {Roo.Element} this + */ + setLeftTop : function(left, top){ + this.dom.style.left = this.addUnits(left); + this.dom.style.top = this.addUnits(top); + return this; + }, + + /** + * Move this element relative to its current position. + * @param {String} direction Possible values are: "l","left" - "r","right" - "t","top","up" - "b","bottom","down". + * @param {Number} distance How far to move the element in pixels + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Roo.Element} this + */ + move : function(direction, distance, animate){ + var xy = this.getXY(); + direction = direction.toLowerCase(); + switch(direction){ + case "l": + case "left": + this.moveTo(xy[0]-distance, xy[1], this.preanim(arguments, 2)); + break; + case "r": + case "right": + this.moveTo(xy[0]+distance, xy[1], this.preanim(arguments, 2)); + break; + case "t": + case "top": + case "up": + this.moveTo(xy[0], xy[1]-distance, this.preanim(arguments, 2)); + break; + case "b": + case "bottom": + case "down": + this.moveTo(xy[0], xy[1]+distance, this.preanim(arguments, 2)); + break; + } + return this; + }, + + /** + * Store the current overflow setting and clip overflow on the element - use {@link #unclip} to remove + * @return {Roo.Element} this + */ + clip : function(){ + if(!this.isClipped){ + this.isClipped = true; + this.originalClip = { + "o": this.getStyle("overflow"), + "x": this.getStyle("overflow-x"), + "y": this.getStyle("overflow-y") + }; + this.setStyle("overflow", "hidden"); + this.setStyle("overflow-x", "hidden"); + this.setStyle("overflow-y", "hidden"); + } + return this; + }, + + /** + * Return clipping (overflow) to original clipping before clip() was called + * @return {Roo.Element} this + */ + unclip : function(){ + if(this.isClipped){ + this.isClipped = false; + var o = this.originalClip; + if(o.o){this.setStyle("overflow", o.o);} + if(o.x){this.setStyle("overflow-x", o.x);} + if(o.y){this.setStyle("overflow-y", o.y);} + } + return this; + }, + + + /** + * Gets the x,y coordinates specified by the anchor position on the element. + * @param {String} anchor (optional) The specified anchor position (defaults to "c"). See {@link #alignTo} for details on supported anchor positions. + * @param {Object} size (optional) An object containing the size to use for calculating anchor position + * {width: (target width), height: (target height)} (defaults to the element's current size) + * @param {Boolean} local (optional) True to get the local (element top/left-relative) anchor position instead of page coordinates + * @return {Array} [x, y] An array containing the element's x and y coordinates + */ + getAnchorXY : function(anchor, local, s){ + //Passing a different size is useful for pre-calculating anchors, + //especially for anchored animations that change the el size. + + var w, h, vp = false; + if(!s){ + var d = this.dom; + if(d == document.body || d == document){ + vp = true; + w = D.getViewWidth(); h = D.getViewHeight(); + }else{ + w = this.getWidth(); h = this.getHeight(); + } + }else{ + w = s.width; h = s.height; + } + var x = 0, y = 0, r = Math.round; + switch((anchor || "tl").toLowerCase()){ + case "c": + x = r(w*.5); + y = r(h*.5); + break; + case "t": + x = r(w*.5); + y = 0; + break; + case "l": + x = 0; + y = r(h*.5); + break; + case "r": + x = w; + y = r(h*.5); + break; + case "b": + x = r(w*.5); + y = h; + break; + case "tl": + x = 0; + y = 0; + break; + case "bl": + x = 0; + y = h; + break; + case "br": + x = w; + y = h; + break; + case "tr": + x = w; + y = 0; + break; + } + if(local === true){ + return [x, y]; + } + if(vp){ + var sc = this.getScroll(); + return [x + sc.left, y + sc.top]; + } + //Add the element's offset xy + var o = this.getXY(); + return [x+o[0], y+o[1]]; + }, + + /** + * Gets the x,y coordinates to align this element with another element. See {@link #alignTo} for more info on the + * supported position values. + * @param {String/HTMLElement/Roo.Element} element The element to align to. + * @param {String} position The position to align to. + * @param {Array} offsets (optional) Offset the positioning by [x, y] + * @return {Array} [x, y] + */ + getAlignToXY : function(el, p, o){ + el = Roo.get(el); + var d = this.dom; + if(!el.dom){ + throw "Element.alignTo with an element that doesn't exist"; + } + var c = false; //constrain to viewport + var p1 = "", p2 = ""; + o = o || [0,0]; + + if(!p){ + p = "tl-bl"; + }else if(p == "?"){ + p = "tl-bl?"; + }else if(p.indexOf("-") == -1){ + p = "tl-" + p; + } + p = p.toLowerCase(); + var m = p.match(/^([a-z]+)-([a-z]+)(\?)?$/); + if(!m){ + throw "Element.alignTo with an invalid alignment " + p; + } + p1 = m[1]; p2 = m[2]; c = !!m[3]; + + //Subtract the aligned el's internal xy from the target's offset xy + //plus custom offset to get the aligned el's new offset xy + var a1 = this.getAnchorXY(p1, true); + var a2 = el.getAnchorXY(p2, false); + var x = a2[0] - a1[0] + o[0]; + var y = a2[1] - a1[1] + o[1]; + if(c){ + //constrain the aligned el to viewport if necessary + var w = this.getWidth(), h = this.getHeight(), r = el.getRegion(); + // 5px of margin for ie + var dw = D.getViewWidth()-5, dh = D.getViewHeight()-5; + + //If we are at a viewport boundary and the aligned el is anchored on a target border that is + //perpendicular to the vp border, allow the aligned el to slide on that border, + //otherwise swap the aligned el to the opposite border of the target. + var p1y = p1.charAt(0), p1x = p1.charAt(p1.length-1); + var p2y = p2.charAt(0), p2x = p2.charAt(p2.length-1); + var swapY = ((p1y=="t" && p2y=="b") || (p1y=="b" && p2y=="t")); + var swapX = ((p1x=="r" && p2x=="l") || (p1x=="l" && p2x=="r")); + + var doc = document; + var scrollX = (doc.documentElement.scrollLeft || doc.body.scrollLeft || 0)+5; + var scrollY = (doc.documentElement.scrollTop || doc.body.scrollTop || 0)+5; + + if((x+w) > dw + scrollX){ + x = swapX ? r.left-w : dw+scrollX-w; + } + if(x < scrollX){ + x = swapX ? r.right : scrollX; + } + if((y+h) > dh + scrollY){ + y = swapY ? r.top-h : dh+scrollY-h; + } + if (y < scrollY){ + y = swapY ? r.bottom : scrollY; + } + } + return [x,y]; + }, + + // private + getConstrainToXY : function(){ + var os = {top:0, left:0, bottom:0, right: 0}; + + return function(el, local, offsets, proposedXY){ + el = Roo.get(el); + offsets = offsets ? Roo.applyIf(offsets, os) : os; + + var vw, vh, vx = 0, vy = 0; + if(el.dom == document.body || el.dom == document){ + vw = Roo.lib.Dom.getViewWidth(); + vh = Roo.lib.Dom.getViewHeight(); + }else{ + vw = el.dom.clientWidth; + vh = el.dom.clientHeight; + if(!local){ + var vxy = el.getXY(); + vx = vxy[0]; + vy = vxy[1]; + } + } + + var s = el.getScroll(); + + vx += offsets.left + s.left; + vy += offsets.top + s.top; + + vw -= offsets.right; + vh -= offsets.bottom; + + var vr = vx+vw; + var vb = vy+vh; + + var xy = proposedXY || (!local ? this.getXY() : [this.getLeft(true), this.getTop(true)]); + var x = xy[0], y = xy[1]; + var w = this.dom.offsetWidth, h = this.dom.offsetHeight; + + // only move it if it needs it + var moved = false; + + // first validate right/bottom + if((x + w) > vr){ + x = vr - w; + moved = true; + } + if((y + h) > vb){ + y = vb - h; + moved = true; + } + // then make sure top/left isn't negative + if(x < vx){ + x = vx; + moved = true; + } + if(y < vy){ + y = vy; + moved = true; + } + return moved ? [x, y] : false; + }; + }(), + + // private + adjustForConstraints : function(xy, parent, offsets){ + return this.getConstrainToXY(parent || document, false, offsets, xy) || xy; + }, + + /** + * Aligns this element with another element relative to the specified anchor points. If the other element is the + * document it aligns it to the viewport. + * The position parameter is optional, and can be specified in any one of the following formats: + * <ul> + * <li><b>Blank</b>: Defaults to aligning the element's top-left corner to the target's bottom-left corner ("tl-bl").</li> + * <li><b>One anchor (deprecated)</b>: The passed anchor position is used as the target element's anchor point. + * The element being aligned will position its top-left corner (tl) to that point. <i>This method has been + * deprecated in favor of the newer two anchor syntax below</i>.</li> + * <li><b>Two anchors</b>: If two values from the table below are passed separated by a dash, the first value is used as the + * element's anchor point, and the second value is used as the target's anchor point.</li> + * </ul> + * In addition to the anchor points, the position parameter also supports the "?" character. If "?" is passed at the end of + * the position string, the element will attempt to align as specified, but the position will be adjusted to constrain to + * the viewport if necessary. Note that the element being aligned might be swapped to align to a different position than + * that specified in order to enforce the viewport constraints. + * Following are all of the supported anchor positions: + <pre> + Value Description + ----- ----------------------------- + tl The top left corner (default) + t The center of the top edge + tr The top right corner + l The center of the left edge + c In the center of the element + r The center of the right edge + bl The bottom left corner + b The center of the bottom edge + br The bottom right corner + </pre> + Example Usage: + <pre><code> + // align el to other-el using the default positioning ("tl-bl", non-constrained) + el.alignTo("other-el"); + + // align the top left corner of el with the top right corner of other-el (constrained to viewport) + el.alignTo("other-el", "tr?"); + + // align the bottom right corner of el with the center left edge of other-el + el.alignTo("other-el", "br-l?"); + + // align the center of el with the bottom left corner of other-el and + // adjust the x position by -6 pixels (and the y position by 0) + el.alignTo("other-el", "c-bl", [-6, 0]); + </code></pre> + * @param {String/HTMLElement/Roo.Element} element The element to align to. + * @param {String} position The position to align to. + * @param {Array} offsets (optional) Offset the positioning by [x, y] + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Roo.Element} this + */ + alignTo : function(element, position, offsets, animate){ + var xy = this.getAlignToXY(element, position, offsets); + this.setXY(xy, this.preanim(arguments, 3)); + return this; + }, + + /** + * Anchors an element to another element and realigns it when the window is resized. + * @param {String/HTMLElement/Roo.Element} element The element to align to. + * @param {String} position The position to align to. + * @param {Array} offsets (optional) Offset the positioning by [x, y] + * @param {Boolean/Object} animate (optional) True for the default animation or a standard Element animation config object + * @param {Boolean/Number} monitorScroll (optional) True to monitor body scroll and reposition. If this parameter + * is a number, it is used as the buffer delay (defaults to 50ms). + * @param {Function} callback The function to call after the animation finishes + * @return {Roo.Element} this + */ + anchorTo : function(el, alignment, offsets, animate, monitorScroll, callback){ + var action = function(){ + this.alignTo(el, alignment, offsets, animate); + Roo.callback(callback, this); + }; + Roo.EventManager.onWindowResize(action, this); + var tm = typeof monitorScroll; + if(tm != 'undefined'){ + Roo.EventManager.on(window, 'scroll', action, this, + {buffer: tm == 'number' ? monitorScroll : 50}); + } + action.call(this); // align immediately + return this; + }, + /** + * Clears any opacity settings from this element. Required in some cases for IE. + * @return {Roo.Element} this + */ + clearOpacity : function(){ + if (window.ActiveXObject) { + if(typeof this.dom.style.filter == 'string' && (/alpha/i).test(this.dom.style.filter)){ + this.dom.style.filter = ""; + } + } else { + this.dom.style.opacity = ""; + this.dom.style["-moz-opacity"] = ""; + this.dom.style["-khtml-opacity"] = ""; + } + return this; + }, + + /** + * Hide this element - Uses display mode to determine whether to use "display" or "visibility". See {@link #setVisible}. + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Roo.Element} this + */ + hide : function(animate){ + this.setVisible(false, this.preanim(arguments, 0)); + return this; + }, + + /** + * Show this element - Uses display mode to determine whether to use "display" or "visibility". See {@link #setVisible}. + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Roo.Element} this + */ + show : function(animate){ + this.setVisible(true, this.preanim(arguments, 0)); + return this; + }, + + /** + * @private Test if size has a unit, otherwise appends the default + */ + addUnits : function(size){ + return Roo.Element.addUnits(size, this.defaultUnit); + }, + + /** + * Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done. + * @return {Roo.Element} this + */ + beginMeasure : function(){ + var el = this.dom; + if(el.offsetWidth || el.offsetHeight){ + return this; // offsets work already + } + var changed = []; + var p = this.dom, b = document.body; // start with this element + while((!el.offsetWidth && !el.offsetHeight) && p && p.tagName && p != b){ + var pe = Roo.get(p); + if(pe.getStyle('display') == 'none'){ + changed.push({el: p, visibility: pe.getStyle("visibility")}); + p.style.visibility = "hidden"; + p.style.display = "block"; + } + p = p.parentNode; + } + this._measureChanged = changed; + return this; + + }, + + /** + * Restores displays to before beginMeasure was called + * @return {Roo.Element} this + */ + endMeasure : function(){ + var changed = this._measureChanged; + if(changed){ + for(var i = 0, len = changed.length; i < len; i++) { + var r = changed[i]; + r.el.style.visibility = r.visibility; + r.el.style.display = "none"; + } + this._measureChanged = null; + } + return this; + }, + + /** + * Update the innerHTML of this element, optionally searching for and processing scripts + * @param {String} html The new HTML + * @param {Boolean} loadScripts (optional) true to look for and process scripts + * @param {Function} callback For async script loading you can be noticed when the update completes + * @return {Roo.Element} this + */ + update : function(html, loadScripts, callback){ + if(typeof html == "undefined"){ + html = ""; + } + if(loadScripts !== true){ + this.dom.innerHTML = html; + if(typeof callback == "function"){ + callback(); + } + return this; + } + var id = Roo.id(); + var dom = this.dom; + + html += '<span id="' + id + '"></span>'; + + E.onAvailable(id, function(){ + var hd = document.getElementsByTagName("head")[0]; + var re = /(?:<script([^>]*)?>)((\n|\r|.)*?)(?:<\/script>)/ig; + var srcRe = /\ssrc=([\'\"])(.*?)\1/i; + var typeRe = /\stype=([\'\"])(.*?)\1/i; + + var match; + while(match = re.exec(html)){ + var attrs = match[1]; + var srcMatch = attrs ? attrs.match(srcRe) : false; + if(srcMatch && srcMatch[2]){ + var s = document.createElement("script"); + s.src = srcMatch[2]; + var typeMatch = attrs.match(typeRe); + if(typeMatch && typeMatch[2]){ + s.type = typeMatch[2]; + } + hd.appendChild(s); + }else if(match[2] && match[2].length > 0){ + if(window.execScript) { + window.execScript(match[2]); + } else { + /** + * eval:var:id + * eval:var:dom + * eval:var:html + * + */ + window.eval(match[2]); + } + } + } + var el = document.getElementById(id); + if(el){el.parentNode.removeChild(el);} + if(typeof callback == "function"){ + callback(); + } + }); + dom.innerHTML = html.replace(/(?:<script.*?>)((\n|\r|.)*?)(?:<\/script>)/ig, ""); + return this; + }, + + /** + * Direct access to the UpdateManager update() method (takes the same parameters). + * @param {String/Function} url The url for this request or a function to call to get the url + * @param {String/Object} params (optional) The parameters to pass as either a url encoded string "param1=1&amp;param2=2" or an object {param1: 1, param2: 2} + * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess) + * @param {Boolean} discardUrl (optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url. + * @return {Roo.Element} this + */ + load : function(){ + var um = this.getUpdateManager(); + um.update.apply(um, arguments); + return this; + }, + + /** + * Gets this element's UpdateManager + * @return {Roo.UpdateManager} The UpdateManager + */ + getUpdateManager : function(){ + if(!this.updateManager){ + this.updateManager = new Roo.UpdateManager(this); + } + return this.updateManager; + }, + + /** + * Disables text selection for this element (normalized across browsers) + * @return {Roo.Element} this + */ + unselectable : function(){ + this.dom.unselectable = "on"; + this.swallowEvent("selectstart", true); + this.applyStyles("-moz-user-select:none;-khtml-user-select:none;"); + this.addClass("x-unselectable"); + return this; + }, + + /** + * Calculates the x, y to center this element on the screen + * @return {Array} The x, y values [x, y] + */ + getCenterXY : function(){ + return this.getAlignToXY(document, 'c-c'); + }, + + /** + * Centers the Element in either the viewport, or another Element. + * @param {String/HTMLElement/Roo.Element} centerIn (optional) The element in which to center the element. + */ + center : function(centerIn){ + this.alignTo(centerIn || document, 'c-c'); + return this; + }, + + /** + * Tests various css rules/browsers to determine if this element uses a border box + * @return {Boolean} + */ + isBorderBox : function(){ + return noBoxAdjust[this.dom.tagName.toLowerCase()] || Roo.isBorderBox; + }, + + /** + * Return a box {x, y, width, height} that can be used to set another elements + * size/location to match this element. + * @param {Boolean} contentBox (optional) If true a box for the content of the element is returned. + * @param {Boolean} local (optional) If true the element's left and top are returned instead of page x/y. + * @return {Object} box An object in the format {x, y, width, height} + */ + getBox : function(contentBox, local){ + var xy; + if(!local){ + xy = this.getXY(); + }else{ + var left = parseInt(this.getStyle("left"), 10) || 0; + var top = parseInt(this.getStyle("top"), 10) || 0; + xy = [left, top]; + } + var el = this.dom, w = el.offsetWidth, h = el.offsetHeight, bx; + if(!contentBox){ + bx = {x: xy[0], y: xy[1], 0: xy[0], 1: xy[1], width: w, height: h}; + }else{ + var l = this.getBorderWidth("l")+this.getPadding("l"); + var r = this.getBorderWidth("r")+this.getPadding("r"); + var t = this.getBorderWidth("t")+this.getPadding("t"); + var b = this.getBorderWidth("b")+this.getPadding("b"); + bx = {x: xy[0]+l, y: xy[1]+t, 0: xy[0]+l, 1: xy[1]+t, width: w-(l+r), height: h-(t+b)}; + } + bx.right = bx.x + bx.width; + bx.bottom = bx.y + bx.height; + return bx; + }, + + /** + * Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth() + for more information about the sides. + * @param {String} sides + * @return {Number} + */ + getFrameWidth : function(sides, onlyContentBox){ + return onlyContentBox && Roo.isBorderBox ? 0 : (this.getPadding(sides) + this.getBorderWidth(sides)); + }, + + /** + * Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x and y will be animated concurrently. + * @param {Object} box The box to fill {x, y, width, height} + * @param {Boolean} adjust (optional) Whether to adjust for box-model issues automatically + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Roo.Element} this + */ + setBox : function(box, adjust, animate){ + var w = box.width, h = box.height; + if((adjust && !this.autoBoxAdjust) && !this.isBorderBox()){ + w -= (this.getBorderWidth("lr") + this.getPadding("lr")); + h -= (this.getBorderWidth("tb") + this.getPadding("tb")); + } + this.setBounds(box.x, box.y, w, h, this.preanim(arguments, 2)); + return this; + }, + + /** + * Forces the browser to repaint this element + * @return {Roo.Element} this + */ + repaint : function(){ + var dom = this.dom; + this.addClass("x-repaint"); + setTimeout(function(){ + Roo.get(dom).removeClass("x-repaint"); + }, 1); + return this; + }, + + /** + * Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed, + * then it returns the calculated width of the sides (see getPadding) + * @param {String} sides (optional) Any combination of l, r, t, b to get the sum of those sides + * @return {Object/Number} + */ + getMargins : function(side){ + if(!side){ + return { + top: parseInt(this.getStyle("margin-top"), 10) || 0, + left: parseInt(this.getStyle("margin-left"), 10) || 0, + bottom: parseInt(this.getStyle("margin-bottom"), 10) || 0, + right: parseInt(this.getStyle("margin-right"), 10) || 0 + }; + }else{ + return this.addStyles(side, El.margins); + } + }, + + // private + addStyles : function(sides, styles){ + var val = 0, v, w; + for(var i = 0, len = sides.length; i < len; i++){ + v = this.getStyle(styles[sides.charAt(i)]); + if(v){ + w = parseInt(v, 10); + if(w){ val += w; } + } + } + return val; + }, + + /** + * Creates a proxy element of this element + * @param {String/Object} config The class name of the proxy element or a DomHelper config object + * @param {String/HTMLElement} renderTo (optional) The element or element id to render the proxy to (defaults to document.body) + * @param {Boolean} matchBox (optional) True to align and size the proxy to this element now (defaults to false) + * @return {Roo.Element} The new proxy element + */ + createProxy : function(config, renderTo, matchBox){ + if(renderTo){ + renderTo = Roo.getDom(renderTo); + }else{ + renderTo = document.body; + } + config = typeof config == "object" ? + config : {tag : "div", cls: config}; + var proxy = Roo.DomHelper.append(renderTo, config, true); + if(matchBox){ + proxy.setBox(this.getBox()); + } + return proxy; + }, + + /** + * Puts a mask over this element to disable user interaction. Requires core.css. + * This method can only be applied to elements which accept child nodes. + * @param {String} msg (optional) A message to display in the mask + * @param {String} msgCls (optional) A css class to apply to the msg element + * @return {Element} The mask element + */ + mask : function(msg, msgCls) + { + if(this.getStyle("position") == "static" && this.dom.tagName !== 'BODY'){ + this.setStyle("position", "relative"); + } + if(!this._mask){ + this._mask = Roo.DomHelper.append(this.dom, {cls:"roo-el-mask"}, true); + } + + this.addClass("x-masked"); + this._mask.setDisplayed(true); + + // we wander + var z = 0; + var dom = this.dom; + while (dom && dom.style) { + if (!isNaN(parseInt(dom.style.zIndex))) { + z = Math.max(z, parseInt(dom.style.zIndex)); + } + dom = dom.parentNode; + } + // if we are masking the body - then it hides everything.. + if (this.dom == document.body) { + z = 1000000; + this._mask.setWidth(Roo.lib.Dom.getDocumentWidth()); + this._mask.setHeight(Roo.lib.Dom.getDocumentHeight()); + } + + if(typeof msg == 'string'){ + if(!this._maskMsg){ + this._maskMsg = Roo.DomHelper.append(this.dom, { + cls: "roo-el-mask-msg", + cn: [ + { + tag: 'i', + cls: 'fa fa-spinner fa-spin' + }, + { + tag: 'div' + } + ] + }, true); + } + var mm = this._maskMsg; + mm.dom.className = msgCls ? "roo-el-mask-msg " + msgCls : "roo-el-mask-msg"; + if (mm.dom.lastChild) { // weird IE issue? + mm.dom.lastChild.innerHTML = msg; + } + mm.setDisplayed(true); + mm.center(this); + mm.setStyle('z-index', z + 102); + } + if(Roo.isIE && !(Roo.isIE7 && Roo.isStrict) && this.getStyle('height') == 'auto'){ // ie will not expand full height automatically + this._mask.setHeight(this.getHeight()); + } + this._mask.setStyle('z-index', z + 100); + + return this._mask; + }, + + /** + * Removes a previously applied mask. If removeEl is true the mask overlay is destroyed, otherwise + * it is cached for reuse. + */ + unmask : function(removeEl){ + if(this._mask){ + if(removeEl === true){ + this._mask.remove(); + delete this._mask; + if(this._maskMsg){ + this._maskMsg.remove(); + delete this._maskMsg; + } + }else{ + this._mask.setDisplayed(false); + if(this._maskMsg){ + this._maskMsg.setDisplayed(false); + } + } + } + this.removeClass("x-masked"); + }, + + /** + * Returns true if this element is masked + * @return {Boolean} + */ + isMasked : function(){ + return this._mask && this._mask.isVisible(); + }, + + /** + * Creates an iframe shim for this element to keep selects and other windowed objects from + * showing through. + * @return {Roo.Element} The new shim element + */ + createShim : function(){ + var el = document.createElement('iframe'); + el.frameBorder = 'no'; + el.className = 'roo-shim'; + if(Roo.isIE && Roo.isSecure){ + el.src = Roo.SSL_SECURE_URL; + } + var shim = Roo.get(this.dom.parentNode.insertBefore(el, this.dom)); + shim.autoBoxAdjust = false; + return shim; + }, + + /** + * Removes this element from the DOM and deletes it from the cache + */ + remove : function(){ + if(this.dom.parentNode){ + this.dom.parentNode.removeChild(this.dom); + } + delete El.cache[this.dom.id]; + }, + + /** + * Sets up event handlers to add and remove a css class when the mouse is over this element + * @param {String} className + * @param {Boolean} preventFlicker (optional) If set to true, it prevents flickering by filtering + * mouseout events for children elements + * @return {Roo.Element} this + */ + addClassOnOver : function(className, preventFlicker){ + this.on("mouseover", function(){ + Roo.fly(this, '_internal').addClass(className); + }, this.dom); + var removeFn = function(e){ + if(preventFlicker !== true || !e.within(this, true)){ + Roo.fly(this, '_internal').removeClass(className); + } + }; + this.on("mouseout", removeFn, this.dom); + return this; + }, + + /** + * Sets up event handlers to add and remove a css class when this element has the focus + * @param {String} className + * @return {Roo.Element} this + */ + addClassOnFocus : function(className){ + this.on("focus", function(){ + Roo.fly(this, '_internal').addClass(className); + }, this.dom); + this.on("blur", function(){ + Roo.fly(this, '_internal').removeClass(className); + }, this.dom); + return this; + }, + /** + * Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect) + * @param {String} className + * @return {Roo.Element} this + */ + addClassOnClick : function(className){ + var dom = this.dom; + this.on("mousedown", function(){ + Roo.fly(dom, '_internal').addClass(className); + var d = Roo.get(document); + var fn = function(){ + Roo.fly(dom, '_internal').removeClass(className); + d.removeListener("mouseup", fn); + }; + d.on("mouseup", fn); + }); + return this; + }, + + /** + * Stops the specified event from bubbling and optionally prevents the default action + * @param {String} eventName + * @param {Boolean} preventDefault (optional) true to prevent the default action too + * @return {Roo.Element} this + */ + swallowEvent : function(eventName, preventDefault){ + var fn = function(e){ + e.stopPropagation(); + if(preventDefault){ + e.preventDefault(); + } + }; + if(eventName instanceof Array){ + for(var i = 0, len = eventName.length; i < len; i++){ + this.on(eventName[i], fn); + } + return this; + } + this.on(eventName, fn); + return this; + }, + + /** + * @private + */ + fitToParentDelegate : Roo.emptyFn, // keep a reference to the fitToParent delegate + + /** + * Sizes this element to its parent element's dimensions performing + * neccessary box adjustments. + * @param {Boolean} monitorResize (optional) If true maintains the fit when the browser window is resized. + * @param {String/HTMLElment/Element} targetParent (optional) The target parent, default to the parentNode. + * @return {Roo.Element} this + */ + fitToParent : function(monitorResize, targetParent) { + Roo.EventManager.removeResizeListener(this.fitToParentDelegate); // always remove previous fitToParent delegate from onWindowResize + this.fitToParentDelegate = Roo.emptyFn; // remove reference to previous delegate + if (monitorResize === true && !this.dom.parentNode) { // check if this Element still exists + return; + } + var p = Roo.get(targetParent || this.dom.parentNode); + this.setSize(p.getComputedWidth() - p.getFrameWidth('lr'), p.getComputedHeight() - p.getFrameWidth('tb')); + if (monitorResize === true) { + this.fitToParentDelegate = this.fitToParent.createDelegate(this, [true, targetParent]); + Roo.EventManager.onWindowResize(this.fitToParentDelegate); + } + return this; + }, + + /** + * Gets the next sibling, skipping text nodes + * @return {HTMLElement} The next sibling or null + */ + getNextSibling : function(){ + var n = this.dom.nextSibling; + while(n && n.nodeType != 1){ + n = n.nextSibling; + } + return n; + }, + + /** + * Gets the previous sibling, skipping text nodes + * @return {HTMLElement} The previous sibling or null + */ + getPrevSibling : function(){ + var n = this.dom.previousSibling; + while(n && n.nodeType != 1){ + n = n.previousSibling; + } + return n; + }, + + + /** + * Appends the passed element(s) to this element + * @param {String/HTMLElement/Array/Element/CompositeElement} el + * @return {Roo.Element} this + */ + appendChild: function(el){ + el = Roo.get(el); + el.appendTo(this); + return this; + }, + + /** + * Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element. + * @param {Object} config DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be + * automatically generated with the specified attributes. + * @param {HTMLElement} insertBefore (optional) a child element of this element + * @param {Boolean} returnDom (optional) true to return the dom node instead of creating an Element + * @return {Roo.Element} The new child element + */ + createChild: function(config, insertBefore, returnDom){ + config = config || {tag:'div'}; + if(insertBefore){ + return Roo.DomHelper.insertBefore(insertBefore, config, returnDom !== true); + } + return Roo.DomHelper[!this.dom.firstChild ? 'overwrite' : 'append'](this.dom, config, returnDom !== true); + }, + + /** + * Appends this element to the passed element + * @param {String/HTMLElement/Element} el The new parent element + * @return {Roo.Element} this + */ + appendTo: function(el){ + el = Roo.getDom(el); + el.appendChild(this.dom); + return this; + }, + + /** + * Inserts this element before the passed element in the DOM + * @param {String/HTMLElement/Element} el The element to insert before + * @return {Roo.Element} this + */ + insertBefore: function(el){ + el = Roo.getDom(el); + el.parentNode.insertBefore(this.dom, el); + return this; + }, + + /** + * Inserts this element after the passed element in the DOM + * @param {String/HTMLElement/Element} el The element to insert after + * @return {Roo.Element} this + */ + insertAfter: function(el){ + el = Roo.getDom(el); + el.parentNode.insertBefore(this.dom, el.nextSibling); + return this; + }, + + /** + * Inserts (or creates) an element (or DomHelper config) as the first child of the this element + * @param {String/HTMLElement/Element/Object} el The id or element to insert or a DomHelper config to create and insert + * @return {Roo.Element} The new child + */ + insertFirst: function(el, returnDom){ + el = el || {}; + if(typeof el == 'object' && !el.nodeType){ // dh config + return this.createChild(el, this.dom.firstChild, returnDom); + }else{ + el = Roo.getDom(el); + this.dom.insertBefore(el, this.dom.firstChild); + return !returnDom ? Roo.get(el) : el; + } + }, + + /** + * Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element + * @param {String/HTMLElement/Element/Object} el The id or element to insert or a DomHelper config to create and insert + * @param {String} where (optional) 'before' or 'after' defaults to before + * @param {Boolean} returnDom (optional) True to return the raw DOM element instead of Roo.Element + * @return {Roo.Element} the inserted Element + */ + insertSibling: function(el, where, returnDom){ + where = where ? where.toLowerCase() : 'before'; + el = el || {}; + var rt, refNode = where == 'before' ? this.dom : this.dom.nextSibling; + + if(typeof el == 'object' && !el.nodeType){ // dh config + if(where == 'after' && !this.dom.nextSibling){ + rt = Roo.DomHelper.append(this.dom.parentNode, el, !returnDom); + }else{ + rt = Roo.DomHelper[where == 'after' ? 'insertAfter' : 'insertBefore'](this.dom, el, !returnDom); + } + + }else{ + rt = this.dom.parentNode.insertBefore(Roo.getDom(el), + where == 'before' ? this.dom : this.dom.nextSibling); + if(!returnDom){ + rt = Roo.get(rt); + } + } + return rt; + }, + + /** + * Creates and wraps this element with another element + * @param {Object} config (optional) DomHelper element config object for the wrapper element or null for an empty div + * @param {Boolean} returnDom (optional) True to return the raw DOM element instead of Roo.Element + * @return {HTMLElement/Element} The newly created wrapper element + */ + wrap: function(config, returnDom){ + if(!config){ + config = {tag: "div"}; + } + var newEl = Roo.DomHelper.insertBefore(this.dom, config, !returnDom); + newEl.dom ? newEl.dom.appendChild(this.dom) : newEl.appendChild(this.dom); + return newEl; + }, + + /** + * Replaces the passed element with this element + * @param {String/HTMLElement/Element} el The element to replace + * @return {Roo.Element} this + */ + replace: function(el){ + el = Roo.get(el); + this.insertBefore(el); + el.remove(); + return this; + }, + + /** + * Inserts an html fragment into this element + * @param {String} where Where to insert the html in relation to the this element - beforeBegin, afterBegin, beforeEnd, afterEnd. + * @param {String} html The HTML fragment + * @param {Boolean} returnEl True to return an Roo.Element + * @return {HTMLElement/Roo.Element} The inserted node (or nearest related if more than 1 inserted) + */ + insertHtml : function(where, html, returnEl){ + var el = Roo.DomHelper.insertHtml(where, this.dom, html); + return returnEl ? Roo.get(el) : el; + }, + + /** + * Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function) + * @param {Object} o The object with the attributes + * @param {Boolean} useSet (optional) false to override the default setAttribute to use expandos. + * @return {Roo.Element} this + */ + set : function(o, useSet){ + var el = this.dom; + useSet = typeof useSet == 'undefined' ? (el.setAttribute ? true : false) : useSet; + for(var attr in o){ + if(attr == "style" || typeof o[attr] == "function") { continue; } + if(attr=="cls"){ + el.className = o["cls"]; + }else{ + if(useSet) { + el.setAttribute(attr, o[attr]); + } else { + el[attr] = o[attr]; + } + } + } + if(o.style){ + Roo.DomHelper.applyStyles(el, o.style); + } + return this; + }, + + /** + * Convenience method for constructing a KeyMap + * @param {Number/Array/Object/String} key Either a string with the keys to listen for, the numeric key code, array of key codes or an object with the following options: + * {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)} + * @param {Function} fn The function to call + * @param {Object} scope (optional) The scope of the function + * @return {Roo.KeyMap} The KeyMap created + */ + addKeyListener : function(key, fn, scope){ + var config; + if(typeof key != "object" || key instanceof Array){ + config = { + key: key, + fn: fn, + scope: scope + }; + }else{ + config = { + key : key.key, + shift : key.shift, + ctrl : key.ctrl, + alt : key.alt, + fn: fn, + scope: scope + }; + } + return new Roo.KeyMap(this, config); + }, + + /** + * Creates a KeyMap for this element + * @param {Object} config The KeyMap config. See {@link Roo.KeyMap} for more details + * @return {Roo.KeyMap} The KeyMap created + */ + addKeyMap : function(config){ + return new Roo.KeyMap(this, config); + }, + + /** + * Returns true if this element is scrollable. + * @return {Boolean} + */ + isScrollable : function(){ + var dom = this.dom; + return dom.scrollHeight > dom.clientHeight || dom.scrollWidth > dom.clientWidth; + }, + + /** + * Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it will try to do it. For auto bounds checking, use scroll(). + * @param {String} side Either "left" for scrollLeft values or "top" for scrollTop values. + * @param {Number} value The new scroll value + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Element} this + */ + + scrollTo : function(side, value, animate){ + var prop = side.toLowerCase() == "left" ? "scrollLeft" : "scrollTop"; + if(!animate || !A){ + this.dom[prop] = value; + }else{ + var to = prop == "scrollLeft" ? [value, this.dom.scrollTop] : [this.dom.scrollLeft, value]; + this.anim({scroll: {"to": to}}, this.preanim(arguments, 2), 'scroll'); + } + return this; + }, + + /** + * Scrolls this element the specified direction. Does bounds checking to make sure the scroll is + * within this element's scrollable range. + * @param {String} direction Possible values are: "l","left" - "r","right" - "t","top","up" - "b","bottom","down". + * @param {Number} distance How far to scroll the element in pixels + * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object + * @return {Boolean} Returns true if a scroll was triggered or false if the element + * was scrolled as far as it could go. + */ + scroll : function(direction, distance, animate){ + if(!this.isScrollable()){ + return; + } + var el = this.dom; + var l = el.scrollLeft, t = el.scrollTop; + var w = el.scrollWidth, h = el.scrollHeight; + var cw = el.clientWidth, ch = el.clientHeight; + direction = direction.toLowerCase(); + var scrolled = false; + var a = this.preanim(arguments, 2); + switch(direction){ + case "l": + case "left": + if(w - l > cw){ + var v = Math.min(l + distance, w-cw); + this.scrollTo("left", v, a); + scrolled = true; + } + break; + case "r": + case "right": + if(l > 0){ + var v = Math.max(l - distance, 0); + this.scrollTo("left", v, a); + scrolled = true; + } + break; + case "t": + case "top": + case "up": + if(t > 0){ + var v = Math.max(t - distance, 0); + this.scrollTo("top", v, a); + scrolled = true; + } + break; + case "b": + case "bottom": + case "down": + if(h - t > ch){ + var v = Math.min(t + distance, h-ch); + this.scrollTo("top", v, a); + scrolled = true; + } + break; + } + return scrolled; + }, + + /** + * Translates the passed page coordinates into left/top css values for this element + * @param {Number/Array} x The page x or an array containing [x, y] + * @param {Number} y The page y + * @return {Object} An object with left and top properties. e.g. {left: (value), top: (value)} + */ + translatePoints : function(x, y){ + if(typeof x == 'object' || x instanceof Array){ + y = x[1]; x = x[0]; + } + var p = this.getStyle('position'); + var o = this.getXY(); + + var l = parseInt(this.getStyle('left'), 10); + var t = parseInt(this.getStyle('top'), 10); + + if(isNaN(l)){ + l = (p == "relative") ? 0 : this.dom.offsetLeft; + } + if(isNaN(t)){ + t = (p == "relative") ? 0 : this.dom.offsetTop; + } + + return {left: (x - o[0] + l), top: (y - o[1] + t)}; + }, + + /** + * Returns the current scroll position of the element. + * @return {Object} An object containing the scroll position in the format {left: (scrollLeft), top: (scrollTop)} + */ + getScroll : function(){ + var d = this.dom, doc = document; + if(d == doc || d == doc.body){ + var l = window.pageXOffset || doc.documentElement.scrollLeft || doc.body.scrollLeft || 0; + var t = window.pageYOffset || doc.documentElement.scrollTop || doc.body.scrollTop || 0; + return {left: l, top: t}; + }else{ + return {left: d.scrollLeft, top: d.scrollTop}; + } + }, + + /** + * Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values + * are convert to standard 6 digit hex color. + * @param {String} attr The css attribute + * @param {String} defaultValue The default value to use when a valid color isn't found + * @param {String} prefix (optional) defaults to #. Use an empty string when working with + * YUI color anims. + */ + getColor : function(attr, defaultValue, prefix){ + var v = this.getStyle(attr); + if(!v || v == "transparent" || v == "inherit") { + return defaultValue; + } + var color = typeof prefix == "undefined" ? "#" : prefix; + if(v.substr(0, 4) == "rgb("){ + var rvs = v.slice(4, v.length -1).split(","); + for(var i = 0; i < 3; i++){ + var h = parseInt(rvs[i]).toString(16); + if(h < 16){ + h = "0" + h; + } + color += h; + } + } else { + if(v.substr(0, 1) == "#"){ + if(v.length == 4) { + for(var i = 1; i < 4; i++){ + var c = v.charAt(i); + color += c + c; + } + }else if(v.length == 7){ + color += v.substr(1); + } + } + } + return(color.length > 5 ? color.toLowerCase() : defaultValue); + }, + + /** + * Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a + * gradient background, rounded corners and a 4-way shadow. + * @param {String} class (optional) A base CSS class to apply to the containing wrapper element (defaults to 'x-box'). + * Note that there are a number of CSS rules that are dependent on this name to make the overall effect work, + * so if you supply an alternate base class, make sure you also supply all of the necessary rules. + * @return {Roo.Element} this + */ + boxWrap : function(cls){ + cls = cls || 'x-box'; + var el = Roo.get(this.insertHtml('beforeBegin', String.format('<div class="{0}">'+El.boxMarkup+'</div>', cls))); + el.child('.'+cls+'-mc').dom.appendChild(this.dom); + return el; + }, + + /** + * Returns the value of a namespaced attribute from the element's underlying DOM node. + * @param {String} namespace The namespace in which to look for the attribute + * @param {String} name The attribute name + * @return {String} The attribute value + */ + getAttributeNS : Roo.isIE ? function(ns, name){ + var d = this.dom; + var type = typeof d[ns+":"+name]; + if(type != 'undefined' && type != 'unknown'){ + return d[ns+":"+name]; + } + return d[name]; + } : function(ns, name){ + var d = this.dom; + return d.getAttributeNS(ns, name) || d.getAttribute(ns+":"+name) || d.getAttribute(name) || d[name]; + }, + + + /** + * Sets or Returns the value the dom attribute value + * @param {String|Object} name The attribute name (or object to set multiple attributes) + * @param {String} value (optional) The value to set the attribute to + * @return {String} The attribute value + */ + attr : function(name){ + if (arguments.length > 1) { + this.dom.setAttribute(name, arguments[1]); + return arguments[1]; + } + if (typeof(name) == 'object') { + for(var i in name) { + this.attr(i, name[i]); + } + return name; + } + + + if (!this.dom.hasAttribute(name)) { + return undefined; + } + return this.dom.getAttribute(name); + } + + + + }; + + var ep = El.prototype; + + /** + * Appends an event handler (Shorthand for addListener) + * @param {String} eventName The type of event to append + * @param {Function} fn The method the event invokes + * @param {Object} scope (optional) The scope (this object) of the fn + * @param {Object} options (optional)An object with standard {@link Roo.EventManager#addListener} options + * @method + */ + ep.on = ep.addListener; + // backwards compat + ep.mon = ep.addListener; + + /** + * Removes an event handler from this element (shorthand for removeListener) + * @param {String} eventName the type of event to remove + * @param {Function} fn the method the event invokes + * @return {Roo.Element} this + * @method + */ + ep.un = ep.removeListener; + + /** + * true to automatically adjust width and height settings for box-model issues (default to true) + */ + ep.autoBoxAdjust = true; + + // private + El.unitPattern = /\d+(px|em|%|en|ex|pt|in|cm|mm|pc)$/i; + + // private + El.addUnits = function(v, defaultUnit){ + if(v === "" || v == "auto"){ + return v; + } + if(v === undefined){ + return ''; + } + if(typeof v == "number" || !El.unitPattern.test(v)){ + return v + (defaultUnit || 'px'); + } + return v; + }; + + // special markup used throughout Roo when box wrapping elements + El.boxMarkup = '<div class="{0}-tl"><div class="{0}-tr"><div class="{0}-tc"></div></div></div><div class="{0}-ml"><div class="{0}-mr"><div class="{0}-mc"></div></div></div><div class="{0}-bl"><div class="{0}-br"><div class="{0}-bc"></div></div></div>'; + /** + * Visibility mode constant - Use visibility to hide element + * @static + * @type Number + */ + El.VISIBILITY = 1; + /** + * Visibility mode constant - Use display to hide element + * @static + * @type Number + */ + El.DISPLAY = 2; + + El.borders = {l: "border-left-width", r: "border-right-width", t: "border-top-width", b: "border-bottom-width"}; + El.paddings = {l: "padding-left", r: "padding-right", t: "padding-top", b: "padding-bottom"}; + El.margins = {l: "margin-left", r: "margin-right", t: "margin-top", b: "margin-bottom"}; + + + + /** + * @private + */ + El.cache = {}; + + var docEl; + + /** + * Static method to retrieve Element objects. Uses simple caching to consistently return the same object. + * Automatically fixes if an object was recreated with the same id via AJAX or DOM. + * @param {String/HTMLElement/Element} el The id of the node, a DOM Node or an existing Element. + * @return {Element} The Element object + * @static + */ + El.get = function(el){ + var ex, elm, id; + if(!el){ return null; } + if(typeof el == "string"){ // element id + if(!(elm = document.getElementById(el))){ + return null; + } + if(ex = El.cache[el]){ + ex.dom = elm; + }else{ + ex = El.cache[el] = new El(elm); + } + return ex; + }else if(el.tagName){ // dom element + if(!(id = el.id)){ + id = Roo.id(el); + } + if(ex = El.cache[id]){ + ex.dom = el; + }else{ + ex = El.cache[id] = new El(el); + } + return ex; + }else if(el instanceof El){ + if(el != docEl){ + el.dom = document.getElementById(el.id) || el.dom; // refresh dom element in case no longer valid, + // catch case where it hasn't been appended + El.cache[el.id] = el; // in case it was created directly with Element(), let's cache it + } + return el; + }else if(el.isComposite){ + return el; + }else if(el instanceof Array){ + return El.select(el); + }else if(el == document){ + // create a bogus element object representing the document object + if(!docEl){ + var f = function(){}; + f.prototype = El.prototype; + docEl = new f(); + docEl.dom = document; + } + return docEl; + } + return null; + }; + + // private + El.uncache = function(el){ + for(var i = 0, a = arguments, len = a.length; i < len; i++) { + if(a[i]){ + delete El.cache[a[i].id || a[i]]; + } + } + }; + + // private + // Garbage collection - uncache elements/purge listeners on orphaned elements + // so we don't hold a reference and cause the browser to retain them + El.garbageCollect = function(){ + if(!Roo.enableGarbageCollector){ + clearInterval(El.collectorThread); + return; + } + for(var eid in El.cache){ + var el = El.cache[eid], d = el.dom; + // ------------------------------------------------------- + // Determining what is garbage: + // ------------------------------------------------------- + // !d + // dom node is null, definitely garbage + // ------------------------------------------------------- + // !d.parentNode + // no parentNode == direct orphan, definitely garbage + // ------------------------------------------------------- + // !d.offsetParent && !document.getElementById(eid) + // display none elements have no offsetParent so we will + // also try to look it up by it's id. However, check + // offsetParent first so we don't do unneeded lookups. + // This enables collection of elements that are not orphans + // directly, but somewhere up the line they have an orphan + // parent. + // ------------------------------------------------------- + if(!d || !d.parentNode || (!d.offsetParent && !document.getElementById(eid))){ + delete El.cache[eid]; + if(d && Roo.enableListenerCollection){ + E.purgeElement(d); + } + } + } + } + El.collectorThreadId = setInterval(El.garbageCollect, 30000); + + + // dom is optional + El.Flyweight = function(dom){ + this.dom = dom; + }; + El.Flyweight.prototype = El.prototype; + + El._flyweights = {}; + /** + * Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element - + * the dom node can be overwritten by other code. + * @param {String/HTMLElement} el The dom node or id + * @param {String} named (optional) Allows for creation of named reusable flyweights to + * prevent conflicts (e.g. internally Roo uses "_internal") + * @static + * @return {Element} The shared Element object + */ + El.fly = function(el, named){ + named = named || '_global'; + el = Roo.getDom(el); + if(!el){ + return null; + } + if(!El._flyweights[named]){ + El._flyweights[named] = new El.Flyweight(); + } + El._flyweights[named].dom = el; + return El._flyweights[named]; + }; + + /** + * Static method to retrieve Element objects. Uses simple caching to consistently return the same object. + * Automatically fixes if an object was recreated with the same id via AJAX or DOM. + * Shorthand of {@link Roo.Element#get} + * @param {String/HTMLElement/Element} el The id of the node, a DOM Node or an existing Element. + * @return {Element} The Element object + * @member Roo + * @method get + */ + Roo.get = El.get; + /** + * Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element - + * the dom node can be overwritten by other code. + * Shorthand of {@link Roo.Element#fly} + * @param {String/HTMLElement} el The dom node or id + * @param {String} named (optional) Allows for creation of named reusable flyweights to + * prevent conflicts (e.g. internally Roo uses "_internal") + * @static + * @return {Element} The shared Element object + * @member Roo + * @method fly + */ + Roo.fly = El.fly; + + // speedy lookup for elements never to box adjust + var noBoxAdjust = Roo.isStrict ? { + select:1 + } : { + input:1, select:1, textarea:1 + }; + if(Roo.isIE || Roo.isGecko){ + noBoxAdjust['button'] = 1; + } + + + Roo.EventManager.on(window, 'unload', function(){ + delete El.cache; + delete El._flyweights; + }); +})(); + + + + +if(Roo.DomQuery){ + Roo.Element.selectorFunction = Roo.DomQuery.select; +} + +Roo.Element.select = function(selector, unique, root){ + var els; + if(typeof selector == "string"){ + els = Roo.Element.selectorFunction(selector, root); + }else if(selector.length !== undefined){ + els = selector; + }else{ + throw "Invalid selector"; + } + if(unique === true){ + return new Roo.CompositeElement(els); + }else{ + return new Roo.CompositeElementLite(els); + } +}; +/** + * Selects elements based on the passed CSS selector to enable working on them as 1. + * @param {String/Array} selector The CSS selector or an array of elements + * @param {Boolean} unique (optional) true to create a unique Roo.Element for each element (defaults to a shared flyweight object) + * @param {HTMLElement/String} root (optional) The root element of the query or id of the root + * @return {CompositeElementLite/CompositeElement} + * @member Roo + * @method select + */ +Roo.select = Roo.Element.select; + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs2/src/Roo_EventManager.js.html b/docs2/src/Roo_EventManager.js.html new file mode 100644 index 0000000000..6c45ace77d --- /dev/null +++ b/docs2/src/Roo_EventManager.js.html @@ -0,0 +1,881 @@ +/home/alan/gitlive/roojs1/Roo/EventManager.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.EventManager + * Registers event handlers that want to receive a normalized EventObject instead of the standard browser event and provides + * several useful events directly. + * See {@link Roo.EventObject} for more details on normalized event objects. + * @singleton + */ +Roo.EventManager = function(){ + var docReadyEvent, docReadyProcId, docReadyState = false; + var resizeEvent, resizeTask, textEvent, textSize; + var E = Roo.lib.Event; + var D = Roo.lib.Dom; + + + + + var fireDocReady = function(){ + if(!docReadyState){ + docReadyState = true; + Roo.isReady = true; + if(docReadyProcId){ + clearInterval(docReadyProcId); + } + if(Roo.isGecko || Roo.isOpera) { + document.removeEventListener("DOMContentLoaded", fireDocReady, false); + } + if(Roo.isIE){ + var defer = document.getElementById("ie-deferred-loader"); + if(defer){ + defer.onreadystatechange = null; + defer.parentNode.removeChild(defer); + } + } + if(docReadyEvent){ + docReadyEvent.fire(); + docReadyEvent.clearListeners(); + } + } + }; + + var initDocReady = function(){ + docReadyEvent = new Roo.util.Event(); + if(Roo.isGecko || Roo.isOpera) { + document.addEventListener("DOMContentLoaded", fireDocReady, false); + }else if(Roo.isIE){ + document.write("<s"+'cript id="ie-deferred-loader" defer="defer" src="/'+'/:"></s'+"cript>"); + var defer = document.getElementById("ie-deferred-loader"); + defer.onreadystatechange = function(){ + if(this.readyState == "complete"){ + fireDocReady(); + } + }; + }else if(Roo.isSafari){ + docReadyProcId = setInterval(function(){ + var rs = document.readyState; + if(rs == "complete") { + fireDocReady(); + } + }, 10); + } + // no matter what, make sure it fires on load + E.on(window, "load", fireDocReady); + }; + + var createBuffered = function(h, o){ + var task = new Roo.util.DelayedTask(h); + return function(e){ + // create new event object impl so new events don't wipe out properties + e = new Roo.EventObjectImpl(e); + task.delay(o.buffer, h, null, [e]); + }; + }; + + var createSingle = function(h, el, ename, fn){ + return function(e){ + Roo.EventManager.removeListener(el, ename, fn); + h(e); + }; + }; + + var createDelayed = function(h, o){ + return function(e){ + // create new event object impl so new events don't wipe out properties + e = new Roo.EventObjectImpl(e); + setTimeout(function(){ + h(e); + }, o.delay || 10); + }; + }; + var transitionEndVal = false; + + var transitionEnd = function() + { + if (transitionEndVal) { + return transitionEndVal; + } + var el = document.createElement('div'); + + var transEndEventNames = { + WebkitTransition : 'webkitTransitionEnd', + MozTransition : 'transitionend', + OTransition : 'oTransitionEnd otransitionend', + transition : 'transitionend' + }; + + for (var name in transEndEventNames) { + if (el.style[name] !== undefined) { + transitionEndVal = transEndEventNames[name]; + return transitionEndVal ; + } + } + } + + + var listen = function(element, ename, opt, fn, scope){ + var o = (!opt || typeof opt == "boolean") ? {} : opt; + fn = fn || o.fn; scope = scope || o.scope; + var el = Roo.getDom(element); + + + if(!el){ + throw "Error listening for \"" + ename + '\". Element "' + element + '" doesn\'t exist.'; + } + + if (ename == 'transitionend') { + ename = transitionEnd(); + } + var h = function(e){ + e = Roo.EventObject.setEvent(e); + var t; + if(o.delegate){ + t = e.getTarget(o.delegate, el); + if(!t){ + return; + } + }else{ + t = e.target; + } + if(o.stopEvent === true){ + e.stopEvent(); + } + if(o.preventDefault === true){ + e.preventDefault(); + } + if(o.stopPropagation === true){ + e.stopPropagation(); + } + + if(o.normalized === false){ + e = e.browserEvent; + } + + fn.call(scope || el, e, t, o); + }; + if(o.delay){ + h = createDelayed(h, o); + } + if(o.single){ + h = createSingle(h, el, ename, fn); + } + if(o.buffer){ + h = createBuffered(h, o); + } + + fn._handlers = fn._handlers || []; + + + fn._handlers.push([Roo.id(el), ename, h]); + + + + E.on(el, ename, h); + if(ename == "mousewheel" && el.addEventListener){ // workaround for jQuery + el.addEventListener("DOMMouseScroll", h, false); + E.on(window, 'unload', function(){ + el.removeEventListener("DOMMouseScroll", h, false); + }); + } + if(ename == "mousedown" && el == document){ // fix stopped mousedowns on the document + Roo.EventManager.stoppedMouseDownEvent.addListener(h); + } + return h; + }; + + var stopListening = function(el, ename, fn){ + var id = Roo.id(el), hds = fn._handlers, hd = fn; + if(hds){ + for(var i = 0, len = hds.length; i < len; i++){ + var h = hds[i]; + if(h[0] == id && h[1] == ename){ + hd = h[2]; + hds.splice(i, 1); + break; + } + } + } + E.un(el, ename, hd); + el = Roo.getDom(el); + if(ename == "mousewheel" && el.addEventListener){ + el.removeEventListener("DOMMouseScroll", hd, false); + } + if(ename == "mousedown" && el == document){ // fix stopped mousedowns on the document + Roo.EventManager.stoppedMouseDownEvent.removeListener(hd); + } + }; + + var propRe = /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate)$/; + + var pub = { + + + /** + * Fix for doc tools + * @scope Roo.EventManager + */ + + + /** + * This is no longer needed and is deprecated. Places a simple wrapper around an event handler to override the browser event + * object with a Roo.EventObject + * @param {Function} fn The method the event invokes + * @param {Object} scope An object that becomes the scope of the handler + * @param {boolean} override If true, the obj passed in becomes + * the execution scope of the listener + * @return {Function} The wrapped function + * @deprecated + */ + wrap : function(fn, scope, override){ + return function(e){ + Roo.EventObject.setEvent(e); + fn.call(override ? scope || window : window, Roo.EventObject, scope); + }; + }, + + /** + * Appends an event handler to an element (shorthand for addListener) + * @param {String/HTMLElement} element The html element or id to assign the + * @param {String} eventName The type of event to listen for + * @param {Function} handler The method the event invokes + * @param {Object} scope (optional) The scope in which to execute the handler + * function. The handler function's "this" context. + * @param {Object} options (optional) An object containing handler configuration + * properties. This may contain any of the following properties:<ul> + * <li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li> + * <li>delegate {String} A simple selector to filter the target or look for a descendant of the target</li> + * <li>stopEvent {Boolean} True to stop the event. That is stop propagation, and prevent the default action.</li> + * <li>preventDefault {Boolean} True to prevent the default action</li> + * <li>stopPropagation {Boolean} True to prevent event propagation</li> + * <li>normalized {Boolean} False to pass a browser event to the handler function instead of an Roo.EventObject</li> + * <li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li> + * <li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li> + * <li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed + * by the specified number of milliseconds. If the event fires again within that time, the original + * handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li> + * </ul><br> + * <p> + * <b>Combining Options</b><br> + * Using the options argument, it is possible to combine different types of listeners:<br> + * <br> + * A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<div style="margin: 5px 20px 20px;"> + * Code:<pre><code> +el.on('click', this.onClick, this, { + single: true, + delay: 100, + stopEvent : true, + forumId: 4 +});</code></pre> + * <p> + * <b>Attaching multiple handlers in 1 call</b><br> + * The method also allows for a single argument to be passed which is a config object containing properties + * which specify multiple handlers. + * <p> + * Code:<pre><code> +el.on({ + 'click' : { + fn: this.onClick + scope: this, + delay: 100 + }, + 'mouseover' : { + fn: this.onMouseOver + scope: this + }, + 'mouseout' : { + fn: this.onMouseOut + scope: this + } +});</code></pre> + * <p> + * Or a shorthand syntax:<br> + * Code:<pre><code> +el.on({ + 'click' : this.onClick, + 'mouseover' : this.onMouseOver, + 'mouseout' : this.onMouseOut + scope: this +});</code></pre> + */ + addListener : function(element, eventName, fn, scope, options){ + if(typeof eventName == "object"){ + var o = eventName; + for(var e in o){ + if(propRe.test(e)){ + continue; + } + if(typeof o[e] == "function"){ + // shared options + listen(element, e, o, o[e], o.scope); + }else{ + // individual options + listen(element, e, o[e]); + } + } + return; + } + return listen(element, eventName, options, fn, scope); + }, + + /** + * Removes an event handler + * + * @param {String/HTMLElement} element The id or html element to remove the + * event from + * @param {String} eventName The type of event + * @param {Function} fn + * @return {Boolean} True if a listener was actually removed + */ + removeListener : function(element, eventName, fn){ + return stopListening(element, eventName, fn); + }, + + /** + * Fires when the document is ready (before onload and before images are loaded). Can be + * accessed shorthanded Roo.onReady(). + * @param {Function} fn The method the event invokes + * @param {Object} scope An object that becomes the scope of the handler + * @param {boolean} options + */ + onDocumentReady : function(fn, scope, options){ + if(docReadyState){ // if it already fired + docReadyEvent.addListener(fn, scope, options); + docReadyEvent.fire(); + docReadyEvent.clearListeners(); + return; + } + if(!docReadyEvent){ + initDocReady(); + } + docReadyEvent.addListener(fn, scope, options); + }, + + /** + * Fires when the window is resized and provides resize event buffering (50 milliseconds), passes new viewport width and height to handlers. + * @param {Function} fn The method the event invokes + * @param {Object} scope An object that becomes the scope of the handler + * @param {boolean} options + */ + onWindowResize : function(fn, scope, options){ + if(!resizeEvent){ + resizeEvent = new Roo.util.Event(); + resizeTask = new Roo.util.DelayedTask(function(){ + resizeEvent.fire(D.getViewWidth(), D.getViewHeight()); + }); + E.on(window, "resize", function(){ + if(Roo.isIE){ + resizeTask.delay(50); + }else{ + resizeEvent.fire(D.getViewWidth(), D.getViewHeight()); + } + }); + } + resizeEvent.addListener(fn, scope, options); + }, + + /** + * Fires when the user changes the active text size. Handler gets called with 2 params, the old size and the new size. + * @param {Function} fn The method the event invokes + * @param {Object} scope An object that becomes the scope of the handler + * @param {boolean} options + */ + onTextResize : function(fn, scope, options){ + if(!textEvent){ + textEvent = new Roo.util.Event(); + var textEl = new Roo.Element(document.createElement('div')); + textEl.dom.className = 'x-text-resize'; + textEl.dom.innerHTML = 'X'; + textEl.appendTo(document.body); + textSize = textEl.dom.offsetHeight; + setInterval(function(){ + if(textEl.dom.offsetHeight != textSize){ + textEvent.fire(textSize, textSize = textEl.dom.offsetHeight); + } + }, this.textResizeInterval); + } + textEvent.addListener(fn, scope, options); + }, + + /** + * Removes the passed window resize listener. + * @param {Function} fn The method the event invokes + * @param {Object} scope The scope of handler + */ + removeResizeListener : function(fn, scope){ + if(resizeEvent){ + resizeEvent.removeListener(fn, scope); + } + }, + + // private + fireResize : function(){ + if(resizeEvent){ + resizeEvent.fire(D.getViewWidth(), D.getViewHeight()); + } + }, + /** + * Url used for onDocumentReady with using SSL (defaults to Roo.SSL_SECURE_URL) + */ + ieDeferSrc : false, + /** + * The frequency, in milliseconds, to check for text resize events (defaults to 50) + */ + textResizeInterval : 50 + }; + + /** + * Fix for doc tools + * @scopeAlias pub=Roo.EventManager + */ + + /** + * Appends an event handler to an element (shorthand for addListener) + * @param {String/HTMLElement} element The html element or id to assign the + * @param {String} eventName The type of event to listen for + * @param {Function} handler The method the event invokes + * @param {Object} scope (optional) The scope in which to execute the handler + * function. The handler function's "this" context. + * @param {Object} options (optional) An object containing handler configuration + * properties. This may contain any of the following properties:<ul> + * <li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li> + * <li>delegate {String} A simple selector to filter the target or look for a descendant of the target</li> + * <li>stopEvent {Boolean} True to stop the event. That is stop propagation, and prevent the default action.</li> + * <li>preventDefault {Boolean} True to prevent the default action</li> + * <li>stopPropagation {Boolean} True to prevent event propagation</li> + * <li>normalized {Boolean} False to pass a browser event to the handler function instead of an Roo.EventObject</li> + * <li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li> + * <li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li> + * <li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed + * by the specified number of milliseconds. If the event fires again within that time, the original + * handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li> + * </ul><br> + * <p> + * <b>Combining Options</b><br> + * Using the options argument, it is possible to combine different types of listeners:<br> + * <br> + * A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<div style="margin: 5px 20px 20px;"> + * Code:<pre><code> +el.on('click', this.onClick, this, { + single: true, + delay: 100, + stopEvent : true, + forumId: 4 +});</code></pre> + * <p> + * <b>Attaching multiple handlers in 1 call</b><br> + * The method also allows for a single argument to be passed which is a config object containing properties + * which specify multiple handlers. + * <p> + * Code:<pre><code> +el.on({ + 'click' : { + fn: this.onClick + scope: this, + delay: 100 + }, + 'mouseover' : { + fn: this.onMouseOver + scope: this + }, + 'mouseout' : { + fn: this.onMouseOut + scope: this + } +});</code></pre> + * <p> + * Or a shorthand syntax:<br> + * Code:<pre><code> +el.on({ + 'click' : this.onClick, + 'mouseover' : this.onMouseOver, + 'mouseout' : this.onMouseOut + scope: this +});</code></pre> + */ + pub.on = pub.addListener; + pub.un = pub.removeListener; + + pub.stoppedMouseDownEvent = new Roo.util.Event(); + return pub; +}(); +/** + * Fires when the document is ready (before onload and before images are loaded). Shorthand of {@link Roo.EventManager#onDocumentReady}. + * @param {Function} fn The method the event invokes + * @param {Object} scope An object that becomes the scope of the handler + * @param {boolean} override If true, the obj passed in becomes + * the execution scope of the listener + * @member Roo + * @method onReady + */ +Roo.onReady = Roo.EventManager.onDocumentReady; + +Roo.onReady(function(){ + var bd = Roo.get(document.body); + if(!bd){ return; } + + var cls = [ + Roo.isIE ? "roo-ie" + : Roo.isIE11 ? "roo-ie11" + : Roo.isEdge ? "roo-edge" + : Roo.isGecko ? "roo-gecko" + : Roo.isOpera ? "roo-opera" + : Roo.isSafari ? "roo-safari" : ""]; + + if(Roo.isMac){ + cls.push("roo-mac"); + } + if(Roo.isLinux){ + cls.push("roo-linux"); + } + if(Roo.isIOS){ + cls.push("roo-ios"); + } + if(Roo.isTouch){ + cls.push("roo-touch"); + } + if(Roo.isBorderBox){ + cls.push('roo-border-box'); + } + if(Roo.isStrict){ // add to the parent to allow for selectors like ".ext-strict .ext-ie" + var p = bd.dom.parentNode; + if(p){ + p.className += ' roo-strict'; + } + } + bd.addClass(cls.join(' ')); +}); + +/** + * @class Roo.EventObject + * EventObject exposes the Yahoo! UI Event functionality directly on the object + * passed to your event handler. It exists mostly for convenience. It also fixes the annoying null checks automatically to cleanup your code + * Example: + * <pre><code> + function handleClick(e){ // e is not a standard event object, it is a Roo.EventObject + e.preventDefault(); + var target = e.getTarget(); + ... + } + var myDiv = Roo.get("myDiv"); + myDiv.on("click", handleClick); + //or + Roo.EventManager.on("myDiv", 'click', handleClick); + Roo.EventManager.addListener("myDiv", 'click', handleClick); + </code></pre> + * @singleton + */ +Roo.EventObject = function(){ + + var E = Roo.lib.Event; + + // safari keypress events for special keys return bad keycodes + var safariKeys = { + 63234 : 37, // left + 63235 : 39, // right + 63232 : 38, // up + 63233 : 40, // down + 63276 : 33, // page up + 63277 : 34, // page down + 63272 : 46, // delete + 63273 : 36, // home + 63275 : 35 // end + }; + + // normalize button clicks + var btnMap = Roo.isIE ? {1:0,4:1,2:2} : + (Roo.isSafari ? {1:0,2:1,3:2} : {0:0,1:1,2:2}); + + Roo.EventObjectImpl = function(e){ + if(e){ + this.setEvent(e.browserEvent || e); + } + }; + Roo.EventObjectImpl.prototype = { + /** + * Used to fix doc tools. + * @scope Roo.EventObject.prototype + */ + + + + + /** The normal browser event */ + browserEvent : null, + /** The button pressed in a mouse event */ + button : -1, + /** True if the shift key was down during the event */ + shiftKey : false, + /** True if the control key was down during the event */ + ctrlKey : false, + /** True if the alt key was down during the event */ + altKey : false, + + /** Key constant + * @type Number */ + BACKSPACE : 8, + /** Key constant + * @type Number */ + TAB : 9, + /** Key constant + * @type Number */ + RETURN : 13, + /** Key constant + * @type Number */ + ENTER : 13, + /** Key constant + * @type Number */ + SHIFT : 16, + /** Key constant + * @type Number */ + CONTROL : 17, + /** Key constant + * @type Number */ + ESC : 27, + /** Key constant + * @type Number */ + SPACE : 32, + /** Key constant + * @type Number */ + PAGEUP : 33, + /** Key constant + * @type Number */ + PAGEDOWN : 34, + /** Key constant + * @type Number */ + END : 35, + /** Key constant + * @type Number */ + HOME : 36, + /** Key constant + * @type Number */ + LEFT : 37, + /** Key constant + * @type Number */ + UP : 38, + /** Key constant + * @type Number */ + RIGHT : 39, + /** Key constant + * @type Number */ + DOWN : 40, + /** Key constant + * @type Number */ + DELETE : 46, + /** Key constant + * @type Number */ + F5 : 116, + + /** @private */ + setEvent : function(e){ + if(e == this || (e && e.browserEvent)){ // already wrapped + return e; + } + this.browserEvent = e; + if(e){ + // normalize buttons + this.button = e.button ? btnMap[e.button] : (e.which ? e.which-1 : -1); + if(e.type == 'click' && this.button == -1){ + this.button = 0; + } + this.type = e.type; + this.shiftKey = e.shiftKey; + // mac metaKey behaves like ctrlKey + this.ctrlKey = e.ctrlKey || e.metaKey; + this.altKey = e.altKey; + // in getKey these will be normalized for the mac + this.keyCode = e.keyCode; + // keyup warnings on firefox. + this.charCode = (e.type == 'keyup' || e.type == 'keydown') ? 0 : e.charCode; + // cache the target for the delayed and or buffered events + this.target = E.getTarget(e); + // same for XY + this.xy = E.getXY(e); + }else{ + this.button = -1; + this.shiftKey = false; + this.ctrlKey = false; + this.altKey = false; + this.keyCode = 0; + this.charCode =0; + this.target = null; + this.xy = [0, 0]; + } + return this; + }, + + /** + * Stop the event (preventDefault and stopPropagation) + */ + stopEvent : function(){ + if(this.browserEvent){ + if(this.browserEvent.type == 'mousedown'){ + Roo.EventManager.stoppedMouseDownEvent.fire(this); + } + E.stopEvent(this.browserEvent); + } + }, + + /** + * Prevents the browsers default handling of the event. + */ + preventDefault : function(){ + if(this.browserEvent){ + E.preventDefault(this.browserEvent); + } + }, + + /** @private */ + isNavKeyPress : function(){ + var k = this.keyCode; + k = Roo.isSafari ? (safariKeys[k] || k) : k; + return (k >= 33 && k <= 40) || k == this.RETURN || k == this.TAB || k == this.ESC; + }, + + isSpecialKey : function(){ + var k = this.keyCode; + return (this.type == 'keypress' && this.ctrlKey) || k == 9 || k == 13 || k == 40 || k == 27 || + (k == 16) || (k == 17) || + (k >= 18 && k <= 20) || + (k >= 33 && k <= 35) || + (k >= 36 && k <= 39) || + (k >= 44 && k <= 45); + }, + /** + * Cancels bubbling of the event. + */ + stopPropagation : function(){ + if(this.browserEvent){ + if(this.type == 'mousedown'){ + Roo.EventManager.stoppedMouseDownEvent.fire(this); + } + E.stopPropagation(this.browserEvent); + } + }, + + /** + * Gets the key code for the event. + * @return {Number} + */ + getCharCode : function(){ + return this.charCode || this.keyCode; + }, + + /** + * Returns a normalized keyCode for the event. + * @return {Number} The key code + */ + getKey : function(){ + var k = this.keyCode || this.charCode; + return Roo.isSafari ? (safariKeys[k] || k) : k; + }, + + /** + * Gets the x coordinate of the event. + * @return {Number} + */ + getPageX : function(){ + return this.xy[0]; + }, + + /** + * Gets the y coordinate of the event. + * @return {Number} + */ + getPageY : function(){ + return this.xy[1]; + }, + + /** + * Gets the time of the event. + * @return {Number} + */ + getTime : function(){ + if(this.browserEvent){ + return E.getTime(this.browserEvent); + } + return null; + }, + + /** + * Gets the page coordinates of the event. + * @return {Array} The xy values like [x, y] + */ + getXY : function(){ + return this.xy; + }, + + /** + * Gets the target for the event. + * @param {String} selector (optional) A simple selector to filter the target or look for an ancestor of the target + * @param {Number/String/HTMLElement/Element} maxDepth (optional) The max depth to + search as a number or element (defaults to 10 || document.body) + * @param {Boolean} returnEl (optional) True to return a Roo.Element object instead of DOM node + * @return {HTMLelement} + */ + getTarget : function(selector, maxDepth, returnEl){ + return selector ? Roo.fly(this.target).findParent(selector, maxDepth, returnEl) : this.target; + }, + /** + * Gets the related target. + * @return {HTMLElement} + */ + getRelatedTarget : function(){ + if(this.browserEvent){ + return E.getRelatedTarget(this.browserEvent); + } + return null; + }, + + /** + * Normalizes mouse wheel delta across browsers + * @return {Number} The delta + */ + getWheelDelta : function(){ + var e = this.browserEvent; + var delta = 0; + if(e.wheelDelta){ /* IE/Opera. */ + delta = e.wheelDelta/120; + }else if(e.detail){ /* Mozilla case. */ + delta = -e.detail/3; + } + return delta; + }, + + /** + * Returns true if the control, meta, shift or alt key was pressed during this event. + * @return {Boolean} + */ + hasModifier : function(){ + return !!((this.ctrlKey || this.altKey) || this.shiftKey); + }, + + /** + * Returns true if the target of this event equals el or is a child of el + * @param {String/HTMLElement/Element} el + * @param {Boolean} related (optional) true to test if the related target is within el instead of the target + * @return {Boolean} + */ + within : function(el, related){ + var t = this[related ? "getRelatedTarget" : "getTarget"](); + return t && Roo.fly(el).contains(t); + }, + + getPoint : function(){ + return new Roo.lib.Point(this.xy[0], this.xy[1]); + } + }; + + return new Roo.EventObjectImpl(); +}(); + + \ No newline at end of file diff --git a/docs2/src/Roo_Fx.js.html b/docs2/src/Roo_Fx.js.html new file mode 100644 index 0000000000..a233eadb8c --- /dev/null +++ b/docs2/src/Roo_Fx.js.html @@ -0,0 +1,1004 @@ +/home/alan/gitlive/roojs1/Roo/Fx.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + + +//Notifies Element that fx methods are available +Roo.enableFx = true; + +/** + * @class Roo.Fx + * <p>A class to provide basic animation and visual effects support. <b>Note:</b> This class is automatically applied + * to the {@link Roo.Element} interface when included, so all effects calls should be performed via Element. + * Conversely, since the effects are not actually defined in Element, Roo.Fx <b>must</b> be included in order for the + * Element effects to work.</p><br/> + * + * <p>It is important to note that although the Fx methods and many non-Fx Element methods support "method chaining" in that + * they return the Element object itself as the method return value, it is not always possible to mix the two in a single + * method chain. The Fx methods use an internal effects queue so that each effect can be properly timed and sequenced. + * Non-Fx methods, on the other hand, have no such internal queueing and will always execute immediately. For this reason, + * while it may be possible to mix certain Fx and non-Fx method calls in a single chain, it may not always provide the + * expected results and should be done with care.</p><br/> + * + * <p>Motion effects support 8-way anchoring, meaning that you can choose one of 8 different anchor points on the Element + * that will serve as either the start or end point of the animation. Following are all of the supported anchor positions:</p> +<pre> +Value Description +----- ----------------------------- +tl The top left corner +t The center of the top edge +tr The top right corner +l The center of the left edge +r The center of the right edge +bl The bottom left corner +b The center of the bottom edge +br The bottom right corner +</pre> + * <b>Although some Fx methods accept specific custom config parameters, the ones shown in the Config Options section + * below are common options that can be passed to any Fx method.</b> + * @cfg {Function} callback A function called when the effect is finished + * @cfg {Object} scope The scope of the effect function + * @cfg {String} easing A valid Easing value for the effect + * @cfg {String} afterCls A css class to apply after the effect + * @cfg {Number} duration The length of time (in seconds) that the effect should last + * @cfg {Boolean} remove Whether the Element should be removed from the DOM and destroyed after the effect finishes + * @cfg {Boolean} useDisplay Whether to use the <i>display</i> CSS property instead of <i>visibility</i> when hiding Elements (only applies to + * effects that end with the element being visually hidden, ignored otherwise) + * @cfg {String/Object/Function} afterStyle A style specification string, e.g. "width:100px", or an object in the form {width:"100px"}, or + * a function which returns such a specification that will be applied to the Element after the effect finishes + * @cfg {Boolean} block Whether the effect should block other effects from queueing while it runs + * @cfg {Boolean} concurrent Whether to allow subsequently-queued effects to run at the same time as the current effect, or to ensure that they run in sequence + * @cfg {Boolean} stopFx Whether subsequent effects should be stopped and removed after the current effect finishes + */ +Roo.Fx = { + /** + * Slides the element into view. An anchor point can be optionally passed to set the point of + * origin for the slide effect. This function automatically handles wrapping the element with + * a fixed-size container if needed. See the Fx class overview for valid anchor point options. + * Usage: + *<pre><code> +// default: slide the element in from the top +el.slideIn(); + +// custom: slide the element in from the right with a 2-second duration +el.slideIn('r', { duration: 2 }); + +// common config options shown with default values +el.slideIn('t', { + easing: 'easeOut', + duration: .5 +}); +</code></pre> + * @param {String} anchor (optional) One of the valid Fx anchor positions (defaults to top: 't') + * @param {Object} options (optional) Object literal with any of the Fx config options + * @return {Roo.Element} The Element + */ + slideIn : function(anchor, o){ + var el = this.getFxEl(); + o = o || {}; + + el.queueFx(o, function(){ + + anchor = anchor || "t"; + + // fix display to visibility + this.fixDisplay(); + + // restore values after effect + var r = this.getFxRestore(); + var b = this.getBox(); + // fixed size for slide + this.setSize(b); + + // wrap if needed + var wrap = this.fxWrap(r.pos, o, "hidden"); + + var st = this.dom.style; + st.visibility = "visible"; + st.position = "absolute"; + + // clear out temp styles after slide and unwrap + var after = function(){ + el.fxUnwrap(wrap, r.pos, o); + st.width = r.width; + st.height = r.height; + el.afterFx(o); + }; + // time to calc the positions + var a, pt = {to: [b.x, b.y]}, bw = {to: b.width}, bh = {to: b.height}; + + switch(anchor.toLowerCase()){ + case "t": + wrap.setSize(b.width, 0); + st.left = st.bottom = "0"; + a = {height: bh}; + break; + case "l": + wrap.setSize(0, b.height); + st.right = st.top = "0"; + a = {width: bw}; + break; + case "r": + wrap.setSize(0, b.height); + wrap.setX(b.right); + st.left = st.top = "0"; + a = {width: bw, points: pt}; + break; + case "b": + wrap.setSize(b.width, 0); + wrap.setY(b.bottom); + st.left = st.top = "0"; + a = {height: bh, points: pt}; + break; + case "tl": + wrap.setSize(0, 0); + st.right = st.bottom = "0"; + a = {width: bw, height: bh}; + break; + case "bl": + wrap.setSize(0, 0); + wrap.setY(b.y+b.height); + st.right = st.top = "0"; + a = {width: bw, height: bh, points: pt}; + break; + case "br": + wrap.setSize(0, 0); + wrap.setXY([b.right, b.bottom]); + st.left = st.top = "0"; + a = {width: bw, height: bh, points: pt}; + break; + case "tr": + wrap.setSize(0, 0); + wrap.setX(b.x+b.width); + st.left = st.bottom = "0"; + a = {width: bw, height: bh, points: pt}; + break; + } + this.dom.style.visibility = "visible"; + wrap.show(); + + arguments.callee.anim = wrap.fxanim(a, + o, + 'motion', + .5, + 'easeOut', after); + }); + return this; + }, + + /** + * Slides the element out of view. An anchor point can be optionally passed to set the end point + * for the slide effect. When the effect is completed, the element will be hidden (visibility = + * 'hidden') but block elements will still take up space in the document. The element must be removed + * from the DOM using the 'remove' config option if desired. This function automatically handles + * wrapping the element with a fixed-size container if needed. See the Fx class overview for valid anchor point options. + * Usage: + *<pre><code> +// default: slide the element out to the top +el.slideOut(); + +// custom: slide the element out to the right with a 2-second duration +el.slideOut('r', { duration: 2 }); + +// common config options shown with default values +el.slideOut('t', { + easing: 'easeOut', + duration: .5, + remove: false, + useDisplay: false +}); +</code></pre> + * @param {String} anchor (optional) One of the valid Fx anchor positions (defaults to top: 't') + * @param {Object} options (optional) Object literal with any of the Fx config options + * @return {Roo.Element} The Element + */ + slideOut : function(anchor, o){ + var el = this.getFxEl(); + o = o || {}; + + el.queueFx(o, function(){ + + anchor = anchor || "t"; + + // restore values after effect + var r = this.getFxRestore(); + + var b = this.getBox(); + // fixed size for slide + this.setSize(b); + + // wrap if needed + var wrap = this.fxWrap(r.pos, o, "visible"); + + var st = this.dom.style; + st.visibility = "visible"; + st.position = "absolute"; + + wrap.setSize(b); + + var after = function(){ + if(o.useDisplay){ + el.setDisplayed(false); + }else{ + el.hide(); + } + + el.fxUnwrap(wrap, r.pos, o); + + st.width = r.width; + st.height = r.height; + + el.afterFx(o); + }; + + var a, zero = {to: 0}; + switch(anchor.toLowerCase()){ + case "t": + st.left = st.bottom = "0"; + a = {height: zero}; + break; + case "l": + st.right = st.top = "0"; + a = {width: zero}; + break; + case "r": + st.left = st.top = "0"; + a = {width: zero, points: {to:[b.right, b.y]}}; + break; + case "b": + st.left = st.top = "0"; + a = {height: zero, points: {to:[b.x, b.bottom]}}; + break; + case "tl": + st.right = st.bottom = "0"; + a = {width: zero, height: zero}; + break; + case "bl": + st.right = st.top = "0"; + a = {width: zero, height: zero, points: {to:[b.x, b.bottom]}}; + break; + case "br": + st.left = st.top = "0"; + a = {width: zero, height: zero, points: {to:[b.x+b.width, b.bottom]}}; + break; + case "tr": + st.left = st.bottom = "0"; + a = {width: zero, height: zero, points: {to:[b.right, b.y]}}; + break; + } + + arguments.callee.anim = wrap.fxanim(a, + o, + 'motion', + .5, + "easeOut", after); + }); + return this; + }, + + /** + * Fades the element out while slowly expanding it in all directions. When the effect is completed, the + * element will be hidden (visibility = 'hidden') but block elements will still take up space in the document. + * The element must be removed from the DOM using the 'remove' config option if desired. + * Usage: + *<pre><code> +// default +el.puff(); + +// common config options shown with default values +el.puff({ + easing: 'easeOut', + duration: .5, + remove: false, + useDisplay: false +}); +</code></pre> + * @param {Object} options (optional) Object literal with any of the Fx config options + * @return {Roo.Element} The Element + */ + puff : function(o){ + var el = this.getFxEl(); + o = o || {}; + + el.queueFx(o, function(){ + this.clearOpacity(); + this.show(); + + // restore values after effect + var r = this.getFxRestore(); + var st = this.dom.style; + + var after = function(){ + if(o.useDisplay){ + el.setDisplayed(false); + }else{ + el.hide(); + } + + el.clearOpacity(); + + el.setPositioning(r.pos); + st.width = r.width; + st.height = r.height; + st.fontSize = ''; + el.afterFx(o); + }; + + var width = this.getWidth(); + var height = this.getHeight(); + + arguments.callee.anim = this.fxanim({ + width : {to: this.adjustWidth(width * 2)}, + height : {to: this.adjustHeight(height * 2)}, + points : {by: [-(width * .5), -(height * .5)]}, + opacity : {to: 0}, + fontSize: {to:200, unit: "%"} + }, + o, + 'motion', + .5, + "easeOut", after); + }); + return this; + }, + + /** + * Blinks the element as if it was clicked and then collapses on its center (similar to switching off a television). + * When the effect is completed, the element will be hidden (visibility = 'hidden') but block elements will still + * take up space in the document. The element must be removed from the DOM using the 'remove' config option if desired. + * Usage: + *<pre><code> +// default +el.switchOff(); + +// all config options shown with default values +el.switchOff({ + easing: 'easeIn', + duration: .3, + remove: false, + useDisplay: false +}); +</code></pre> + * @param {Object} options (optional) Object literal with any of the Fx config options + * @return {Roo.Element} The Element + */ + switchOff : function(o){ + var el = this.getFxEl(); + o = o || {}; + + el.queueFx(o, function(){ + this.clearOpacity(); + this.clip(); + + // restore values after effect + var r = this.getFxRestore(); + var st = this.dom.style; + + var after = function(){ + if(o.useDisplay){ + el.setDisplayed(false); + }else{ + el.hide(); + } + + el.clearOpacity(); + el.setPositioning(r.pos); + st.width = r.width; + st.height = r.height; + + el.afterFx(o); + }; + + this.fxanim({opacity:{to:0.3}}, null, null, .1, null, function(){ + this.clearOpacity(); + (function(){ + this.fxanim({ + height:{to:1}, + points:{by:[0, this.getHeight() * .5]} + }, o, 'motion', 0.3, 'easeIn', after); + }).defer(100, this); + }); + }); + return this; + }, + + /** + * Highlights the Element by setting a color (applies to the background-color by default, but can be + * changed using the "attr" config option) and then fading back to the original color. If no original + * color is available, you should provide the "endColor" config option which will be cleared after the animation. + * Usage: +<pre><code> +// default: highlight background to yellow +el.highlight(); + +// custom: highlight foreground text to blue for 2 seconds +el.highlight("0000ff", { attr: 'color', duration: 2 }); + +// common config options shown with default values +el.highlight("ffff9c", { + attr: "background-color", //can be any valid CSS property (attribute) that supports a color value + endColor: (current color) or "ffffff", + easing: 'easeIn', + duration: 1 +}); +</code></pre> + * @param {String} color (optional) The highlight color. Should be a 6 char hex color without the leading # (defaults to yellow: 'ffff9c') + * @param {Object} options (optional) Object literal with any of the Fx config options + * @return {Roo.Element} The Element + */ + highlight : function(color, o){ + var el = this.getFxEl(); + o = o || {}; + + el.queueFx(o, function(){ + color = color || "ffff9c"; + attr = o.attr || "backgroundColor"; + + this.clearOpacity(); + this.show(); + + var origColor = this.getColor(attr); + var restoreColor = this.dom.style[attr]; + endColor = (o.endColor || origColor) || "ffffff"; + + var after = function(){ + el.dom.style[attr] = restoreColor; + el.afterFx(o); + }; + + var a = {}; + a[attr] = {from: color, to: endColor}; + arguments.callee.anim = this.fxanim(a, + o, + 'color', + 1, + 'easeIn', after); + }); + return this; + }, + + /** + * Shows a ripple of exploding, attenuating borders to draw attention to an Element. + * Usage: +<pre><code> +// default: a single light blue ripple +el.frame(); + +// custom: 3 red ripples lasting 3 seconds total +el.frame("ff0000", 3, { duration: 3 }); + +// common config options shown with default values +el.frame("C3DAF9", 1, { + duration: 1 //duration of entire animation (not each individual ripple) + // Note: Easing is not configurable and will be ignored if included +}); +</code></pre> + * @param {String} color (optional) The color of the border. Should be a 6 char hex color without the leading # (defaults to light blue: 'C3DAF9'). + * @param {Number} count (optional) The number of ripples to display (defaults to 1) + * @param {Object} options (optional) Object literal with any of the Fx config options + * @return {Roo.Element} The Element + */ + frame : function(color, count, o){ + var el = this.getFxEl(); + o = o || {}; + + el.queueFx(o, function(){ + color = color || "#C3DAF9"; + if(color.length == 6){ + color = "#" + color; + } + count = count || 1; + duration = o.duration || 1; + this.show(); + + var b = this.getBox(); + var animFn = function(){ + var proxy = this.createProxy({ + + style:{ + visbility:"hidden", + position:"absolute", + "z-index":"35000", // yee haw + border:"0px solid " + color + } + }); + var scale = Roo.isBorderBox ? 2 : 1; + proxy.animate({ + top:{from:b.y, to:b.y - 20}, + left:{from:b.x, to:b.x - 20}, + borderWidth:{from:0, to:10}, + opacity:{from:1, to:0}, + height:{from:b.height, to:(b.height + (20*scale))}, + width:{from:b.width, to:(b.width + (20*scale))} + }, duration, function(){ + proxy.remove(); + }); + if(--count > 0){ + animFn.defer((duration/2)*1000, this); + }else{ + el.afterFx(o); + } + }; + animFn.call(this); + }); + return this; + }, + + /** + * Creates a pause before any subsequent queued effects begin. If there are + * no effects queued after the pause it will have no effect. + * Usage: +<pre><code> +el.pause(1); +</code></pre> + * @param {Number} seconds The length of time to pause (in seconds) + * @return {Roo.Element} The Element + */ + pause : function(seconds){ + var el = this.getFxEl(); + var o = {}; + + el.queueFx(o, function(){ + setTimeout(function(){ + el.afterFx(o); + }, seconds * 1000); + }); + return this; + }, + + /** + * Fade an element in (from transparent to opaque). The ending opacity can be specified + * using the "endOpacity" config option. + * Usage: +<pre><code> +// default: fade in from opacity 0 to 100% +el.fadeIn(); + +// custom: fade in from opacity 0 to 75% over 2 seconds +el.fadeIn({ endOpacity: .75, duration: 2}); + +// common config options shown with default values +el.fadeIn({ + endOpacity: 1, //can be any value between 0 and 1 (e.g. .5) + easing: 'easeOut', + duration: .5 +}); +</code></pre> + * @param {Object} options (optional) Object literal with any of the Fx config options + * @return {Roo.Element} The Element + */ + fadeIn : function(o){ + var el = this.getFxEl(); + o = o || {}; + el.queueFx(o, function(){ + this.setOpacity(0); + this.fixDisplay(); + this.dom.style.visibility = 'visible'; + var to = o.endOpacity || 1; + arguments.callee.anim = this.fxanim({opacity:{to:to}}, + o, null, .5, "easeOut", function(){ + if(to == 1){ + this.clearOpacity(); + } + el.afterFx(o); + }); + }); + return this; + }, + + /** + * Fade an element out (from opaque to transparent). The ending opacity can be specified + * using the "endOpacity" config option. + * Usage: +<pre><code> +// default: fade out from the element's current opacity to 0 +el.fadeOut(); + +// custom: fade out from the element's current opacity to 25% over 2 seconds +el.fadeOut({ endOpacity: .25, duration: 2}); + +// common config options shown with default values +el.fadeOut({ + endOpacity: 0, //can be any value between 0 and 1 (e.g. .5) + easing: 'easeOut', + duration: .5 + remove: false, + useDisplay: false +}); +</code></pre> + * @param {Object} options (optional) Object literal with any of the Fx config options + * @return {Roo.Element} The Element + */ + fadeOut : function(o){ + var el = this.getFxEl(); + o = o || {}; + el.queueFx(o, function(){ + arguments.callee.anim = this.fxanim({opacity:{to:o.endOpacity || 0}}, + o, null, .5, "easeOut", function(){ + if(this.visibilityMode == Roo.Element.DISPLAY || o.useDisplay){ + this.dom.style.display = "none"; + }else{ + this.dom.style.visibility = "hidden"; + } + this.clearOpacity(); + el.afterFx(o); + }); + }); + return this; + }, + + /** + * Animates the transition of an element's dimensions from a starting height/width + * to an ending height/width. + * Usage: +<pre><code> +// change height and width to 100x100 pixels +el.scale(100, 100); + +// common config options shown with default values. The height and width will default to +// the element's existing values if passed as null. +el.scale( + [element's width], + [element's height], { + easing: 'easeOut', + duration: .35 +}); +</code></pre> + * @param {Number} width The new width (pass undefined to keep the original width) + * @param {Number} height The new height (pass undefined to keep the original height) + * @param {Object} options (optional) Object literal with any of the Fx config options + * @return {Roo.Element} The Element + */ + scale : function(w, h, o){ + this.shift(Roo.apply({}, o, { + width: w, + height: h + })); + return this; + }, + + /** + * Animates the transition of any combination of an element's dimensions, xy position and/or opacity. + * Any of these properties not specified in the config object will not be changed. This effect + * requires that at least one new dimension, position or opacity setting must be passed in on + * the config object in order for the function to have any effect. + * Usage: +<pre><code> +// slide the element horizontally to x position 200 while changing the height and opacity +el.shift({ x: 200, height: 50, opacity: .8 }); + +// common config options shown with default values. +el.shift({ + width: [element's width], + height: [element's height], + x: [element's x position], + y: [element's y position], + opacity: [element's opacity], + easing: 'easeOut', + duration: .35 +}); +</code></pre> + * @param {Object} options Object literal with any of the Fx config options + * @return {Roo.Element} The Element + */ + shift : function(o){ + var el = this.getFxEl(); + o = o || {}; + el.queueFx(o, function(){ + var a = {}, w = o.width, h = o.height, x = o.x, y = o.y, op = o.opacity; + if(w !== undefined){ + a.width = {to: this.adjustWidth(w)}; + } + if(h !== undefined){ + a.height = {to: this.adjustHeight(h)}; + } + if(x !== undefined || y !== undefined){ + a.points = {to: [ + x !== undefined ? x : this.getX(), + y !== undefined ? y : this.getY() + ]}; + } + if(op !== undefined){ + a.opacity = {to: op}; + } + if(o.xy !== undefined){ + a.points = {to: o.xy}; + } + arguments.callee.anim = this.fxanim(a, + o, 'motion', .35, "easeOut", function(){ + el.afterFx(o); + }); + }); + return this; + }, + + /** + * Slides the element while fading it out of view. An anchor point can be optionally passed to set the + * ending point of the effect. + * Usage: + *<pre><code> +// default: slide the element downward while fading out +el.ghost(); + +// custom: slide the element out to the right with a 2-second duration +el.ghost('r', { duration: 2 }); + +// common config options shown with default values +el.ghost('b', { + easing: 'easeOut', + duration: .5 + remove: false, + useDisplay: false +}); +</code></pre> + * @param {String} anchor (optional) One of the valid Fx anchor positions (defaults to bottom: 'b') + * @param {Object} options (optional) Object literal with any of the Fx config options + * @return {Roo.Element} The Element + */ + ghost : function(anchor, o){ + var el = this.getFxEl(); + o = o || {}; + + el.queueFx(o, function(){ + anchor = anchor || "b"; + + // restore values after effect + var r = this.getFxRestore(); + var w = this.getWidth(), + h = this.getHeight(); + + var st = this.dom.style; + + var after = function(){ + if(o.useDisplay){ + el.setDisplayed(false); + }else{ + el.hide(); + } + + el.clearOpacity(); + el.setPositioning(r.pos); + st.width = r.width; + st.height = r.height; + + el.afterFx(o); + }; + + var a = {opacity: {to: 0}, points: {}}, pt = a.points; + switch(anchor.toLowerCase()){ + case "t": + pt.by = [0, -h]; + break; + case "l": + pt.by = [-w, 0]; + break; + case "r": + pt.by = [w, 0]; + break; + case "b": + pt.by = [0, h]; + break; + case "tl": + pt.by = [-w, -h]; + break; + case "bl": + pt.by = [-w, h]; + break; + case "br": + pt.by = [w, h]; + break; + case "tr": + pt.by = [w, -h]; + break; + } + + arguments.callee.anim = this.fxanim(a, + o, + 'motion', + .5, + "easeOut", after); + }); + return this; + }, + + /** + * Ensures that all effects queued after syncFx is called on the element are + * run concurrently. This is the opposite of {@link #sequenceFx}. + * @return {Roo.Element} The Element + */ + syncFx : function(){ + this.fxDefaults = Roo.apply(this.fxDefaults || {}, { + block : false, + concurrent : true, + stopFx : false + }); + return this; + }, + + /** + * Ensures that all effects queued after sequenceFx is called on the element are + * run in sequence. This is the opposite of {@link #syncFx}. + * @return {Roo.Element} The Element + */ + sequenceFx : function(){ + this.fxDefaults = Roo.apply(this.fxDefaults || {}, { + block : false, + concurrent : false, + stopFx : false + }); + return this; + }, + + /* @private */ + nextFx : function(){ + var ef = this.fxQueue[0]; + if(ef){ + ef.call(this); + } + }, + + /** + * Returns true if the element has any effects actively running or queued, else returns false. + * @return {Boolean} True if element has active effects, else false + */ + hasActiveFx : function(){ + return this.fxQueue && this.fxQueue[0]; + }, + + /** + * Stops any running effects and clears the element's internal effects queue if it contains + * any additional effects that haven't started yet. + * @return {Roo.Element} The Element + */ + stopFx : function(){ + if(this.hasActiveFx()){ + var cur = this.fxQueue[0]; + if(cur && cur.anim && cur.anim.isAnimated()){ + this.fxQueue = [cur]; // clear out others + cur.anim.stop(true); + } + } + return this; + }, + + /* @private */ + beforeFx : function(o){ + if(this.hasActiveFx() && !o.concurrent){ + if(o.stopFx){ + this.stopFx(); + return true; + } + return false; + } + return true; + }, + + /** + * Returns true if the element is currently blocking so that no other effect can be queued + * until this effect is finished, else returns false if blocking is not set. This is commonly + * used to ensure that an effect initiated by a user action runs to completion prior to the + * same effect being restarted (e.g., firing only one effect even if the user clicks several times). + * @return {Boolean} True if blocking, else false + */ + hasFxBlock : function(){ + var q = this.fxQueue; + return q && q[0] && q[0].block; + }, + + /* @private */ + queueFx : function(o, fn){ + if(!this.fxQueue){ + this.fxQueue = []; + } + if(!this.hasFxBlock()){ + Roo.applyIf(o, this.fxDefaults); + if(!o.concurrent){ + var run = this.beforeFx(o); + fn.block = o.block; + this.fxQueue.push(fn); + if(run){ + this.nextFx(); + } + }else{ + fn.call(this); + } + } + return this; + }, + + /* @private */ + fxWrap : function(pos, o, vis){ + var wrap; + if(!o.wrap || !(wrap = Roo.get(o.wrap))){ + var wrapXY; + if(o.fixPosition){ + wrapXY = this.getXY(); + } + var div = document.createElement("div"); + div.style.visibility = vis; + wrap = Roo.get(this.dom.parentNode.insertBefore(div, this.dom)); + wrap.setPositioning(pos); + if(wrap.getStyle("position") == "static"){ + wrap.position("relative"); + } + this.clearPositioning('auto'); + wrap.clip(); + wrap.dom.appendChild(this.dom); + if(wrapXY){ + wrap.setXY(wrapXY); + } + } + return wrap; + }, + + /* @private */ + fxUnwrap : function(wrap, pos, o){ + this.clearPositioning(); + this.setPositioning(pos); + if(!o.wrap){ + wrap.dom.parentNode.insertBefore(this.dom, wrap.dom); + wrap.remove(); + } + }, + + /* @private */ + getFxRestore : function(){ + var st = this.dom.style; + return {pos: this.getPositioning(), width: st.width, height : st.height}; + }, + + /* @private */ + afterFx : function(o){ + if(o.afterStyle){ + this.applyStyles(o.afterStyle); + } + if(o.afterCls){ + this.addClass(o.afterCls); + } + if(o.remove === true){ + this.remove(); + } + Roo.callback(o.callback, o.scope, [this]); + if(!o.concurrent){ + this.fxQueue.shift(); + this.nextFx(); + } + }, + + /* @private */ + getFxEl : function(){ // support for composite element fx + return Roo.get(this.dom); + }, + + /* @private */ + fxanim : function(args, opt, animType, defaultDur, defaultEase, cb){ + animType = animType || 'run'; + opt = opt || {}; + var anim = Roo.lib.Anim[animType]( + this.dom, args, + (opt.duration || defaultDur) || .35, + (opt.easing || defaultEase) || 'easeOut', + function(){ + Roo.callback(cb, this); + }, + this + ); + opt.anim = anim; + return anim; + } +}; + +// backwords compat +Roo.Fx.resize = Roo.Fx.scale; + +//When included, Roo.Fx is automatically applied to Element so that all basic +//effects are available directly via the Element API +Roo.apply(Roo.Element.prototype, Roo.Fx); \ No newline at end of file diff --git a/docs2/src/Roo_HtmlEditorCore.js.html b/docs2/src/Roo_HtmlEditorCore.js.html new file mode 100644 index 0000000000..cf7b93750f --- /dev/null +++ b/docs2/src/Roo_HtmlEditorCore.js.html @@ -0,0 +1,1686 @@ +/home/alan/gitlive/roojs1/Roo/HtmlEditorCore.js//<script type="text/javascript"> + +/* + * Based Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * LGPL + * + */ + +/** + * @class Roo.HtmlEditorCore + * @extends Roo.Component + * Provides a the editing component for the HTML editors in Roo. (bootstrap and Roo.form) + * + * any element that has display set to 'none' can cause problems in Safari and Firefox.<br/><br/> + */ + +Roo.HtmlEditorCore = function(config){ + + + Roo.HtmlEditorCore.superclass.constructor.call(this, config); + + + this.addEvents({ + /** + * @event initialize + * Fires when the editor is fully initialized (including the iframe) + * @param {Roo.HtmlEditorCore} this + */ + initialize: true, + /** + * @event activate + * Fires when the editor is first receives the focus. Any insertion must wait + * until after this event. + * @param {Roo.HtmlEditorCore} this + */ + activate: true, + /** + * @event beforesync + * Fires before the textarea is updated with content from the editor iframe. Return false + * to cancel the sync. + * @param {Roo.HtmlEditorCore} this + * @param {String} html + */ + beforesync: true, + /** + * @event beforepush + * Fires before the iframe editor is updated with content from the textarea. Return false + * to cancel the push. + * @param {Roo.HtmlEditorCore} this + * @param {String} html + */ + beforepush: true, + /** + * @event sync + * Fires when the textarea is updated with content from the editor iframe. + * @param {Roo.HtmlEditorCore} this + * @param {String} html + */ + sync: true, + /** + * @event push + * Fires when the iframe editor is updated with content from the textarea. + * @param {Roo.HtmlEditorCore} this + * @param {String} html + */ + push: true, + + /** + * @event editorevent + * Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks. + * @param {Roo.HtmlEditorCore} this + */ + editorevent: true + + }); + + // at this point this.owner is set, so we can start working out the whitelisted / blacklisted elements + + // defaults : white / black... + this.applyBlacklists(); + + + +}; + + +Roo.extend(Roo.HtmlEditorCore, Roo.Component, { + + + /** + * @cfg {Roo.form.HtmlEditor|Roo.bootstrap.HtmlEditor} the owner field + */ + + owner : false, + + /** + * @cfg {String} resizable 's' or 'se' or 'e' - wrapps the element in a + * Roo.resizable. + */ + resizable : false, + /** + * @cfg {Number} height (in pixels) + */ + height: 300, + /** + * @cfg {Number} width (in pixels) + */ + width: 500, + + /** + * @cfg {Array} stylesheets url of stylesheets. set to [] to disable stylesheets. + * + */ + stylesheets: false, + + // id of frame.. + frameId: false, + + // private properties + validationEvent : false, + deferHeight: true, + initialized : false, + activated : false, + sourceEditMode : false, + onFocus : Roo.emptyFn, + iframePad:3, + hideMode:'offsets', + + clearUp: true, + + // blacklist + whitelisted elements.. + black: false, + white: false, + + bodyCls : '', + + /** + * Protected method that will not generally be called directly. It + * is called when the editor initializes the iframe with HTML contents. Override this method if you + * want to change the initialization markup of the iframe (e.g. to add stylesheets). + */ + getDocMarkup : function(){ + // body styles.. + var st = ''; + + // inherit styels from page...?? + if (this.stylesheets === false) { + + Roo.get(document.head).select('style').each(function(node) { + st += node.dom.outerHTML || new XMLSerializer().serializeToString(node.dom); + }); + + Roo.get(document.head).select('link').each(function(node) { + st += node.dom.outerHTML || new XMLSerializer().serializeToString(node.dom); + }); + + } else if (!this.stylesheets.length) { + // simple.. + st = '<style type="text/css">' + + 'body{border:0;margin:0;padding:3px;height:98%;cursor:text;}' + + '</style>'; + } else { + st = '<style type="text/css">' + + this.stylesheets + + '</style>'; + } + + st += '<style type="text/css">' + + 'IMG { cursor: pointer } ' + + '</style>'; + + var cls = 'roo-htmleditor-body'; + + if(this.bodyCls.length){ + cls += ' ' + this.bodyCls; + } + + return '<html><head>' + st + + //<style type="text/css">' + + //'body{border:0;margin:0;padding:3px;height:98%;cursor:text;}' + + //'</style>' + + ' </head><body class="' + cls + '"></body></html>'; + }, + + // private + onRender : function(ct, position) + { + var _t = this; + //Roo.HtmlEditorCore.superclass.onRender.call(this, ct, position); + this.el = this.owner.inputEl ? this.owner.inputEl() : this.owner.el; + + + this.el.dom.style.border = '0 none'; + this.el.dom.setAttribute('tabIndex', -1); + this.el.addClass('x-hidden hide'); + + + + if(Roo.isIE){ // fix IE 1px bogus margin + this.el.applyStyles('margin-top:-1px;margin-bottom:-1px;') + } + + + this.frameId = Roo.id(); + + + + var iframe = this.owner.wrap.createChild({ + tag: 'iframe', + cls: 'form-control', // bootstrap.. + id: this.frameId, + name: this.frameId, + frameBorder : 'no', + 'src' : Roo.SSL_SECURE_URL ? Roo.SSL_SECURE_URL : "javascript:false" + }, this.el + ); + + + this.iframe = iframe.dom; + + this.assignDocWin(); + + this.doc.designMode = 'on'; + + this.doc.open(); + this.doc.write(this.getDocMarkup()); + this.doc.close(); + + + var task = { // must defer to wait for browser to be ready + run : function(){ + //console.log("run task?" + this.doc.readyState); + this.assignDocWin(); + if(this.doc.body || this.doc.readyState == 'complete'){ + try { + this.doc.designMode="on"; + } catch (e) { + return; + } + Roo.TaskMgr.stop(task); + this.initEditor.defer(10, this); + } + }, + interval : 10, + duration: 10000, + scope: this + }; + Roo.TaskMgr.start(task); + + }, + + // private + onResize : function(w, h) + { + Roo.log('resize: ' +w + ',' + h ); + //Roo.HtmlEditorCore.superclass.onResize.apply(this, arguments); + if(!this.iframe){ + return; + } + if(typeof w == 'number'){ + + this.iframe.style.width = w + 'px'; + } + if(typeof h == 'number'){ + + this.iframe.style.height = h + 'px'; + if(this.doc){ + (this.doc.body || this.doc.documentElement).style.height = (h - (this.iframePad*2)) + 'px'; + } + } + + }, + + /** + * Toggles the editor between standard and source edit mode. + * @param {Boolean} sourceEdit (optional) True for source edit, false for standard + */ + toggleSourceEdit : function(sourceEditMode){ + + this.sourceEditMode = sourceEditMode === true; + + if(this.sourceEditMode){ + + Roo.get(this.iframe).addClass(['x-hidden','hide']); //FIXME - what's the BS styles for these + + }else{ + Roo.get(this.iframe).removeClass(['x-hidden','hide']); + //this.iframe.className = ''; + this.deferFocus(); + } + //this.setSize(this.owner.wrap.getSize()); + //this.fireEvent('editmodechange', this, this.sourceEditMode); + }, + + + + + /** + * Protected method that will not generally be called directly. If you need/want + * custom HTML cleanup, this is the method you should override. + * @param {String} html The HTML to be cleaned + * return {String} The cleaned HTML + */ + cleanHtml : function(html){ + html = String(html); + if(html.length > 5){ + if(Roo.isSafari){ // strip safari nonsense + html = html.replace(/\sclass="(?:Apple-style-span|khtml-block-placeholder)"/gi, ''); + } + } + if(html == '&nbsp;'){ + html = ''; + } + return html; + }, + + /** + * HTML Editor -> Textarea + * Protected method that will not generally be called directly. Syncs the contents + * of the editor iframe with the textarea. + */ + syncValue : function(){ + if(this.initialized){ + var bd = (this.doc.body || this.doc.documentElement); + //this.cleanUpPaste(); -- this is done else where and causes havoc.. + var html = bd.innerHTML; + if(Roo.isSafari){ + var bs = bd.getAttribute('style'); // Safari puts text-align styles on the body element! + var m = bs ? bs.match(/text-align:(.*?);/i) : false; + if(m && m[1]){ + html = '<div style="'+m[0]+'">' + html + '</div>'; + } + } + html = this.cleanHtml(html); + // fix up the special chars.. normaly like back quotes in word... + // however we do not want to do this with chinese.. + html = html.replace(/([\x80-\uffff])/g, function (a, b) { + var cc = b.charCodeAt(); + if ( + (cc >= 0x4E00 && cc < 0xA000 ) || + (cc >= 0x3400 && cc < 0x4E00 ) || + (cc >= 0xf900 && cc < 0xfb00 ) + ) { + return b; + } + return "&#"+cc+";" + }); + if(this.owner.fireEvent('beforesync', this, html) !== false){ + this.el.dom.value = html; + this.owner.fireEvent('sync', this, html); + } + } + }, + + /** + * Protected method that will not generally be called directly. Pushes the value of the textarea + * into the iframe editor. + */ + pushValue : function(){ + if(this.initialized){ + var v = this.el.dom.value.trim(); + +// if(v.length < 1){ +// v = '&#160;'; +// } + + if(this.owner.fireEvent('beforepush', this, v) !== false){ + var d = (this.doc.body || this.doc.documentElement); + d.innerHTML = v; + this.cleanUpPaste(); + this.el.dom.value = d.innerHTML; + this.owner.fireEvent('push', this, v); + } + } + }, + + // private + deferFocus : function(){ + this.focus.defer(10, this); + }, + + // doc'ed in Field + focus : function(){ + if(this.win && !this.sourceEditMode){ + this.win.focus(); + }else{ + this.el.focus(); + } + }, + + assignDocWin: function() + { + var iframe = this.iframe; + + if(Roo.isIE){ + this.doc = iframe.contentWindow.document; + this.win = iframe.contentWindow; + } else { +// if (!Roo.get(this.frameId)) { +// return; +// } +// this.doc = (iframe.contentDocument || Roo.get(this.frameId).dom.document); +// this.win = Roo.get(this.frameId).dom.contentWindow; + + if (!Roo.get(this.frameId) && !iframe.contentDocument) { + return; + } + + this.doc = (iframe.contentDocument || Roo.get(this.frameId).dom.document); + this.win = (iframe.contentWindow || Roo.get(this.frameId).dom.contentWindow); + } + }, + + // private + initEditor : function(){ + //console.log("INIT EDITOR"); + this.assignDocWin(); + + + + this.doc.designMode="on"; + this.doc.open(); + this.doc.write(this.getDocMarkup()); + this.doc.close(); + + var dbody = (this.doc.body || this.doc.documentElement); + //var ss = this.el.getStyles('font-size', 'font-family', 'background-image', 'background-repeat'); + // this copies styles from the containing element into thsi one.. + // not sure why we need all of this.. + //var ss = this.el.getStyles('font-size', 'background-image', 'background-repeat'); + + //var ss = this.el.getStyles( 'background-image', 'background-repeat'); + //ss['background-attachment'] = 'fixed'; // w3c + dbody.bgProperties = 'fixed'; // ie + //Roo.DomHelper.applyStyles(dbody, ss); + Roo.EventManager.on(this.doc, { + //'mousedown': this.onEditorEvent, + 'mouseup': this.onEditorEvent, + 'dblclick': this.onEditorEvent, + 'click': this.onEditorEvent, + 'keyup': this.onEditorEvent, + buffer:100, + scope: this + }); + if(Roo.isGecko){ + Roo.EventManager.on(this.doc, 'keypress', this.mozKeyPress, this); + } + if(Roo.isIE || Roo.isSafari || Roo.isOpera){ + Roo.EventManager.on(this.doc, 'keydown', this.fixKeys, this); + } + this.initialized = true; + + this.owner.fireEvent('initialize', this); + this.pushValue(); + }, + + // private + onDestroy : function(){ + + + + if(this.rendered){ + + //for (var i =0; i < this.toolbars.length;i++) { + // // fixme - ask toolbars for heights? + // this.toolbars[i].onDestroy(); + // } + + //this.wrap.dom.innerHTML = ''; + //this.wrap.remove(); + } + }, + + // private + onFirstFocus : function(){ + + this.assignDocWin(); + + + this.activated = true; + + + if(Roo.isGecko){ // prevent silly gecko errors + this.win.focus(); + var s = this.win.getSelection(); + if(!s.focusNode || s.focusNode.nodeType != 3){ + var r = s.getRangeAt(0); + r.selectNodeContents((this.doc.body || this.doc.documentElement)); + r.collapse(true); + this.deferFocus(); + } + try{ + this.execCmd('useCSS', true); + this.execCmd('styleWithCSS', false); + }catch(e){} + } + this.owner.fireEvent('activate', this); + }, + + // private + adjustFont: function(btn){ + var adjust = btn.cmd == 'increasefontsize' ? 1 : -1; + //if(Roo.isSafari){ // safari + // adjust *= 2; + // } + var v = parseInt(this.doc.queryCommandValue('FontSize')|| 3, 10); + if(Roo.isSafari){ // safari + var sm = { 10 : 1, 13: 2, 16:3, 18:4, 24: 5, 32:6, 48: 7 }; + v = (v < 10) ? 10 : v; + v = (v > 48) ? 48 : v; + v = typeof(sm[v]) == 'undefined' ? 1 : sm[v]; + + } + + + v = Math.max(1, v+adjust); + + this.execCmd('FontSize', v ); + }, + + onEditorEvent : function(e) + { + this.owner.fireEvent('editorevent', this, e); + // this.updateToolbar(); + this.syncValue(); //we can not sync so often.. sync cleans, so this breaks stuff + }, + + insertTag : function(tg) + { + // could be a bit smarter... -> wrap the current selected tRoo.. + if (tg.toLowerCase() == 'span' || tg.toLowerCase() == 'code') { + + range = this.createRange(this.getSelection()); + var wrappingNode = this.doc.createElement(tg.toLowerCase()); + wrappingNode.appendChild(range.extractContents()); + range.insertNode(wrappingNode); + + return; + + + + } + this.execCmd("formatblock", tg); + + }, + + insertText : function(txt) + { + + + var range = this.createRange(); + range.deleteContents(); + //alert(Sender.getAttribute('label')); + + range.insertNode(this.doc.createTextNode(txt)); + } , + + + + /** + * Executes a Midas editor command on the editor document and performs necessary focus and + * toolbar updates. <b>This should only be called after the editor is initialized.</b> + * @param {String} cmd The Midas command + * @param {String/Boolean} value (optional) The value to pass to the command (defaults to null) + */ + relayCmd : function(cmd, value){ + this.win.focus(); + this.execCmd(cmd, value); + this.owner.fireEvent('editorevent', this); + //this.updateToolbar(); + this.owner.deferFocus(); + }, + + /** + * Executes a Midas editor command directly on the editor document. + * For visual commands, you should use {@link #relayCmd} instead. + * <b>This should only be called after the editor is initialized.</b> + * @param {String} cmd The Midas command + * @param {String/Boolean} value (optional) The value to pass to the command (defaults to null) + */ + execCmd : function(cmd, value){ + this.doc.execCommand(cmd, false, value === undefined ? null : value); + this.syncValue(); + }, + + + + /** + * Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated + * to insert tRoo. + * @param {String} text | dom node.. + */ + insertAtCursor : function(text) + { + + if(!this.activated){ + return; + } + /* + if(Roo.isIE){ + this.win.focus(); + var r = this.doc.selection.createRange(); + if(r){ + r.collapse(true); + r.pasteHTML(text); + this.syncValue(); + this.deferFocus(); + + } + return; + } + */ + if(Roo.isGecko || Roo.isOpera || Roo.isSafari){ + this.win.focus(); + + + // from jquery ui (MIT licenced) + var range, node; + var win = this.win; + + if (win.getSelection && win.getSelection().getRangeAt) { + range = win.getSelection().getRangeAt(0); + node = typeof(text) == 'string' ? range.createContextualFragment(text) : text; + range.insertNode(node); + } else if (win.document.selection && win.document.selection.createRange) { + // no firefox support + var txt = typeof(text) == 'string' ? text : text.outerHTML; + win.document.selection.createRange().pasteHTML(txt); + } else { + // no firefox support + var txt = typeof(text) == 'string' ? text : text.outerHTML; + this.execCmd('InsertHTML', txt); + } + + this.syncValue(); + + this.deferFocus(); + } + }, + // private + mozKeyPress : function(e){ + if(e.ctrlKey){ + var c = e.getCharCode(), cmd; + + if(c > 0){ + c = String.fromCharCode(c).toLowerCase(); + switch(c){ + case 'b': + cmd = 'bold'; + break; + case 'i': + cmd = 'italic'; + break; + + case 'u': + cmd = 'underline'; + break; + + case 'v': + this.cleanUpPaste.defer(100, this); + return; + + } + if(cmd){ + this.win.focus(); + this.execCmd(cmd); + this.deferFocus(); + e.preventDefault(); + } + + } + } + }, + + // private + fixKeys : function(){ // load time branching for fastest keydown performance + if(Roo.isIE){ + return function(e){ + var k = e.getKey(), r; + if(k == e.TAB){ + e.stopEvent(); + r = this.doc.selection.createRange(); + if(r){ + r.collapse(true); + r.pasteHTML('&#160;&#160;&#160;&#160;'); + this.deferFocus(); + } + return; + } + + if(k == e.ENTER){ + r = this.doc.selection.createRange(); + if(r){ + var target = r.parentElement(); + if(!target || target.tagName.toLowerCase() != 'li'){ + e.stopEvent(); + r.pasteHTML('<br />'); + r.collapse(false); + r.select(); + } + } + } + if (String.fromCharCode(k).toLowerCase() == 'v') { // paste + this.cleanUpPaste.defer(100, this); + return; + } + + + }; + }else if(Roo.isOpera){ + return function(e){ + var k = e.getKey(); + if(k == e.TAB){ + e.stopEvent(); + this.win.focus(); + this.execCmd('InsertHTML','&#160;&#160;&#160;&#160;'); + this.deferFocus(); + } + if (String.fromCharCode(k).toLowerCase() == 'v') { // paste + this.cleanUpPaste.defer(100, this); + return; + } + + }; + }else if(Roo.isSafari){ + return function(e){ + var k = e.getKey(); + + if(k == e.TAB){ + e.stopEvent(); + this.execCmd('InsertText','\t'); + this.deferFocus(); + return; + } + if (String.fromCharCode(k).toLowerCase() == 'v') { // paste + this.cleanUpPaste.defer(100, this); + return; + } + + }; + } + }(), + + getAllAncestors: function() + { + var p = this.getSelectedNode(); + var a = []; + if (!p) { + a.push(p); // push blank onto stack.. + p = this.getParentElement(); + } + + + while (p && (p.nodeType == 1) && (p.tagName.toLowerCase() != 'body')) { + a.push(p); + p = p.parentNode; + } + a.push(this.doc.body); + return a; + }, + lastSel : false, + lastSelNode : false, + + + getSelection : function() + { + this.assignDocWin(); + return Roo.isIE ? this.doc.selection : this.win.getSelection(); + }, + + getSelectedNode: function() + { + // this may only work on Gecko!!! + + // should we cache this!!!! + + + + + var range = this.createRange(this.getSelection()).cloneRange(); + + if (Roo.isIE) { + var parent = range.parentElement(); + while (true) { + var testRange = range.duplicate(); + testRange.moveToElementText(parent); + if (testRange.inRange(range)) { + break; + } + if ((parent.nodeType != 1) || (parent.tagName.toLowerCase() == 'body')) { + break; + } + parent = parent.parentElement; + } + return parent; + } + + // is ancestor a text element. + var ac = range.commonAncestorContainer; + if (ac.nodeType == 3) { + ac = ac.parentNode; + } + + var ar = ac.childNodes; + + var nodes = []; + var other_nodes = []; + var has_other_nodes = false; + for (var i=0;i<ar.length;i++) { + if ((ar[i].nodeType == 3) && (!ar[i].data.length)) { // empty text ? + continue; + } + // fullly contained node. + + if (this.rangeIntersectsNode(range,ar[i]) && this.rangeCompareNode(range,ar[i]) == 3) { + nodes.push(ar[i]); + continue; + } + + // probably selected.. + if ((ar[i].nodeType == 1) && this.rangeIntersectsNode(range,ar[i]) && (this.rangeCompareNode(range,ar[i]) > 0)) { + other_nodes.push(ar[i]); + continue; + } + // outer.. + if (!this.rangeIntersectsNode(range,ar[i])|| (this.rangeCompareNode(range,ar[i]) == 0)) { + continue; + } + + + has_other_nodes = true; + } + if (!nodes.length && other_nodes.length) { + nodes= other_nodes; + } + if (has_other_nodes || !nodes.length || (nodes.length > 1)) { + return false; + } + + return nodes[0]; + }, + createRange: function(sel) + { + // this has strange effects when using with + // top toolbar - not sure if it's a great idea. + //this.editor.contentWindow.focus(); + if (typeof sel != "undefined") { + try { + return sel.getRangeAt ? sel.getRangeAt(0) : sel.createRange(); + } catch(e) { + return this.doc.createRange(); + } + } else { + return this.doc.createRange(); + } + }, + getParentElement: function() + { + + this.assignDocWin(); + var sel = Roo.isIE ? this.doc.selection : this.win.getSelection(); + + var range = this.createRange(sel); + + try { + var p = range.commonAncestorContainer; + while (p.nodeType == 3) { // text node + p = p.parentNode; + } + return p; + } catch (e) { + return null; + } + + }, + /*** + * + * Range intersection.. the hard stuff... + * '-1' = before + * '0' = hits.. + * '1' = after. + * [ -- selected range --- ] + * [fail] [fail] + * + * basically.. + * if end is before start or hits it. fail. + * if start is after end or hits it fail. + * + * if either hits (but other is outside. - then it's not + * + * + **/ + + + // @see http://www.thismuchiknow.co.uk/?p=64. + rangeIntersectsNode : function(range, node) + { + var nodeRange = node.ownerDocument.createRange(); + try { + nodeRange.selectNode(node); + } catch (e) { + nodeRange.selectNodeContents(node); + } + + var rangeStartRange = range.cloneRange(); + rangeStartRange.collapse(true); + + var rangeEndRange = range.cloneRange(); + rangeEndRange.collapse(false); + + var nodeStartRange = nodeRange.cloneRange(); + nodeStartRange.collapse(true); + + var nodeEndRange = nodeRange.cloneRange(); + nodeEndRange.collapse(false); + + return rangeStartRange.compareBoundaryPoints( + Range.START_TO_START, nodeEndRange) == -1 && + rangeEndRange.compareBoundaryPoints( + Range.START_TO_START, nodeStartRange) == 1; + + + }, + rangeCompareNode : function(range, node) + { + var nodeRange = node.ownerDocument.createRange(); + try { + nodeRange.selectNode(node); + } catch (e) { + nodeRange.selectNodeContents(node); + } + + + range.collapse(true); + + nodeRange.collapse(true); + + var ss = range.compareBoundaryPoints( Range.START_TO_START, nodeRange); + var ee = range.compareBoundaryPoints( Range.END_TO_END, nodeRange); + + //Roo.log(node.tagName + ': ss='+ss +', ee='+ee) + + var nodeIsBefore = ss == 1; + var nodeIsAfter = ee == -1; + + if (nodeIsBefore && nodeIsAfter) { + return 0; // outer + } + if (!nodeIsBefore && nodeIsAfter) { + return 1; //right trailed. + } + + if (nodeIsBefore && !nodeIsAfter) { + return 2; // left trailed. + } + // fully contined. + return 3; + }, + + // private? - in a new class? + cleanUpPaste : function() + { + // cleans up the whole document.. + Roo.log('cleanuppaste'); + + this.cleanUpChildren(this.doc.body); + var clean = this.cleanWordChars(this.doc.body.innerHTML); + if (clean != this.doc.body.innerHTML) { + this.doc.body.innerHTML = clean; + } + + }, + + cleanWordChars : function(input) {// change the chars to hex code + var he = Roo.HtmlEditorCore; + + var output = input; + Roo.each(he.swapCodes, function(sw) { + var swapper = new RegExp("\\u" + sw[0].toString(16), "g"); // hex codes + + output = output.replace(swapper, sw[1]); + }); + + return output; + }, + + + cleanUpChildren : function (n) + { + if (!n.childNodes.length) { + return; + } + for (var i = n.childNodes.length-1; i > -1 ; i--) { + this.cleanUpChild(n.childNodes[i]); + } + }, + + + + + cleanUpChild : function (node) + { + var ed = this; + //console.log(node); + if (node.nodeName == "#text") { + // clean up silly Windows -- stuff? + return; + } + if (node.nodeName == "#comment") { + node.parentNode.removeChild(node); + // clean up silly Windows -- stuff? + return; + } + var lcname = node.tagName.toLowerCase(); + // we ignore whitelists... ?? = not really the way to go, but we probably have not got a full + // whitelist of tags.. + + if (this.black.indexOf(lcname) > -1 && this.clearUp ) { + // remove node. + node.parentNode.removeChild(node); + return; + + } + + var remove_keep_children= Roo.HtmlEditorCore.remove.indexOf(node.tagName.toLowerCase()) > -1; + + // remove <a name=....> as rendering on yahoo mailer is borked with this. + // this will have to be flaged elsewhere - perhaps ablack=name... on the mailer.. + + //if (node.tagName.toLowerCase() == 'a' && !node.hasAttribute('href')) { + // remove_keep_children = true; + //} + + if (remove_keep_children) { + this.cleanUpChildren(node); + // inserts everything just before this node... + while (node.childNodes.length) { + var cn = node.childNodes[0]; + node.removeChild(cn); + node.parentNode.insertBefore(cn, node); + } + node.parentNode.removeChild(node); + return; + } + + if (!node.attributes || !node.attributes.length) { + this.cleanUpChildren(node); + return; + } + + function cleanAttr(n,v) + { + + if (v.match(/^\./) || v.match(/^\//)) { + return; + } + if (v.match(/^(http|https):\/\//) || v.match(/^mailto:/) || v.match(/^ftp:/)) { + return; + } + if (v.match(/^#/)) { + return; + } +// Roo.log("(REMOVE TAG)"+ node.tagName +'.' + n + '=' + v); + node.removeAttribute(n); + + } + + var cwhite = this.cwhite; + var cblack = this.cblack; + + function cleanStyle(n,v) + { + if (v.match(/expression/)) { //XSS?? should we even bother.. + node.removeAttribute(n); + return; + } + + var parts = v.split(/;/); + var clean = []; + + Roo.each(parts, function(p) { + p = p.replace(/^\s+/g,'').replace(/\s+$/g,''); + if (!p.length) { + return true; + } + var l = p.split(':').shift().replace(/\s+/g,''); + l = l.replace(/^\s+/g,'').replace(/\s+$/g,''); + + if ( cwhite.length && cblack.indexOf(l) > -1) { +// Roo.log('(REMOVE CSS)' + node.tagName +'.' + n + ':'+l + '=' + v); + //node.removeAttribute(n); + return true; + } + //Roo.log() + // only allow 'c whitelisted system attributes' + if ( cwhite.length && cwhite.indexOf(l) < 0) { +// Roo.log('(REMOVE CSS)' + node.tagName +'.' + n + ':'+l + '=' + v); + //node.removeAttribute(n); + return true; + } + + + + + clean.push(p); + return true; + }); + if (clean.length) { + node.setAttribute(n, clean.join(';')); + } else { + node.removeAttribute(n); + } + + } + + + for (var i = node.attributes.length-1; i > -1 ; i--) { + var a = node.attributes[i]; + //console.log(a); + + if (a.name.toLowerCase().substr(0,2)=='on') { + node.removeAttribute(a.name); + continue; + } + if (Roo.HtmlEditorCore.ablack.indexOf(a.name.toLowerCase()) > -1) { + node.removeAttribute(a.name); + continue; + } + if (Roo.HtmlEditorCore.aclean.indexOf(a.name.toLowerCase()) > -1) { + cleanAttr(a.name,a.value); // fixme.. + continue; + } + if (a.name == 'style') { + cleanStyle(a.name,a.value); + continue; + } + /// clean up MS crap.. + // tecnically this should be a list of valid class'es.. + + + if (a.name == 'class') { + if (a.value.match(/^Mso/)) { + node.className = ''; + } + + if (a.value.match(/^body$/)) { + node.className = ''; + } + continue; + } + + // style cleanup!? + // class cleanup? + + } + + + this.cleanUpChildren(node); + + + }, + + /** + * Clean up MS wordisms... + */ + cleanWord : function(node) + { + + + if (!node) { + this.cleanWord(this.doc.body); + return; + } + if (node.nodeName == "#text") { + // clean up silly Windows -- stuff? + return; + } + if (node.nodeName == "#comment") { + node.parentNode.removeChild(node); + // clean up silly Windows -- stuff? + return; + } + + if (node.tagName.toLowerCase().match(/^(style|script|applet|embed|noframes|noscript)$/)) { + node.parentNode.removeChild(node); + return; + } + + // remove - but keep children.. + if (node.tagName.toLowerCase().match(/^(meta|link|\\?xml:|st1:|o:|font)/)) { + while (node.childNodes.length) { + var cn = node.childNodes[0]; + node.removeChild(cn); + node.parentNode.insertBefore(cn, node); + } + node.parentNode.removeChild(node); + this.iterateChildren(node, this.cleanWord); + return; + } + // clean styles + if (node.className.length) { + + var cn = node.className.split(/\W+/); + var cna = []; + Roo.each(cn, function(cls) { + if (cls.match(/Mso[a-zA-Z]+/)) { + return; + } + cna.push(cls); + }); + node.className = cna.length ? cna.join(' ') : ''; + if (!cna.length) { + node.removeAttribute("class"); + } + } + + if (node.hasAttribute("lang")) { + node.removeAttribute("lang"); + } + + if (node.hasAttribute("style")) { + + var styles = node.getAttribute("style").split(";"); + var nstyle = []; + Roo.each(styles, function(s) { + if (!s.match(/:/)) { + return; + } + var kv = s.split(":"); + if (kv[0].match(/^(mso-|line|font|background|margin|padding|color)/)) { + return; + } + // what ever is left... we allow. + nstyle.push(s); + }); + node.setAttribute("style", nstyle.length ? nstyle.join(';') : ''); + if (!nstyle.length) { + node.removeAttribute('style'); + } + } + this.iterateChildren(node, this.cleanWord); + + + + }, + /** + * iterateChildren of a Node, calling fn each time, using this as the scole.. + * @param {DomNode} node node to iterate children of. + * @param {Function} fn method of this class to call on each item. + */ + iterateChildren : function(node, fn) + { + if (!node.childNodes.length) { + return; + } + for (var i = node.childNodes.length-1; i > -1 ; i--) { + fn.call(this, node.childNodes[i]) + } + }, + + + /** + * cleanTableWidths. + * + * Quite often pasting from word etc.. results in tables with column and widths. + * This does not work well on fluid HTML layouts - like emails. - so this code should hunt an destroy them.. + * + */ + cleanTableWidths : function(node) + { + + + if (!node) { + this.cleanTableWidths(this.doc.body); + return; + } + + // ignore list... + if (node.nodeName == "#text" || node.nodeName == "#comment") { + return; + } + Roo.log(node.tagName); + if (!node.tagName.toLowerCase().match(/^(table|td|tr)$/)) { + this.iterateChildren(node, this.cleanTableWidths); + return; + } + if (node.hasAttribute('width')) { + node.removeAttribute('width'); + } + + + if (node.hasAttribute("style")) { + // pretty basic... + + var styles = node.getAttribute("style").split(";"); + var nstyle = []; + Roo.each(styles, function(s) { + if (!s.match(/:/)) { + return; + } + var kv = s.split(":"); + if (kv[0].match(/^\s*(width|min-width)\s*$/)) { + return; + } + // what ever is left... we allow. + nstyle.push(s); + }); + node.setAttribute("style", nstyle.length ? nstyle.join(';') : ''); + if (!nstyle.length) { + node.removeAttribute('style'); + } + } + + this.iterateChildren(node, this.cleanTableWidths); + + + }, + + + + + domToHTML : function(currentElement, depth, nopadtext) { + + depth = depth || 0; + nopadtext = nopadtext || false; + + if (!currentElement) { + return this.domToHTML(this.doc.body); + } + + //Roo.log(currentElement); + var j; + var allText = false; + var nodeName = currentElement.nodeName; + var tagName = Roo.util.Format.htmlEncode(currentElement.tagName); + + if (nodeName == '#text') { + + return nopadtext ? currentElement.nodeValue : currentElement.nodeValue.trim(); + } + + + var ret = ''; + if (nodeName != 'BODY') { + + var i = 0; + // Prints the node tagName, such as <A>, <IMG>, etc + if (tagName) { + var attr = []; + for(i = 0; i < currentElement.attributes.length;i++) { + // quoting? + var aname = currentElement.attributes.item(i).name; + if (!currentElement.attributes.item(i).value.length) { + continue; + } + attr.push(aname + '="' + Roo.util.Format.htmlEncode(currentElement.attributes.item(i).value) + '"' ); + } + + ret = "<"+currentElement.tagName+ ( attr.length ? (' ' + attr.join(' ') ) : '') + ">"; + } + else { + + // eack + } + } else { + tagName = false; + } + if (['IMG', 'BR', 'HR', 'INPUT'].indexOf(tagName) > -1) { + return ret; + } + if (['PRE', 'TEXTAREA', 'TD', 'A', 'SPAN'].indexOf(tagName) > -1) { // or code? + nopadtext = true; + } + + + // Traverse the tree + i = 0; + var currentElementChild = currentElement.childNodes.item(i); + var allText = true; + var innerHTML = ''; + lastnode = ''; + while (currentElementChild) { + // Formatting code (indent the tree so it looks nice on the screen) + var nopad = nopadtext; + if (lastnode == 'SPAN') { + nopad = true; + } + // text + if (currentElementChild.nodeName == '#text') { + var toadd = Roo.util.Format.htmlEncode(currentElementChild.nodeValue); + toadd = nopadtext ? toadd : toadd.trim(); + if (!nopad && toadd.length > 80) { + innerHTML += "\n" + (new Array( depth + 1 )).join( " " ); + } + innerHTML += toadd; + + i++; + currentElementChild = currentElement.childNodes.item(i); + lastNode = ''; + continue; + } + allText = false; + + innerHTML += nopad ? '' : "\n" + (new Array( depth + 1 )).join( " " ); + + // Recursively traverse the tree structure of the child node + innerHTML += this.domToHTML(currentElementChild, depth+1, nopadtext); + lastnode = currentElementChild.nodeName; + i++; + currentElementChild=currentElement.childNodes.item(i); + } + + ret += innerHTML; + + if (!allText) { + // The remaining code is mostly for formatting the tree + ret+= nopadtext ? '' : "\n" + (new Array( depth )).join( " " ); + } + + + if (tagName) { + ret+= "</"+tagName+">"; + } + return ret; + + }, + + applyBlacklists : function() + { + var w = typeof(this.owner.white) != 'undefined' && this.owner.white ? this.owner.white : []; + var b = typeof(this.owner.black) != 'undefined' && this.owner.black ? this.owner.black : []; + + this.white = []; + this.black = []; + Roo.each(Roo.HtmlEditorCore.white, function(tag) { + if (b.indexOf(tag) > -1) { + return; + } + this.white.push(tag); + + }, this); + + Roo.each(w, function(tag) { + if (b.indexOf(tag) > -1) { + return; + } + if (this.white.indexOf(tag) > -1) { + return; + } + this.white.push(tag); + + }, this); + + + Roo.each(Roo.HtmlEditorCore.black, function(tag) { + if (w.indexOf(tag) > -1) { + return; + } + this.black.push(tag); + + }, this); + + Roo.each(b, function(tag) { + if (w.indexOf(tag) > -1) { + return; + } + if (this.black.indexOf(tag) > -1) { + return; + } + this.black.push(tag); + + }, this); + + + w = typeof(this.owner.cwhite) != 'undefined' && this.owner.cwhite ? this.owner.cwhite : []; + b = typeof(this.owner.cblack) != 'undefined' && this.owner.cblack ? this.owner.cblack : []; + + this.cwhite = []; + this.cblack = []; + Roo.each(Roo.HtmlEditorCore.cwhite, function(tag) { + if (b.indexOf(tag) > -1) { + return; + } + this.cwhite.push(tag); + + }, this); + + Roo.each(w, function(tag) { + if (b.indexOf(tag) > -1) { + return; + } + if (this.cwhite.indexOf(tag) > -1) { + return; + } + this.cwhite.push(tag); + + }, this); + + + Roo.each(Roo.HtmlEditorCore.cblack, function(tag) { + if (w.indexOf(tag) > -1) { + return; + } + this.cblack.push(tag); + + }, this); + + Roo.each(b, function(tag) { + if (w.indexOf(tag) > -1) { + return; + } + if (this.cblack.indexOf(tag) > -1) { + return; + } + this.cblack.push(tag); + + }, this); + }, + + setStylesheets : function(stylesheets) + { + if(typeof(stylesheets) == 'string'){ + Roo.get(this.iframe.contentDocument.head).createChild({ + tag : 'link', + rel : 'stylesheet', + type : 'text/css', + href : stylesheets + }); + + return; + } + var _this = this; + + Roo.each(stylesheets, function(s) { + if(!s.length){ + return; + } + + Roo.get(_this.iframe.contentDocument.head).createChild({ + tag : 'link', + rel : 'stylesheet', + type : 'text/css', + href : s + }); + }); + + + }, + + removeStylesheets : function() + { + var _this = this; + + Roo.each(Roo.get(_this.iframe.contentDocument.head).select('link[rel=stylesheet]', true).elements, function(s){ + s.remove(); + }); + }, + + setStyle : function(style) + { + Roo.get(this.iframe.contentDocument.head).createChild({ + tag : 'style', + type : 'text/css', + html : style + }); + + return; + } + + // hide stuff that is not compatible + /** + * @event blur + * @hide + */ + /** + * @event change + * @hide + */ + /** + * @event focus + * @hide + */ + /** + * @event specialkey + * @hide + */ + /** + * @cfg {String} fieldClass @hide + */ + /** + * @cfg {String} focusClass @hide + */ + /** + * @cfg {String} autoCreate @hide + */ + /** + * @cfg {String} inputType @hide + */ + /** + * @cfg {String} invalidClass @hide + */ + /** + * @cfg {String} invalidText @hide + */ + /** + * @cfg {String} msgFx @hide + */ + /** + * @cfg {String} validateOnBlur @hide + */ +}); + +Roo.HtmlEditorCore.white = [ + 'area', 'br', 'img', 'input', 'hr', 'wbr', + + 'address', 'blockquote', 'center', 'dd', 'dir', 'div', + 'dl', 'dt', 'h1', 'h2', 'h3', 'h4', + 'h5', 'h6', 'hr', 'isindex', 'listing', 'marquee', + 'menu', 'multicol', 'ol', 'p', 'plaintext', 'pre', + 'table', 'ul', 'xmp', + + 'caption', 'col', 'colgroup', 'tbody', 'td', 'tfoot', 'th', + 'thead', 'tr', + + 'dir', 'menu', 'ol', 'ul', 'dl', + + 'embed', 'object' +]; + + +Roo.HtmlEditorCore.black = [ + // 'embed', 'object', // enable - backend responsiblity to clean thiese + 'applet', // + 'base', 'basefont', 'bgsound', 'blink', 'body', + 'frame', 'frameset', 'head', 'html', 'ilayer', + 'iframe', 'layer', 'link', 'meta', 'object', + 'script', 'style' ,'title', 'xml' // clean later.. +]; +Roo.HtmlEditorCore.clean = [ + 'script', 'style', 'title', 'xml' +]; +Roo.HtmlEditorCore.remove = [ + 'font' +]; +// attributes.. + +Roo.HtmlEditorCore.ablack = [ + 'on' +]; + +Roo.HtmlEditorCore.aclean = [ + 'action', 'background', 'codebase', 'dynsrc', 'href', 'lowsrc' +]; + +// protocols.. +Roo.HtmlEditorCore.pwhite= [ + 'http', 'https', 'mailto' +]; + +// white listed style attributes. +Roo.HtmlEditorCore.cwhite= [ + // 'text-align', /// default is to allow most things.. + + +// 'font-size'//?? +]; + +// black listed style attributes. +Roo.HtmlEditorCore.cblack= [ + // 'font-size' -- this can be set by the project +]; + + +Roo.HtmlEditorCore.swapCodes =[ + [ 8211, "--" ], + [ 8212, "--" ], + [ 8216, "'" ], + [ 8217, "'" ], + [ 8220, '"' ], + [ 8221, '"' ], + [ 8226, "*" ], + [ 8230, "..." ] +]; + + \ No newline at end of file diff --git a/docs2/src/Roo_JsonView.js.html b/docs2/src/Roo_JsonView.js.html new file mode 100644 index 0000000000..5c6c9253ca --- /dev/null +++ b/docs2/src/Roo_JsonView.js.html @@ -0,0 +1,318 @@ +/home/alan/gitlive/roojs1/Roo/JsonView.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.JsonView + * @extends Roo.View + * Shortcut class to create a JSON + {@link Roo.UpdateManager} template view. Usage: +<pre><code> +var view = new Roo.JsonView({ + container: "my-element", + tpl: '&lt;div id="{id}"&gt;{foo} - {bar}&lt;/div&gt;', // auto create template + multiSelect: true, + jsonRoot: "data" +}); + +// listen for node click? +view.on("click", function(vw, index, node, e){ + alert('Node "' + node.id + '" at index: ' + index + " was clicked."); +}); + +// direct load of JSON data +view.load("foobar.php"); + +// Example from my blog list +var tpl = new Roo.Template( + '&lt;div class="entry"&gt;' + + '&lt;a class="entry-title" href="{link}"&gt;{title}&lt;/a&gt;' + + "&lt;h4&gt;{date} by {author} | {comments} Comments&lt;/h4&gt;{description}" + + "&lt;/div&gt;&lt;hr /&gt;" +); + +var moreView = new Roo.JsonView({ + container : "entry-list", + template : tpl, + jsonRoot: "posts" +}); +moreView.on("beforerender", this.sortEntries, this); +moreView.load({ + url: "/blog/get-posts.php", + params: "allposts=true", + text: "Loading Blog Entries..." +}); +</code></pre> +* +* Note: old code is supported with arguments : (container, template, config) +* +* + * @constructor + * Create a new JsonView + * + * @param {Object} config The config object + * + */ +Roo.JsonView = function(config, depreciated_tpl, depreciated_config){ + + + Roo.JsonView.superclass.constructor.call(this, config, depreciated_tpl, depreciated_config); + + var um = this.el.getUpdateManager(); + um.setRenderer(this); + um.on("update", this.onLoad, this); + um.on("failure", this.onLoadException, this); + + /** + * @event beforerender + * Fires before rendering of the downloaded JSON data. + * @param {Roo.JsonView} this + * @param {Object} data The JSON data loaded + */ + /** + * @event load + * Fires when data is loaded. + * @param {Roo.JsonView} this + * @param {Object} data The JSON data loaded + * @param {Object} response The raw Connect response object + */ + /** + * @event loadexception + * Fires when loading fails. + * @param {Roo.JsonView} this + * @param {Object} response The raw Connect response object + */ + this.addEvents({ + 'beforerender' : true, + 'load' : true, + 'loadexception' : true + }); +}; +Roo.extend(Roo.JsonView, Roo.View, { + /** + * @type {String} The root property in the loaded JSON object that contains the data + */ + jsonRoot : "", + + /** + * Refreshes the view. + */ + refresh : function(){ + this.clearSelections(); + this.el.update(""); + var html = []; + var o = this.jsonData; + if(o && o.length > 0){ + for(var i = 0, len = o.length; i < len; i++){ + var data = this.prepareData(o[i], i, o); + html[html.length] = this.tpl.apply(data); + } + }else{ + html.push(this.emptyText); + } + this.el.update(html.join("")); + this.nodes = this.el.dom.childNodes; + this.updateIndexes(0); + }, + + /** + * Performs an async HTTP request, and loads the JSON from the response. If <i>params</i> are specified it uses POST, otherwise it uses GET. + * @param {Object/String/Function} url The URL for this request, or a function to call to get the URL, or a config object containing any of the following options: + <pre><code> + view.load({ + url: "your-url.php", + params: {param1: "foo", param2: "bar"}, // or a URL encoded string + callback: yourFunction, + scope: yourObject, //(optional scope) + discardUrl: false, + nocache: false, + text: "Loading...", + timeout: 30, + scripts: false + }); + </code></pre> + * The only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i> + * are respectively shorthand for <i>disableCaching</i>, <i>indicatorText</i>, and <i>loadScripts</i> and are used to set their associated property on this UpdateManager instance. + * @param {String/Object} params (optional) The parameters to pass, as either a URL encoded string "param1=1&amp;param2=2" or an object {param1: 1, param2: 2} + * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess) + * @param {Boolean} discardUrl (optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL. + */ + load : function(){ + var um = this.el.getUpdateManager(); + um.update.apply(um, arguments); + }, + + // note - render is a standard framework call... + // using it for the response is really flaky... - it's called by UpdateManager normally, except when called by the XComponent/addXtype. + render : function(el, response){ + + this.clearSelections(); + this.el.update(""); + var o; + try{ + if (response != '') { + o = Roo.util.JSON.decode(response.responseText); + if(this.jsonRoot){ + + o = o[this.jsonRoot]; + } + } + } catch(e){ + } + /** + * The current JSON data or null + */ + this.jsonData = o; + this.beforeRender(); + this.refresh(); + }, + +/** + * Get the number of records in the current JSON dataset + * @return {Number} + */ + getCount : function(){ + return this.jsonData ? this.jsonData.length : 0; + }, + +/** + * Returns the JSON object for the specified node(s) + * @param {HTMLElement/Array} node The node or an array of nodes + * @return {Object/Array} If you pass in an array, you get an array back, otherwise + * you get the JSON object for the node + */ + getNodeData : function(node){ + if(node instanceof Array){ + var data = []; + for(var i = 0, len = node.length; i < len; i++){ + data.push(this.getNodeData(node[i])); + } + return data; + } + return this.jsonData[this.indexOf(node)] || null; + }, + + beforeRender : function(){ + this.snapshot = this.jsonData; + if(this.sortInfo){ + this.sort.apply(this, this.sortInfo); + } + this.fireEvent("beforerender", this, this.jsonData); + }, + + onLoad : function(el, o){ + this.fireEvent("load", this, this.jsonData, o); + }, + + onLoadException : function(el, o){ + this.fireEvent("loadexception", this, o); + }, + +/** + * Filter the data by a specific property. + * @param {String} property A property on your JSON objects + * @param {String/RegExp} value Either string that the property values + * should start with, or a RegExp to test against the property + */ + filter : function(property, value){ + if(this.jsonData){ + var data = []; + var ss = this.snapshot; + if(typeof value == "string"){ + var vlen = value.length; + if(vlen == 0){ + this.clearFilter(); + return; + } + value = value.toLowerCase(); + for(var i = 0, len = ss.length; i < len; i++){ + var o = ss[i]; + if(o[property].substr(0, vlen).toLowerCase() == value){ + data.push(o); + } + } + } else if(value.exec){ // regex? + for(var i = 0, len = ss.length; i < len; i++){ + var o = ss[i]; + if(value.test(o[property])){ + data.push(o); + } + } + } else{ + return; + } + this.jsonData = data; + this.refresh(); + } + }, + +/** + * Filter by a function. The passed function will be called with each + * object in the current dataset. If the function returns true the value is kept, + * otherwise it is filtered. + * @param {Function} fn + * @param {Object} scope (optional) The scope of the function (defaults to this JsonView) + */ + filterBy : function(fn, scope){ + if(this.jsonData){ + var data = []; + var ss = this.snapshot; + for(var i = 0, len = ss.length; i < len; i++){ + var o = ss[i]; + if(fn.call(scope || this, o)){ + data.push(o); + } + } + this.jsonData = data; + this.refresh(); + } + }, + +/** + * Clears the current filter. + */ + clearFilter : function(){ + if(this.snapshot && this.jsonData != this.snapshot){ + this.jsonData = this.snapshot; + this.refresh(); + } + }, + + +/** + * Sorts the data for this view and refreshes it. + * @param {String} property A property on your JSON objects to sort on + * @param {String} direction (optional) "desc" or "asc" (defaults to "asc") + * @param {Function} sortType (optional) A function to call to convert the data to a sortable value. + */ + sort : function(property, dir, sortType){ + this.sortInfo = Array.prototype.slice.call(arguments, 0); + if(this.jsonData){ + var p = property; + var dsc = dir && dir.toLowerCase() == "desc"; + var f = function(o1, o2){ + var v1 = sortType ? sortType(o1[p]) : o1[p]; + var v2 = sortType ? sortType(o2[p]) : o2[p]; + ; + if(v1 < v2){ + return dsc ? +1 : -1; + } else if(v1 > v2){ + return dsc ? -1 : +1; + } else{ + return 0; + } + }; + this.jsonData.sort(f); + this.refresh(); + if(this.jsonData != this.snapshot){ + this.snapshot.sort(f); + } + } + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_KeyMap.js.html b/docs2/src/Roo_KeyMap.js.html new file mode 100644 index 0000000000..13c6c11834 --- /dev/null +++ b/docs2/src/Roo_KeyMap.js.html @@ -0,0 +1,222 @@ +/home/alan/gitlive/roojs1/Roo/KeyMap.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.KeyMap + * Handles mapping keys to actions for an element. One key map can be used for multiple actions. + * The constructor accepts the same config object as defined by {@link #addBinding}. + * If you bind a callback function to a KeyMap, anytime the KeyMap handles an expected key + * combination it will call the function with this signature (if the match is a multi-key + * combination the callback will still be called only once): (String key, Roo.EventObject e) + * A KeyMap can also handle a string representation of keys.<br /> + * Usage: + <pre><code> +// map one key by key code +var map = new Roo.KeyMap("my-element", { + key: 13, // or Roo.EventObject.ENTER + fn: myHandler, + scope: myObject +}); + +// map multiple keys to one action by string +var map = new Roo.KeyMap("my-element", { + key: "a\r\n\t", + fn: myHandler, + scope: myObject +}); + +// map multiple keys to multiple actions by strings and array of codes +var map = new Roo.KeyMap("my-element", [ + { + key: [10,13], + fn: function(){ alert("Return was pressed"); } + }, { + key: "abc", + fn: function(){ alert('a, b or c was pressed'); } + }, { + key: "\t", + ctrl:true, + shift:true, + fn: function(){ alert('Control + shift + tab was pressed.'); } + } +]); +</code></pre> + * <b>Note: A KeyMap starts enabled</b> + * @constructor + * @param {String/HTMLElement/Roo.Element} el The element to bind to + * @param {Object} config The config (see {@link #addBinding}) + * @param {String} eventName (optional) The event to bind to (defaults to "keydown") + */ +Roo.KeyMap = function(el, config, eventName){ + this.el = Roo.get(el); + this.eventName = eventName || "keydown"; + this.bindings = []; + if(config){ + this.addBinding(config); + } + this.enable(); +}; + +Roo.KeyMap.prototype = { + /** + * True to stop the event from bubbling and prevent the default browser action if the + * key was handled by the KeyMap (defaults to false) + * @type Boolean + */ + stopEvent : false, + + /** + * Add a new binding to this KeyMap. The following config object properties are supported: + * <pre> +Property Type Description +---------- --------------- ---------------------------------------------------------------------- +key String/Array A single keycode or an array of keycodes to handle +shift Boolean True to handle key only when shift is pressed (defaults to false) +ctrl Boolean True to handle key only when ctrl is pressed (defaults to false) +alt Boolean True to handle key only when alt is pressed (defaults to false) +fn Function The function to call when KeyMap finds the expected key combination +scope Object The scope of the callback function +</pre> + * + * Usage: + * <pre><code> +// Create a KeyMap +var map = new Roo.KeyMap(document, { + key: Roo.EventObject.ENTER, + fn: handleKey, + scope: this +}); + +//Add a new binding to the existing KeyMap later +map.addBinding({ + key: 'abc', + shift: true, + fn: handleKey, + scope: this +}); +</code></pre> + * @param {Object/Array} config A single KeyMap config or an array of configs + */ + addBinding : function(config){ + if(config instanceof Array){ + for(var i = 0, len = config.length; i < len; i++){ + this.addBinding(config[i]); + } + return; + } + var keyCode = config.key, + shift = config.shift, + ctrl = config.ctrl, + alt = config.alt, + fn = config.fn, + scope = config.scope; + if(typeof keyCode == "string"){ + var ks = []; + var keyString = keyCode.toUpperCase(); + for(var j = 0, len = keyString.length; j < len; j++){ + ks.push(keyString.charCodeAt(j)); + } + keyCode = ks; + } + var keyArray = keyCode instanceof Array; + var handler = function(e){ + if((!shift || e.shiftKey) && (!ctrl || e.ctrlKey) && (!alt || e.altKey)){ + var k = e.getKey(); + if(keyArray){ + for(var i = 0, len = keyCode.length; i < len; i++){ + if(keyCode[i] == k){ + if(this.stopEvent){ + e.stopEvent(); + } + fn.call(scope || window, k, e); + return; + } + } + }else{ + if(k == keyCode){ + if(this.stopEvent){ + e.stopEvent(); + } + fn.call(scope || window, k, e); + } + } + } + }; + this.bindings.push(handler); + }, + + /** + * Shorthand for adding a single key listener + * @param {Number/Array/Object} key Either the numeric key code, array of key codes or an object with the + * following options: + * {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)} + * @param {Function} fn The function to call + * @param {Object} scope (optional) The scope of the function + */ + on : function(key, fn, scope){ + var keyCode, shift, ctrl, alt; + if(typeof key == "object" && !(key instanceof Array)){ + keyCode = key.key; + shift = key.shift; + ctrl = key.ctrl; + alt = key.alt; + }else{ + keyCode = key; + } + this.addBinding({ + key: keyCode, + shift: shift, + ctrl: ctrl, + alt: alt, + fn: fn, + scope: scope + }) + }, + + // private + handleKeyDown : function(e){ + if(this.enabled){ //just in case + var b = this.bindings; + for(var i = 0, len = b.length; i < len; i++){ + b[i].call(this, e); + } + } + }, + + /** + * Returns true if this KeyMap is enabled + * @return {Boolean} + */ + isEnabled : function(){ + return this.enabled; + }, + + /** + * Enables this KeyMap + */ + enable: function(){ + if(!this.enabled){ + this.el.on(this.eventName, this.handleKeyDown, this); + this.enabled = true; + } + }, + + /** + * Disable this KeyMap + */ + disable: function(){ + if(this.enabled){ + this.el.removeListener(this.eventName, this.handleKeyDown, this); + this.enabled = false; + } + } +}; \ No newline at end of file diff --git a/docs2/src/Roo_KeyNav.js.html b/docs2/src/Roo_KeyNav.js.html new file mode 100644 index 0000000000..38622af04e --- /dev/null +++ b/docs2/src/Roo_KeyNav.js.html @@ -0,0 +1,157 @@ +/home/alan/gitlive/roojs1/Roo/KeyNav.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.KeyNav + * <p>Provides a convenient wrapper for normalized keyboard navigation. KeyNav allows you to bind + * navigation keys to function calls that will get called when the keys are pressed, providing an easy + * way to implement custom navigation schemes for any UI component.</p> + * <p>The following are all of the possible keys that can be implemented: enter, left, right, up, down, tab, esc, + * pageUp, pageDown, del, home, end. Usage:</p> + <pre><code> +var nav = new Roo.KeyNav("my-element", { + "left" : function(e){ + this.moveLeft(e.ctrlKey); + }, + "right" : function(e){ + this.moveRight(e.ctrlKey); + }, + "enter" : function(e){ + this.save(); + }, + scope : this +}); +</code></pre> + * @constructor + * @param {String/HTMLElement/Roo.Element} el The element to bind to + * @param {Object} config The config + */ +Roo.KeyNav = function(el, config){ + this.el = Roo.get(el); + Roo.apply(this, config); + if(!this.disabled){ + this.disabled = true; + this.enable(); + } +}; + +Roo.KeyNav.prototype = { + /** + * @cfg {Boolean} disabled + * True to disable this KeyNav instance (defaults to false) + */ + disabled : false, + /** + * @cfg {String} defaultEventAction + * The method to call on the {@link Roo.EventObject} after this KeyNav intercepts a key. Valid values are + * {@link Roo.EventObject#stopEvent}, {@link Roo.EventObject#preventDefault} and + * {@link Roo.EventObject#stopPropagation} (defaults to 'stopEvent') + */ + defaultEventAction: "stopEvent", + /** + * @cfg {Boolean} forceKeyDown + * Handle the keydown event instead of keypress (defaults to false). KeyNav automatically does this for IE since + * IE does not propagate special keys on keypress, but setting this to true will force other browsers to also + * handle keydown instead of keypress. + */ + forceKeyDown : false, + + // private + prepareEvent : function(e){ + var k = e.getKey(); + var h = this.keyToHandler[k]; + //if(h && this[h]){ + // e.stopPropagation(); + //} + if(Roo.isSafari && h && k >= 37 && k <= 40){ + e.stopEvent(); + } + }, + + // private + relay : function(e){ + var k = e.getKey(); + var h = this.keyToHandler[k]; + if(h && this[h]){ + if(this.doRelay(e, this[h], h) !== true){ + e[this.defaultEventAction](); + } + } + }, + + // private + doRelay : function(e, h, hname){ + return h.call(this.scope || this, e); + }, + + // possible handlers + enter : false, + left : false, + right : false, + up : false, + down : false, + tab : false, + esc : false, + pageUp : false, + pageDown : false, + del : false, + home : false, + end : false, + + // quick lookup hash + keyToHandler : { + 37 : "left", + 39 : "right", + 38 : "up", + 40 : "down", + 33 : "pageUp", + 34 : "pageDown", + 46 : "del", + 36 : "home", + 35 : "end", + 13 : "enter", + 27 : "esc", + 9 : "tab" + }, + + /** + * Enable this KeyNav + */ + enable: function(){ + if(this.disabled){ + // ie won't do special keys on keypress, no one else will repeat keys with keydown + // the EventObject will normalize Safari automatically + if(this.forceKeyDown || Roo.isIE || Roo.isAir){ + this.el.on("keydown", this.relay, this); + }else{ + this.el.on("keydown", this.prepareEvent, this); + this.el.on("keypress", this.relay, this); + } + this.disabled = false; + } + }, + + /** + * Disable this KeyNav + */ + disable: function(){ + if(!this.disabled){ + if(this.forceKeyDown || Roo.isIE || Roo.isAir){ + this.el.un("keydown", this.relay); + }else{ + this.el.un("keydown", this.prepareEvent); + this.el.un("keypress", this.relay); + } + this.disabled = true; + } + } +}; \ No newline at end of file diff --git a/docs2/src/Roo_Layer.js.html b/docs2/src/Roo_Layer.js.html new file mode 100644 index 0000000000..879d31b700 --- /dev/null +++ b/docs2/src/Roo_Layer.js.html @@ -0,0 +1,458 @@ +/home/alan/gitlive/roojs1/Roo/Layer.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + (function(){ +/** + * @class Roo.Layer + * @extends Roo.Element + * An extended {@link Roo.Element} object that supports a shadow and shim, constrain to viewport and + * automatic maintaining of shadow/shim positions. + * @cfg {Boolean} shim False to disable the iframe shim in browsers which need one (defaults to true) + * @cfg {String/Boolean} shadow True to create a shadow element with default class "x-layer-shadow", or + * you can pass a string with a CSS class name. False turns off the shadow. + * @cfg {Object} dh DomHelper object config to create element with (defaults to {tag: "div", cls: "x-layer"}). + * @cfg {Boolean} constrain False to disable constrain to viewport (defaults to true) + * @cfg {String} cls CSS class to add to the element + * @cfg {Number} zindex Starting z-index (defaults to 11000) + * @cfg {Number} shadowOffset Number of pixels to offset the shadow (defaults to 3) + * @constructor + * @param {Object} config An object with config options. + * @param {String/HTMLElement} existingEl (optional) Uses an existing DOM element. If the element is not found it creates it. + */ + +Roo.Layer = function(config, existingEl){ + config = config || {}; + var dh = Roo.DomHelper; + var cp = config.parentEl, pel = cp ? Roo.getDom(cp) : document.body; + if(existingEl){ + this.dom = Roo.getDom(existingEl); + } + if(!this.dom){ + var o = config.dh || {tag: "div", cls: "x-layer"}; + this.dom = dh.append(pel, o); + } + if(config.cls){ + this.addClass(config.cls); + } + this.constrain = config.constrain !== false; + this.visibilityMode = Roo.Element.VISIBILITY; + if(config.id){ + this.id = this.dom.id = config.id; + }else{ + this.id = Roo.id(this.dom); + } + this.zindex = config.zindex || this.getZIndex(); + this.position("absolute", this.zindex); + if(config.shadow){ + this.shadowOffset = config.shadowOffset || 4; + this.shadow = new Roo.Shadow({ + offset : this.shadowOffset, + mode : config.shadow + }); + }else{ + this.shadowOffset = 0; + } + this.useShim = config.shim !== false && Roo.useShims; + this.useDisplay = config.useDisplay; + this.hide(); +}; + +var supr = Roo.Element.prototype; + +// shims are shared among layer to keep from having 100 iframes +var shims = []; + +Roo.extend(Roo.Layer, Roo.Element, { + + getZIndex : function(){ + return this.zindex || parseInt(this.getStyle("z-index"), 10) || 11000; + }, + + getShim : function(){ + if(!this.useShim){ + return null; + } + if(this.shim){ + return this.shim; + } + var shim = shims.shift(); + if(!shim){ + shim = this.createShim(); + shim.enableDisplayMode('block'); + shim.dom.style.display = 'none'; + shim.dom.style.visibility = 'visible'; + } + var pn = this.dom.parentNode; + if(shim.dom.parentNode != pn){ + pn.insertBefore(shim.dom, this.dom); + } + shim.setStyle('z-index', this.getZIndex()-2); + this.shim = shim; + return shim; + }, + + hideShim : function(){ + if(this.shim){ + this.shim.setDisplayed(false); + shims.push(this.shim); + delete this.shim; + } + }, + + disableShadow : function(){ + if(this.shadow){ + this.shadowDisabled = true; + this.shadow.hide(); + this.lastShadowOffset = this.shadowOffset; + this.shadowOffset = 0; + } + }, + + enableShadow : function(show){ + if(this.shadow){ + this.shadowDisabled = false; + this.shadowOffset = this.lastShadowOffset; + delete this.lastShadowOffset; + if(show){ + this.sync(true); + } + } + }, + + // private + // this code can execute repeatedly in milliseconds (i.e. during a drag) so + // code size was sacrificed for effeciency (e.g. no getBox/setBox, no XY calls) + sync : function(doShow){ + var sw = this.shadow; + if(!this.updating && this.isVisible() && (sw || this.useShim)){ + var sh = this.getShim(); + + var w = this.getWidth(), + h = this.getHeight(); + + var l = this.getLeft(true), + t = this.getTop(true); + + if(sw && !this.shadowDisabled){ + if(doShow && !sw.isVisible()){ + sw.show(this); + }else{ + sw.realign(l, t, w, h); + } + if(sh){ + if(doShow){ + sh.show(); + } + // fit the shim behind the shadow, so it is shimmed too + var a = sw.adjusts, s = sh.dom.style; + s.left = (Math.min(l, l+a.l))+"px"; + s.top = (Math.min(t, t+a.t))+"px"; + s.width = (w+a.w)+"px"; + s.height = (h+a.h)+"px"; + } + }else if(sh){ + if(doShow){ + sh.show(); + } + sh.setSize(w, h); + sh.setLeftTop(l, t); + } + + } + }, + + // private + destroy : function(){ + this.hideShim(); + if(this.shadow){ + this.shadow.hide(); + } + this.removeAllListeners(); + var pn = this.dom.parentNode; + if(pn){ + pn.removeChild(this.dom); + } + Roo.Element.uncache(this.id); + }, + + remove : function(){ + this.destroy(); + }, + + // private + beginUpdate : function(){ + this.updating = true; + }, + + // private + endUpdate : function(){ + this.updating = false; + this.sync(true); + }, + + // private + hideUnders : function(negOffset){ + if(this.shadow){ + this.shadow.hide(); + } + this.hideShim(); + }, + + // private + constrainXY : function(){ + if(this.constrain){ + var vw = Roo.lib.Dom.getViewWidth(), + vh = Roo.lib.Dom.getViewHeight(); + var s = Roo.get(document).getScroll(); + + var xy = this.getXY(); + var x = xy[0], y = xy[1]; + var w = this.dom.offsetWidth+this.shadowOffset, h = this.dom.offsetHeight+this.shadowOffset; + // only move it if it needs it + var moved = false; + // first validate right/bottom + if((x + w) > vw+s.left){ + x = vw - w - this.shadowOffset; + moved = true; + } + if((y + h) > vh+s.top){ + y = vh - h - this.shadowOffset; + moved = true; + } + // then make sure top/left isn't negative + if(x < s.left){ + x = s.left; + moved = true; + } + if(y < s.top){ + y = s.top; + moved = true; + } + if(moved){ + if(this.avoidY){ + var ay = this.avoidY; + if(y <= ay && (y+h) >= ay){ + y = ay-h-5; + } + } + xy = [x, y]; + this.storeXY(xy); + supr.setXY.call(this, xy); + this.sync(); + } + } + }, + + isVisible : function(){ + return this.visible; + }, + + // private + showAction : function(){ + this.visible = true; // track visibility to prevent getStyle calls + if(this.useDisplay === true){ + this.setDisplayed(""); + }else if(this.lastXY){ + supr.setXY.call(this, this.lastXY); + }else if(this.lastLT){ + supr.setLeftTop.call(this, this.lastLT[0], this.lastLT[1]); + } + }, + + // private + hideAction : function(){ + this.visible = false; + if(this.useDisplay === true){ + this.setDisplayed(false); + }else{ + this.setLeftTop(-10000,-10000); + } + }, + + // overridden Element method + setVisible : function(v, a, d, c, e){ + if(v){ + this.showAction(); + } + if(a && v){ + var cb = function(){ + this.sync(true); + if(c){ + c(); + } + }.createDelegate(this); + supr.setVisible.call(this, true, true, d, cb, e); + }else{ + if(!v){ + this.hideUnders(true); + } + var cb = c; + if(a){ + cb = function(){ + this.hideAction(); + if(c){ + c(); + } + }.createDelegate(this); + } + supr.setVisible.call(this, v, a, d, cb, e); + if(v){ + this.sync(true); + }else if(!a){ + this.hideAction(); + } + } + }, + + storeXY : function(xy){ + delete this.lastLT; + this.lastXY = xy; + }, + + storeLeftTop : function(left, top){ + delete this.lastXY; + this.lastLT = [left, top]; + }, + + // private + beforeFx : function(){ + this.beforeAction(); + return Roo.Layer.superclass.beforeFx.apply(this, arguments); + }, + + // private + afterFx : function(){ + Roo.Layer.superclass.afterFx.apply(this, arguments); + this.sync(this.isVisible()); + }, + + // private + beforeAction : function(){ + if(!this.updating && this.shadow){ + this.shadow.hide(); + } + }, + + // overridden Element method + setLeft : function(left){ + this.storeLeftTop(left, this.getTop(true)); + supr.setLeft.apply(this, arguments); + this.sync(); + }, + + setTop : function(top){ + this.storeLeftTop(this.getLeft(true), top); + supr.setTop.apply(this, arguments); + this.sync(); + }, + + setLeftTop : function(left, top){ + this.storeLeftTop(left, top); + supr.setLeftTop.apply(this, arguments); + this.sync(); + }, + + setXY : function(xy, a, d, c, e){ + this.fixDisplay(); + this.beforeAction(); + this.storeXY(xy); + var cb = this.createCB(c); + supr.setXY.call(this, xy, a, d, cb, e); + if(!a){ + cb(); + } + }, + + // private + createCB : function(c){ + var el = this; + return function(){ + el.constrainXY(); + el.sync(true); + if(c){ + c(); + } + }; + }, + + // overridden Element method + setX : function(x, a, d, c, e){ + this.setXY([x, this.getY()], a, d, c, e); + }, + + // overridden Element method + setY : function(y, a, d, c, e){ + this.setXY([this.getX(), y], a, d, c, e); + }, + + // overridden Element method + setSize : function(w, h, a, d, c, e){ + this.beforeAction(); + var cb = this.createCB(c); + supr.setSize.call(this, w, h, a, d, cb, e); + if(!a){ + cb(); + } + }, + + // overridden Element method + setWidth : function(w, a, d, c, e){ + this.beforeAction(); + var cb = this.createCB(c); + supr.setWidth.call(this, w, a, d, cb, e); + if(!a){ + cb(); + } + }, + + // overridden Element method + setHeight : function(h, a, d, c, e){ + this.beforeAction(); + var cb = this.createCB(c); + supr.setHeight.call(this, h, a, d, cb, e); + if(!a){ + cb(); + } + }, + + // overridden Element method + setBounds : function(x, y, w, h, a, d, c, e){ + this.beforeAction(); + var cb = this.createCB(c); + if(!a){ + this.storeXY([x, y]); + supr.setXY.call(this, [x, y]); + supr.setSize.call(this, w, h, a, d, cb, e); + cb(); + }else{ + supr.setBounds.call(this, x, y, w, h, a, d, cb, e); + } + return this; + }, + + /** + * Sets the z-index of this layer and adjusts any shadow and shim z-indexes. The layer z-index is automatically + * incremented by two more than the value passed in so that it always shows above any shadow or shim (the shadow + * element, if any, will be assigned z-index + 1, and the shim element, if any, will be assigned the unmodified z-index). + * @param {Number} zindex The new z-index to set + * @return {this} The Layer + */ + setZIndex : function(zindex){ + this.zindex = zindex; + this.setStyle("z-index", zindex + 2); + if(this.shadow){ + this.shadow.setZIndex(zindex + 1); + } + if(this.shim){ + this.shim.setStyle("z-index", zindex); + } + } +}); +})(); \ No newline at end of file diff --git a/docs2/src/Roo_LayoutManager.js.html b/docs2/src/Roo_LayoutManager.js.html new file mode 100644 index 0000000000..3ceb51aad1 --- /dev/null +++ b/docs2/src/Roo_LayoutManager.js.html @@ -0,0 +1,146 @@ +/home/alan/gitlive/roojs1/Roo/LayoutManager.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.LayoutManager + * @extends Roo.util.Observable + * Base class for layout managers. + */ +Roo.LayoutManager = function(container, config){ + Roo.LayoutManager.superclass.constructor.call(this); + this.el = Roo.get(container); + // ie scrollbar fix + if(this.el.dom == document.body && Roo.isIE && !config.allowScroll){ + document.body.scroll = "no"; + }else if(this.el.dom != document.body && this.el.getStyle('position') == 'static'){ + this.el.position('relative'); + } + this.id = this.el.id; + this.el.addClass("x-layout-container"); + /** false to disable window resize monitoring @type Boolean */ + this.monitorWindowResize = true; + this.regions = {}; + this.addEvents({ + /** + * @event layout + * Fires when a layout is performed. + * @param {Roo.LayoutManager} this + */ + "layout" : true, + /** + * @event regionresized + * Fires when the user resizes a region. + * @param {Roo.LayoutRegion} region The resized region + * @param {Number} newSize The new size (width for east/west, height for north/south) + */ + "regionresized" : true, + /** + * @event regioncollapsed + * Fires when a region is collapsed. + * @param {Roo.LayoutRegion} region The collapsed region + */ + "regioncollapsed" : true, + /** + * @event regionexpanded + * Fires when a region is expanded. + * @param {Roo.LayoutRegion} region The expanded region + */ + "regionexpanded" : true + }); + this.updating = false; + Roo.EventManager.onWindowResize(this.onWindowResize, this, true); +}; + +Roo.extend(Roo.LayoutManager, Roo.util.Observable, { + /** + * Returns true if this layout is currently being updated + * @return {Boolean} + */ + isUpdating : function(){ + return this.updating; + }, + + /** + * Suspend the LayoutManager from doing auto-layouts while + * making multiple add or remove calls + */ + beginUpdate : function(){ + this.updating = true; + }, + + /** + * Restore auto-layouts and optionally disable the manager from performing a layout + * @param {Boolean} noLayout true to disable a layout update + */ + endUpdate : function(noLayout){ + this.updating = false; + if(!noLayout){ + this.layout(); + } + }, + + layout: function(){ + + }, + + onRegionResized : function(region, newSize){ + this.fireEvent("regionresized", region, newSize); + this.layout(); + }, + + onRegionCollapsed : function(region){ + this.fireEvent("regioncollapsed", region); + }, + + onRegionExpanded : function(region){ + this.fireEvent("regionexpanded", region); + }, + + /** + * Returns the size of the current view. This method normalizes document.body and element embedded layouts and + * performs box-model adjustments. + * @return {Object} The size as an object {width: (the width), height: (the height)} + */ + getViewSize : function(){ + var size; + if(this.el.dom != document.body){ + size = this.el.getSize(); + }else{ + size = {width: Roo.lib.Dom.getViewWidth(), height: Roo.lib.Dom.getViewHeight()}; + } + size.width -= this.el.getBorderWidth("lr")-this.el.getPadding("lr"); + size.height -= this.el.getBorderWidth("tb")-this.el.getPadding("tb"); + return size; + }, + + /** + * Returns the Element this layout is bound to. + * @return {Roo.Element} + */ + getEl : function(){ + return this.el; + }, + + /** + * Returns the specified region. + * @param {String} target The region key ('center', 'north', 'south', 'east' or 'west') + * @return {Roo.LayoutRegion} + */ + getRegion : function(target){ + return this.regions[target.toLowerCase()]; + }, + + onWindowResize : function(){ + if(this.monitorWindowResize){ + this.layout(); + } + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_LayoutRegion.js.html b/docs2/src/Roo_LayoutRegion.js.html new file mode 100644 index 0000000000..e8d9bb9b59 --- /dev/null +++ b/docs2/src/Roo_LayoutRegion.js.html @@ -0,0 +1,621 @@ +/home/alan/gitlive/roojs1/Roo/LayoutRegion.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.LayoutRegion + * @extends Roo.BasicLayoutRegion + * This class represents a region in a layout manager. + * @cfg {Boolean} collapsible False to disable collapsing (defaults to true) + * @cfg {Boolean} collapsed True to set the initial display to collapsed (defaults to false) + * @cfg {Boolean} floatable False to disable floating (defaults to true) + * @cfg {Object} margins Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0}) + * @cfg {Object} cmargins Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0}) + * @cfg {String} tabPosition (top|bottom) "top" or "bottom" (defaults to "bottom") + * @cfg {String} collapsedTitle Optional string message to display in the collapsed block of a north or south region + * @cfg {Boolean} alwaysShowTabs True to always display tabs even when there is only 1 panel (defaults to false) + * @cfg {Boolean} autoScroll True to enable overflow scrolling (defaults to false) + * @cfg {Boolean} titlebar True to display a title bar (defaults to true) + * @cfg {String} title The title for the region (overrides panel titles) + * @cfg {Boolean} animate True to animate expand/collapse (defaults to false) + * @cfg {Boolean} autoHide False to disable auto hiding when the mouse leaves the "floated" region (defaults to true) + * @cfg {Boolean} preservePanels True to preserve removed panels so they can be readded later (defaults to false) + * @cfg {Boolean} closeOnTab True to place the close icon on the tabs instead of the region titlebar (defaults to false) + * @cfg {Boolean} hideTabs True to hide the tab strip (defaults to false) + * @cfg {Boolean} resizeTabs True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within + * the space available, similar to FireFox 1.5 tabs (defaults to false) + * @cfg {Number} minTabWidth The minimum tab width (defaults to 40) + * @cfg {Number} preferredTabWidth The preferred tab width (defaults to 150) + * @cfg {Boolean} showPin True to show a pin button + * @cfg {Boolean} hidden True to start the region hidden (defaults to false) + * @cfg {Boolean} hideWhenEmpty True to hide the region when it has no panels + * @cfg {Boolean} disableTabTips True to disable tab tooltips + * @cfg {Number} width For East/West panels + * @cfg {Number} height For North/South panels + * @cfg {Boolean} split To show the splitter + * @cfg {Boolean} toolbar xtype configuration for a toolbar - shows on right of tabbar + */ +Roo.LayoutRegion = function(mgr, config, pos){ + Roo.LayoutRegion.superclass.constructor.call(this, mgr, config, pos, true); + var dh = Roo.DomHelper; + /** This region's container element + * @type Roo.Element */ + this.el = dh.append(mgr.el.dom, {tag: "div", cls: "x-layout-panel x-layout-panel-" + this.position}, true); + /** This region's title element + * @type Roo.Element */ + + this.titleEl = dh.append(this.el.dom, {tag: "div", unselectable: "on", cls: "x-unselectable x-layout-panel-hd x-layout-title-"+this.position, children:[ + {tag: "span", cls: "x-unselectable x-layout-panel-hd-text", unselectable: "on", html: "&#160;"}, + {tag: "div", cls: "x-unselectable x-layout-panel-hd-tools", unselectable: "on"} + ]}, true); + this.titleEl.enableDisplayMode(); + /** This region's title text element + * @type HTMLElement */ + this.titleTextEl = this.titleEl.dom.firstChild; + this.tools = Roo.get(this.titleEl.dom.childNodes[1], true); + this.closeBtn = this.createTool(this.tools.dom, "x-layout-close"); + this.closeBtn.enableDisplayMode(); + this.closeBtn.on("click", this.closeClicked, this); + this.closeBtn.hide(); + + this.createBody(config); + this.visible = true; + this.collapsed = false; + + if(config.hideWhenEmpty){ + this.hide(); + this.on("paneladded", this.validateVisibility, this); + this.on("panelremoved", this.validateVisibility, this); + } + this.applyConfig(config); +}; + +Roo.extend(Roo.LayoutRegion, Roo.BasicLayoutRegion, { + + createBody : function(){ + /** This region's body element + * @type Roo.Element */ + this.bodyEl = this.el.createChild({tag: "div", cls: "x-layout-panel-body"}); + }, + + applyConfig : function(c){ + if(c.collapsible && this.position != "center" && !this.collapsedEl){ + var dh = Roo.DomHelper; + if(c.titlebar !== false){ + this.collapseBtn = this.createTool(this.tools.dom, "x-layout-collapse-"+this.position); + this.collapseBtn.on("click", this.collapse, this); + this.collapseBtn.enableDisplayMode(); + + if(c.showPin === true || this.showPin){ + this.stickBtn = this.createTool(this.tools.dom, "x-layout-stick"); + this.stickBtn.enableDisplayMode(); + this.stickBtn.on("click", this.expand, this); + this.stickBtn.hide(); + } + } + /** This region's collapsed element + * @type Roo.Element */ + this.collapsedEl = dh.append(this.mgr.el.dom, {cls: "x-layout-collapsed x-layout-collapsed-"+this.position, children:[ + {cls: "x-layout-collapsed-tools", children:[{cls: "x-layout-ctools-inner"}]} + ]}, true); + if(c.floatable !== false){ + this.collapsedEl.addClassOnOver("x-layout-collapsed-over"); + this.collapsedEl.on("click", this.collapseClick, this); + } + + if(c.collapsedTitle && (this.position == "north" || this.position== "south")) { + this.collapsedTitleTextEl = dh.append(this.collapsedEl.dom, {tag: "div", cls: "x-unselectable x-layout-panel-hd-text", + id: "message", unselectable: "on", style:{"float":"left"}}); + this.collapsedTitleTextEl.innerHTML = c.collapsedTitle; + } + this.expandBtn = this.createTool(this.collapsedEl.dom.firstChild.firstChild, "x-layout-expand-"+this.position); + this.expandBtn.on("click", this.expand, this); + } + if(this.collapseBtn){ + this.collapseBtn.setVisible(c.collapsible == true); + } + this.cmargins = c.cmargins || this.cmargins || + (this.position == "west" || this.position == "east" ? + {top: 0, left: 2, right:2, bottom: 0} : + {top: 2, left: 0, right:0, bottom: 2}); + this.margins = c.margins || this.margins || {top: 0, left: 0, right:0, bottom: 0}; + this.bottomTabs = c.tabPosition != "top"; + this.autoScroll = c.autoScroll || false; + if(this.autoScroll){ + this.bodyEl.setStyle("overflow", "auto"); + }else{ + this.bodyEl.setStyle("overflow", "hidden"); + } + //if(c.titlebar !== false){ + if((!c.titlebar && !c.title) || c.titlebar === false){ + this.titleEl.hide(); + }else{ + this.titleEl.show(); + if(c.title){ + this.titleTextEl.innerHTML = c.title; + } + } + //} + this.duration = c.duration || .30; + this.slideDuration = c.slideDuration || .45; + this.config = c; + if(c.collapsed){ + this.collapse(true); + } + if(c.hidden){ + this.hide(); + } + }, + /** + * Returns true if this region is currently visible. + * @return {Boolean} + */ + isVisible : function(){ + return this.visible; + }, + + /** + * Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option) + * @param {String} title (optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, "&amp;#160;") + */ + setCollapsedTitle : function(title){ + title = title || "&#160;"; + if(this.collapsedTitleTextEl){ + this.collapsedTitleTextEl.innerHTML = title; + } + }, + + getBox : function(){ + var b; + if(!this.collapsed){ + b = this.el.getBox(false, true); + }else{ + b = this.collapsedEl.getBox(false, true); + } + return b; + }, + + getMargins : function(){ + return this.collapsed ? this.cmargins : this.margins; + }, + + highlight : function(){ + this.el.addClass("x-layout-panel-dragover"); + }, + + unhighlight : function(){ + this.el.removeClass("x-layout-panel-dragover"); + }, + + updateBox : function(box){ + this.box = box; + if(!this.collapsed){ + this.el.dom.style.left = box.x + "px"; + this.el.dom.style.top = box.y + "px"; + this.updateBody(box.width, box.height); + }else{ + this.collapsedEl.dom.style.left = box.x + "px"; + this.collapsedEl.dom.style.top = box.y + "px"; + this.collapsedEl.setSize(box.width, box.height); + } + if(this.tabs){ + this.tabs.autoSizeTabs(); + } + }, + + updateBody : function(w, h){ + if(w !== null){ + this.el.setWidth(w); + w -= this.el.getBorderWidth("rl"); + if(this.config.adjustments){ + w += this.config.adjustments[0]; + } + } + if(h !== null){ + this.el.setHeight(h); + h = this.titleEl && this.titleEl.isDisplayed() ? h - (this.titleEl.getHeight()||0) : h; + h -= this.el.getBorderWidth("tb"); + if(this.config.adjustments){ + h += this.config.adjustments[1]; + } + this.bodyEl.setHeight(h); + if(this.tabs){ + h = this.tabs.syncHeight(h); + } + } + if(this.panelSize){ + w = w !== null ? w : this.panelSize.width; + h = h !== null ? h : this.panelSize.height; + } + if(this.activePanel){ + var el = this.activePanel.getEl(); + w = w !== null ? w : el.getWidth(); + h = h !== null ? h : el.getHeight(); + this.panelSize = {width: w, height: h}; + this.activePanel.setSize(w, h); + } + if(Roo.isIE && this.tabs){ + this.tabs.el.repaint(); + } + }, + + /** + * Returns the container element for this region. + * @return {Roo.Element} + */ + getEl : function(){ + return this.el; + }, + + /** + * Hides this region. + */ + hide : function(){ + if(!this.collapsed){ + this.el.dom.style.left = "-2000px"; + this.el.hide(); + }else{ + this.collapsedEl.dom.style.left = "-2000px"; + this.collapsedEl.hide(); + } + this.visible = false; + this.fireEvent("visibilitychange", this, false); + }, + + /** + * Shows this region if it was previously hidden. + */ + show : function(){ + if(!this.collapsed){ + this.el.show(); + }else{ + this.collapsedEl.show(); + } + this.visible = true; + this.fireEvent("visibilitychange", this, true); + }, + + closeClicked : function(){ + if(this.activePanel){ + this.remove(this.activePanel); + } + }, + + collapseClick : function(e){ + if(this.isSlid){ + e.stopPropagation(); + this.slideIn(); + }else{ + e.stopPropagation(); + this.slideOut(); + } + }, + + /** + * Collapses this region. + * @param {Boolean} skipAnim (optional) true to collapse the element without animation (if animate is true) + */ + collapse : function(skipAnim, skipCheck = false){ + if(this.collapsed) { + return; + } + + if(skipCheck || this.fireEvent("beforecollapse", this) != false){ + + this.collapsed = true; + if(this.split){ + this.split.el.hide(); + } + if(this.config.animate && skipAnim !== true){ + this.fireEvent("invalidated", this); + this.animateCollapse(); + }else{ + this.el.setLocation(-20000,-20000); + this.el.hide(); + this.collapsedEl.show(); + this.fireEvent("collapsed", this); + this.fireEvent("invalidated", this); + } + } + + }, + + animateCollapse : function(){ + // overridden + }, + + /** + * Expands this region if it was previously collapsed. + * @param {Roo.EventObject} e The event that triggered the expand (or null if calling manually) + * @param {Boolean} skipAnim (optional) true to expand the element without animation (if animate is true) + */ + expand : function(e, skipAnim){ + if(e) { + e.stopPropagation(); + } + if(!this.collapsed || this.el.hasActiveFx()) { + return; + } + if(this.isSlid){ + this.afterSlideIn(); + skipAnim = true; + } + this.collapsed = false; + if(this.config.animate && skipAnim !== true){ + this.animateExpand(); + }else{ + this.el.show(); + if(this.split){ + this.split.el.show(); + } + this.collapsedEl.setLocation(-2000,-2000); + this.collapsedEl.hide(); + this.fireEvent("invalidated", this); + this.fireEvent("expanded", this); + } + }, + + animateExpand : function(){ + // overridden + }, + + initTabs : function() + { + this.bodyEl.setStyle("overflow", "hidden"); + var ts = new Roo.TabPanel( + this.bodyEl.dom, + { + tabPosition: this.bottomTabs ? 'bottom' : 'top', + disableTooltips: this.config.disableTabTips, + toolbar : this.config.toolbar + } + ); + if(this.config.hideTabs){ + ts.stripWrap.setDisplayed(false); + } + this.tabs = ts; + ts.resizeTabs = this.config.resizeTabs === true; + ts.minTabWidth = this.config.minTabWidth || 40; + ts.maxTabWidth = this.config.maxTabWidth || 250; + ts.preferredTabWidth = this.config.preferredTabWidth || 150; + ts.monitorResize = false; + ts.bodyEl.setStyle("overflow", this.config.autoScroll ? "auto" : "hidden"); + ts.bodyEl.addClass('x-layout-tabs-body'); + this.panels.each(this.initPanelAsTab, this); + }, + + initPanelAsTab : function(panel){ + var ti = this.tabs.addTab(panel.getEl().id, panel.getTitle(), null, + this.config.closeOnTab && panel.isClosable()); + if(panel.tabTip !== undefined){ + ti.setTooltip(panel.tabTip); + } + ti.on("activate", function(){ + this.setActivePanel(panel); + }, this); + if(this.config.closeOnTab){ + ti.on("beforeclose", function(t, e){ + e.cancel = true; + this.remove(panel); + }, this); + } + return ti; + }, + + updatePanelTitle : function(panel, title){ + if(this.activePanel == panel){ + this.updateTitle(title); + } + if(this.tabs){ + var ti = this.tabs.getTab(panel.getEl().id); + ti.setText(title); + if(panel.tabTip !== undefined){ + ti.setTooltip(panel.tabTip); + } + } + }, + + updateTitle : function(title){ + if(this.titleTextEl && !this.config.title){ + this.titleTextEl.innerHTML = (typeof title != "undefined" && title.length > 0 ? title : "&#160;"); + } + }, + + setActivePanel : function(panel){ + panel = this.getPanel(panel); + if(this.activePanel && this.activePanel != panel){ + this.activePanel.setActiveState(false); + } + this.activePanel = panel; + panel.setActiveState(true); + if(this.panelSize){ + panel.setSize(this.panelSize.width, this.panelSize.height); + } + if(this.closeBtn){ + this.closeBtn.setVisible(!this.config.closeOnTab && !this.isSlid && panel.isClosable()); + } + this.updateTitle(panel.getTitle()); + if(this.tabs){ + this.fireEvent("invalidated", this); + } + this.fireEvent("panelactivated", this, panel); + }, + + /** + * Shows the specified panel. + * @param {Number/String/ContentPanel} panelId The panel's index, id or the panel itself + * @return {Roo.ContentPanel} The shown panel, or null if a panel could not be found from panelId + */ + showPanel : function(panel) + { + panel = this.getPanel(panel); + if(panel){ + if(this.tabs){ + var tab = this.tabs.getTab(panel.getEl().id); + if(tab.isHidden()){ + this.tabs.unhideTab(tab.id); + } + tab.activate(); + }else{ + this.setActivePanel(panel); + } + } + return panel; + }, + + /** + * Get the active panel for this region. + * @return {Roo.ContentPanel} The active panel or null + */ + getActivePanel : function(){ + return this.activePanel; + }, + + validateVisibility : function(){ + if(this.panels.getCount() < 1){ + this.updateTitle("&#160;"); + this.closeBtn.hide(); + this.hide(); + }else{ + if(!this.isVisible()){ + this.show(); + } + } + }, + + /** + * Adds the passed ContentPanel(s) to this region. + * @param {ContentPanel...} panel The ContentPanel(s) to add (you can pass more than one) + * @return {Roo.ContentPanel} The panel added (if only one was added; null otherwise) + */ + add : function(panel){ + if(arguments.length > 1){ + for(var i = 0, len = arguments.length; i < len; i++) { + this.add(arguments[i]); + } + return null; + } + if(this.hasPanel(panel)){ + this.showPanel(panel); + return panel; + } + panel.setRegion(this); + this.panels.add(panel); + if(this.panels.getCount() == 1 && !this.config.alwaysShowTabs){ + this.bodyEl.dom.appendChild(panel.getEl().dom); + if(panel.background !== true){ + this.setActivePanel(panel); + } + this.fireEvent("paneladded", this, panel); + return panel; + } + if(!this.tabs){ + this.initTabs(); + }else{ + this.initPanelAsTab(panel); + } + if(panel.background !== true){ + this.tabs.activate(panel.getEl().id); + } + this.fireEvent("paneladded", this, panel); + return panel; + }, + + /** + * Hides the tab for the specified panel. + * @param {Number/String/ContentPanel} panel The panel's index, id or the panel itself + */ + hidePanel : function(panel){ + if(this.tabs && (panel = this.getPanel(panel))){ + this.tabs.hideTab(panel.getEl().id); + } + }, + + /** + * Unhides the tab for a previously hidden panel. + * @param {Number/String/ContentPanel} panel The panel's index, id or the panel itself + */ + unhidePanel : function(panel){ + if(this.tabs && (panel = this.getPanel(panel))){ + this.tabs.unhideTab(panel.getEl().id); + } + }, + + clearPanels : function(){ + while(this.panels.getCount() > 0){ + this.remove(this.panels.first()); + } + }, + + /** + * Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed. + * @param {Number/String/ContentPanel} panel The panel's index, id or the panel itself + * @param {Boolean} preservePanel Overrides the config preservePanel option + * @return {Roo.ContentPanel} The panel that was removed + */ + remove : function(panel, preservePanel){ + panel = this.getPanel(panel); + if(!panel){ + return null; + } + var e = {}; + this.fireEvent("beforeremove", this, panel, e); + if(e.cancel === true){ + return null; + } + preservePanel = (typeof preservePanel != "undefined" ? preservePanel : (this.config.preservePanels === true || panel.preserve === true)); + var panelId = panel.getId(); + this.panels.removeKey(panelId); + if(preservePanel){ + document.body.appendChild(panel.getEl().dom); + } + if(this.tabs){ + this.tabs.removeTab(panel.getEl().id); + }else if (!preservePanel){ + this.bodyEl.dom.removeChild(panel.getEl().dom); + } + if(this.panels.getCount() == 1 && this.tabs && !this.config.alwaysShowTabs){ + var p = this.panels.first(); + var tempEl = document.createElement("div"); // temp holder to keep IE from deleting the node + tempEl.appendChild(p.getEl().dom); + this.bodyEl.update(""); + this.bodyEl.dom.appendChild(p.getEl().dom); + tempEl = null; + this.updateTitle(p.getTitle()); + this.tabs = null; + this.bodyEl.setStyle("overflow", this.config.autoScroll ? "auto" : "hidden"); + this.setActivePanel(p); + } + panel.setRegion(null); + if(this.activePanel == panel){ + this.activePanel = null; + } + if(this.config.autoDestroy !== false && preservePanel !== true){ + try{panel.destroy();}catch(e){} + } + this.fireEvent("panelremoved", this, panel); + return panel; + }, + + /** + * Returns the TabPanel component used by this region + * @return {Roo.TabPanel} + */ + getTabs : function(){ + return this.tabs; + }, + + createTool : function(parentEl, className){ + var btn = Roo.DomHelper.append(parentEl, {tag: "div", cls: "x-layout-tools-button", + children: [{tag: "div", cls: "x-layout-tools-button-inner " + className, html: "&#160;"}]}, true); + btn.addClassOnOver("x-layout-tools-button-over"); + return btn; + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_LayoutStateManager.js.html b/docs2/src/Roo_LayoutStateManager.js.html new file mode 100644 index 0000000000..c5566876bc --- /dev/null +++ b/docs2/src/Roo_LayoutStateManager.js.html @@ -0,0 +1,80 @@ +/home/alan/gitlive/roojs1/Roo/LayoutStateManager.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/* + * Private internal class for reading and applying state + */ +Roo.LayoutStateManager = function(layout){ + // default empty state + this.state = { + north: {}, + south: {}, + east: {}, + west: {} + }; +}; + +Roo.LayoutStateManager.prototype = { + init : function(layout, provider){ + this.provider = provider; + var state = provider.get(layout.id+"-layout-state"); + if(state){ + var wasUpdating = layout.isUpdating(); + if(!wasUpdating){ + layout.beginUpdate(); + } + for(var key in state){ + if(typeof state[key] != "function"){ + var rstate = state[key]; + var r = layout.getRegion(key); + if(r && rstate){ + if(rstate.size){ + r.resizeTo(rstate.size); + } + if(rstate.collapsed == true){ + r.collapse(true); + }else{ + r.expand(null, true); + } + } + } + } + if(!wasUpdating){ + layout.endUpdate(); + } + this.state = state; + } + this.layout = layout; + layout.on("regionresized", this.onRegionResized, this); + layout.on("regioncollapsed", this.onRegionCollapsed, this); + layout.on("regionexpanded", this.onRegionExpanded, this); + }, + + storeState : function(){ + this.provider.set(this.layout.id+"-layout-state", this.state); + }, + + onRegionResized : function(region, newSize){ + this.state[region.getPosition()].size = newSize; + this.storeState(); + }, + + onRegionCollapsed : function(region){ + this.state[region.getPosition()].collapsed = true; + this.storeState(); + }, + + onRegionExpanded : function(region){ + this.state[region.getPosition()].collapsed = false; + this.storeState(); + } +}; \ No newline at end of file diff --git a/docs2/src/Roo_LoadMask.js.html b/docs2/src/Roo_LoadMask.js.html new file mode 100644 index 0000000000..bec417670b --- /dev/null +++ b/docs2/src/Roo_LoadMask.js.html @@ -0,0 +1,123 @@ +/home/alan/gitlive/roojs1/Roo/LoadMask.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.LoadMask + * A simple utility class for generically masking elements while loading data. If the element being masked has + * an underlying {@link Roo.data.Store}, the masking will be automatically synchronized with the store's loading + * process and the mask element will be cached for reuse. For all other elements, this mask will replace the + * element's UpdateManager load indicator and will be destroyed after the initial load. + * @constructor + * Create a new LoadMask + * @param {String/HTMLElement/Roo.Element} el The element or DOM node, or its id + * @param {Object} config The config object + */ +Roo.LoadMask = function(el, config){ + this.el = Roo.get(el); + Roo.apply(this, config); + if(this.store){ + this.store.on('beforeload', this.onBeforeLoad, this); + this.store.on('load', this.onLoad, this); + this.store.on('loadexception', this.onLoadException, this); + this.removeMask = false; + }else{ + var um = this.el.getUpdateManager(); + um.showLoadIndicator = false; // disable the default indicator + um.on('beforeupdate', this.onBeforeLoad, this); + um.on('update', this.onLoad, this); + um.on('failure', this.onLoad, this); + this.removeMask = true; + } +}; + +Roo.LoadMask.prototype = { + /** + * @cfg {Boolean} removeMask + * True to create a single-use mask that is automatically destroyed after loading (useful for page loads), + * False to persist the mask element reference for multiple uses (e.g., for paged data widgets). Defaults to false. + */ + /** + * @cfg {String} msg + * The text to display in a centered loading message box (defaults to 'Loading...') + */ + msg : 'Loading...', + /** + * @cfg {String} msgCls + * The CSS class to apply to the loading message element (defaults to "x-mask-loading") + */ + msgCls : 'x-mask-loading', + + /** + * Read-only. True if the mask is currently disabled so that it will not be displayed (defaults to false) + * @type Boolean + */ + disabled: false, + + /** + * Disables the mask to prevent it from being displayed + */ + disable : function(){ + this.disabled = true; + }, + + /** + * Enables the mask so that it can be displayed + */ + enable : function(){ + this.disabled = false; + }, + + onLoadException : function() + { + Roo.log(arguments); + + if (typeof(arguments[3]) != 'undefined') { + Roo.MessageBox.alert("Error loading",arguments[3]); + } + /* + try { + if (this.store && typeof(this.store.reader.jsonData.errorMsg) != 'undefined') { + Roo.MessageBox.alert("Error loading",this.store.reader.jsonData.errorMsg); + } + } catch(e) { + + } + */ + + (function() { this.el.unmask(this.removeMask); }).defer(50, this); + }, + // private + onLoad : function() + { + (function() { this.el.unmask(this.removeMask); }).defer(50, this); + }, + + // private + onBeforeLoad : function(){ + if(!this.disabled){ + (function() { this.el.mask(this.msg, this.msgCls); }).defer(50, this); + } + }, + + // private + destroy : function(){ + if(this.store){ + this.store.un('beforeload', this.onBeforeLoad, this); + this.store.un('load', this.onLoad, this); + this.store.un('loadexception', this.onLoadException, this); + }else{ + var um = this.el.getUpdateManager(); + um.un('beforeupdate', this.onBeforeLoad, this); + um.un('update', this.onLoad, this); + um.un('failure', this.onLoad, this); + } + } +}; \ No newline at end of file diff --git a/docs2/src/Roo_Markdown.js.html b/docs2/src/Roo_Markdown.js.html new file mode 100644 index 0000000000..9749ba2095 --- /dev/null +++ b/docs2/src/Roo_Markdown.js.html @@ -0,0 +1,1320 @@ +/home/alan/gitlive/roojs1/Roo/Markdown.js// + /** + * marked - a markdown parser + * Copyright (c) 2011-2014, Christopher Jeffrey. (MIT Licensed) + * https://github.com/chjj/marked + */ + + +/** + * + * Roo.Markdown - is a very crude wrapper around marked.. + * + * usage: + * + * alert( Roo.Markdown.toHtml("Markdown *rocks*.") ); + * + * Note: move the sample code to the bottom of this + * file before uncommenting it. + * + */ + +Roo.Markdown = {}; +Roo.Markdown.toHtml = function(text) { + + var c = new Roo.Markdown.marked.setOptions({ + renderer: new Roo.Markdown.marked.Renderer(), + gfm: true, + tables: true, + breaks: false, + pedantic: false, + sanitize: false, + smartLists: true, + smartypants: false + }); + // A FEW HACKS!!? + + text = text.replace(/\\\n/g,' '); + return Roo.Markdown.marked(text); +}; +// +// converter +// +// Wraps all "globals" so that the only thing +// exposed is makeHtml(). +// +(function() { + + /** + * Block-Level Grammar + */ + + var block = { + newline: /^\n+/, + code: /^( {4}[^\n]+\n*)+/, + fences: noop, + hr: /^( *[-*_]){3,} *(?:\n+|$)/, + heading: /^ *(#{1,6}) *([^\n]+?) *#* *(?:\n+|$)/, + nptable: noop, + lheading: /^([^\n]+)\n *(=|-){2,} *(?:\n+|$)/, + blockquote: /^( *>[^\n]+(\n(?!def)[^\n]+)*\n*)+/, + list: /^( *)(bull) [\s\S]+?(?:hr|def|\n{2,}(?! )(?!\1bull )\n*|\s*$)/, + html: /^ *(?:comment *(?:\n|\s*$)|closed *(?:\n{2,}|\s*$)|closing *(?:\n{2,}|\s*$))/, + def: /^ *\[([^\]]+)\]: *<?([^\s>]+)>?(?: +["(]([^\n]+)[")])? *(?:\n+|$)/, + table: noop, + paragraph: /^((?:[^\n]+\n?(?!hr|heading|lheading|blockquote|tag|def))+)\n*/, + text: /^[^\n]+/ + }; + + block.bullet = /(?:[*+-]|\d+\.)/; + block.item = /^( *)(bull) [^\n]*(?:\n(?!\1bull )[^\n]*)*/; + block.item = replace(block.item, 'gm') + (/bull/g, block.bullet) + (); + + block.list = replace(block.list) + (/bull/g, block.bullet) + ('hr', '\\n+(?=\\1?(?:[-*_] *){3,}(?:\\n+|$))') + ('def', '\\n+(?=' + block.def.source + ')') + (); + + block.blockquote = replace(block.blockquote) + ('def', block.def) + (); + + block._tag = '(?!(?:' + + 'a|em|strong|small|s|cite|q|dfn|abbr|data|time|code' + + '|var|samp|kbd|sub|sup|i|b|u|mark|ruby|rt|rp|bdi|bdo' + + '|span|br|wbr|ins|del|img)\\b)\\w+(?!:/|[^\\w\\s@]*@)\\b'; + + block.html = replace(block.html) + ('comment', /<!--[\s\S]*?-->/) + ('closed', /<(tag)[\s\S]+?<\/\1>/) + ('closing', /<tag(?:"[^"]*"|'[^']*'|[^'">])*?>/) + (/tag/g, block._tag) + (); + + block.paragraph = replace(block.paragraph) + ('hr', block.hr) + ('heading', block.heading) + ('lheading', block.lheading) + ('blockquote', block.blockquote) + ('tag', '<' + block._tag) + ('def', block.def) + (); + + /** + * Normal Block Grammar + */ + + block.normal = merge({}, block); + + /** + * GFM Block Grammar + */ + + block.gfm = merge({}, block.normal, { + fences: /^ *(`{3,}|~{3,})[ \.]*(\S+)? *\n([\s\S]*?)\s*\1 *(?:\n+|$)/, + paragraph: /^/, + heading: /^ *(#{1,6}) +([^\n]+?) *#* *(?:\n+|$)/ + }); + + block.gfm.paragraph = replace(block.paragraph) + ('(?!', '(?!' + + block.gfm.fences.source.replace('\\1', '\\2') + '|' + + block.list.source.replace('\\1', '\\3') + '|') + (); + + /** + * GFM + Tables Block Grammar + */ + + block.tables = merge({}, block.gfm, { + nptable: /^ *(\S.*\|.*)\n *([-:]+ *\|[-| :]*)\n((?:.*\|.*(?:\n|$))*)\n*/, + table: /^ *\|(.+)\n *\|( *[-:]+[-| :]*)\n((?: *\|.*(?:\n|$))*)\n*/ + }); + + /** + * Block Lexer + */ + + var Lexer = function (options) { + this.tokens = []; + this.tokens.links = {}; + this.options = options || marked.defaults; + this.rules = block.normal; + + if (this.options.gfm) { + if (this.options.tables) { + this.rules = block.tables; + } else { + this.rules = block.gfm; + } + } + } + + /** + * Expose Block Rules + */ + + Lexer.rules = block; + + /** + * Static Lex Method + */ + + Lexer.lex = function(src, options) { + var lexer = new Lexer(options); + return lexer.lex(src); + }; + + /** + * Preprocessing + */ + + Lexer.prototype.lex = function(src) { + src = src + .replace(/\r\n|\r/g, '\n') + .replace(/\t/g, ' ') + .replace(/\u00a0/g, ' ') + .replace(/\u2424/g, '\n'); + + return this.token(src, true); + }; + + /** + * Lexing + */ + + Lexer.prototype.token = function(src, top, bq) { + var src = src.replace(/^ +$/gm, '') + , next + , loose + , cap + , bull + , b + , item + , space + , i + , l; + + while (src) { + // newline + if (cap = this.rules.newline.exec(src)) { + src = src.substring(cap[0].length); + if (cap[0].length > 1) { + this.tokens.push({ + type: 'space' + }); + } + } + + // code + if (cap = this.rules.code.exec(src)) { + src = src.substring(cap[0].length); + cap = cap[0].replace(/^ {4}/gm, ''); + this.tokens.push({ + type: 'code', + text: !this.options.pedantic + ? cap.replace(/\n+$/, '') + : cap + }); + continue; + } + + // fences (gfm) + if (cap = this.rules.fences.exec(src)) { + src = src.substring(cap[0].length); + this.tokens.push({ + type: 'code', + lang: cap[2], + text: cap[3] || '' + }); + continue; + } + + // heading + if (cap = this.rules.heading.exec(src)) { + src = src.substring(cap[0].length); + this.tokens.push({ + type: 'heading', + depth: cap[1].length, + text: cap[2] + }); + continue; + } + + // table no leading pipe (gfm) + if (top && (cap = this.rules.nptable.exec(src))) { + src = src.substring(cap[0].length); + + item = { + type: 'table', + header: cap[1].replace(/^ *| *\| *$/g, '').split(/ *\| */), + align: cap[2].replace(/^ *|\| *$/g, '').split(/ *\| */), + cells: cap[3].replace(/\n$/, '').split('\n') + }; + + for (i = 0; i < item.align.length; i++) { + if (/^ *-+: *$/.test(item.align[i])) { + item.align[i] = 'right'; + } else if (/^ *:-+: *$/.test(item.align[i])) { + item.align[i] = 'center'; + } else if (/^ *:-+ *$/.test(item.align[i])) { + item.align[i] = 'left'; + } else { + item.align[i] = null; + } + } + + for (i = 0; i < item.cells.length; i++) { + item.cells[i] = item.cells[i].split(/ *\| */); + } + + this.tokens.push(item); + + continue; + } + + // lheading + if (cap = this.rules.lheading.exec(src)) { + src = src.substring(cap[0].length); + this.tokens.push({ + type: 'heading', + depth: cap[2] === '=' ? 1 : 2, + text: cap[1] + }); + continue; + } + + // hr + if (cap = this.rules.hr.exec(src)) { + src = src.substring(cap[0].length); + this.tokens.push({ + type: 'hr' + }); + continue; + } + + // blockquote + if (cap = this.rules.blockquote.exec(src)) { + src = src.substring(cap[0].length); + + this.tokens.push({ + type: 'blockquote_start' + }); + + cap = cap[0].replace(/^ *> ?/gm, ''); + + // Pass `top` to keep the current + // "toplevel" state. This is exactly + // how markdown.pl works. + this.token(cap, top, true); + + this.tokens.push({ + type: 'blockquote_end' + }); + + continue; + } + + // list + if (cap = this.rules.list.exec(src)) { + src = src.substring(cap[0].length); + bull = cap[2]; + + this.tokens.push({ + type: 'list_start', + ordered: bull.length > 1 + }); + + // Get each top-level item. + cap = cap[0].match(this.rules.item); + + next = false; + l = cap.length; + i = 0; + + for (; i < l; i++) { + item = cap[i]; + + // Remove the list item's bullet + // so it is seen as the next token. + space = item.length; + item = item.replace(/^ *([*+-]|\d+\.) +/, ''); + + // Outdent whatever the + // list item contains. Hacky. + if (~item.indexOf('\n ')) { + space -= item.length; + item = !this.options.pedantic + ? item.replace(new RegExp('^ {1,' + space + '}', 'gm'), '') + : item.replace(/^ {1,4}/gm, ''); + } + + // Determine whether the next list item belongs here. + // Backpedal if it does not belong in this list. + if (this.options.smartLists && i !== l - 1) { + b = block.bullet.exec(cap[i + 1])[0]; + if (bull !== b && !(bull.length > 1 && b.length > 1)) { + src = cap.slice(i + 1).join('\n') + src; + i = l - 1; + } + } + + // Determine whether item is loose or not. + // Use: /(^|\n)(?! )[^\n]+\n\n(?!\s*$)/ + // for discount behavior. + loose = next || /\n\n(?!\s*$)/.test(item); + if (i !== l - 1) { + next = item.charAt(item.length - 1) === '\n'; + if (!loose) { loose = next; } + } + + this.tokens.push({ + type: loose + ? 'loose_item_start' + : 'list_item_start' + }); + + // Recurse. + this.token(item, false, bq); + + this.tokens.push({ + type: 'list_item_end' + }); + } + + this.tokens.push({ + type: 'list_end' + }); + + continue; + } + + // html + if (cap = this.rules.html.exec(src)) { + src = src.substring(cap[0].length); + this.tokens.push({ + type: this.options.sanitize + ? 'paragraph' + : 'html', + pre: !this.options.sanitizer + && (cap[1] === 'pre' || cap[1] === 'script' || cap[1] === 'style'), + text: cap[0] + }); + continue; + } + + // def + if ((!bq && top) && (cap = this.rules.def.exec(src))) { + src = src.substring(cap[0].length); + this.tokens.links[cap[1].toLowerCase()] = { + href: cap[2], + title: cap[3] + }; + continue; + } + + // table (gfm) + if (top && (cap = this.rules.table.exec(src))) { + src = src.substring(cap[0].length); + + item = { + type: 'table', + header: cap[1].replace(/^ *| *\| *$/g, '').split(/ *\| */), + align: cap[2].replace(/^ *|\| *$/g, '').split(/ *\| */), + cells: cap[3].replace(/(?: *\| *)?\n$/, '').split('\n') + }; + + for (i = 0; i < item.align.length; i++) { + if (/^ *-+: *$/.test(item.align[i])) { + item.align[i] = 'right'; + } else if (/^ *:-+: *$/.test(item.align[i])) { + item.align[i] = 'center'; + } else if (/^ *:-+ *$/.test(item.align[i])) { + item.align[i] = 'left'; + } else { + item.align[i] = null; + } + } + + for (i = 0; i < item.cells.length; i++) { + item.cells[i] = item.cells[i] + .replace(/^ *\| *| *\| *$/g, '') + .split(/ *\| */); + } + + this.tokens.push(item); + + continue; + } + + // top-level paragraph + if (top && (cap = this.rules.paragraph.exec(src))) { + src = src.substring(cap[0].length); + this.tokens.push({ + type: 'paragraph', + text: cap[1].charAt(cap[1].length - 1) === '\n' + ? cap[1].slice(0, -1) + : cap[1] + }); + continue; + } + + // text + if (cap = this.rules.text.exec(src)) { + // Top-level should never reach here. + src = src.substring(cap[0].length); + this.tokens.push({ + type: 'text', + text: cap[0] + }); + continue; + } + + if (src) { + throw new + Error('Infinite loop on byte: ' + src.charCodeAt(0)); + } + } + + return this.tokens; + }; + + /** + * Inline-Level Grammar + */ + + var inline = { + escape: /^\\([\\`*{}\[\]()#+\-.!_>])/, + autolink: /^<([^ >]+(@|:\/)[^ >]+)>/, + url: noop, + tag: /^<!--[\s\S]*?-->|^<\/?\w+(?:"[^"]*"|'[^']*'|[^'">])*?>/, + link: /^!?\[(inside)\]\(href\)/, + reflink: /^!?\[(inside)\]\s*\[([^\]]*)\]/, + nolink: /^!?\[((?:\[[^\]]*\]|[^\[\]])*)\]/, + strong: /^__([\s\S]+?)__(?!_)|^\*\*([\s\S]+?)\*\*(?!\*)/, + em: /^\b_((?:[^_]|__)+?)_\b|^\*((?:\*\*|[\s\S])+?)\*(?!\*)/, + code: /^(`+)\s*([\s\S]*?[^`])\s*\1(?!`)/, + br: /^ {2,}\n(?!\s*$)/, + del: noop, + text: /^[\s\S]+?(?=[\\<!\[_*`]| {2,}\n|$)/ + }; + + inline._inside = /(?:\[[^\]]*\]|[^\[\]]|\](?=[^\[]*\]))*/; + inline._href = /\s*<?([\s\S]*?)>?(?:\s+['"]([\s\S]*?)['"])?\s*/; + + inline.link = replace(inline.link) + ('inside', inline._inside) + ('href', inline._href) + (); + + inline.reflink = replace(inline.reflink) + ('inside', inline._inside) + (); + + /** + * Normal Inline Grammar + */ + + inline.normal = merge({}, inline); + + /** + * Pedantic Inline Grammar + */ + + inline.pedantic = merge({}, inline.normal, { + strong: /^__(?=\S)([\s\S]*?\S)__(?!_)|^\*\*(?=\S)([\s\S]*?\S)\*\*(?!\*)/, + em: /^_(?=\S)([\s\S]*?\S)_(?!_)|^\*(?=\S)([\s\S]*?\S)\*(?!\*)/ + }); + + /** + * GFM Inline Grammar + */ + + inline.gfm = merge({}, inline.normal, { + escape: replace(inline.escape)('])', '~|])')(), + url: /^(https?:\/\/[^\s<]+[^<.,:;"')\]\s])/, + del: /^~~(?=\S)([\s\S]*?\S)~~/, + text: replace(inline.text) + (']|', '~]|') + ('|', '|https?://|') + () + }); + + /** + * GFM + Line Breaks Inline Grammar + */ + + inline.breaks = merge({}, inline.gfm, { + br: replace(inline.br)('{2,}', '*')(), + text: replace(inline.gfm.text)('{2,}', '*')() + }); + + /** + * Inline Lexer & Compiler + */ + + var InlineLexer = function (links, options) { + this.options = options || marked.defaults; + this.links = links; + this.rules = inline.normal; + this.renderer = this.options.renderer || new Renderer; + this.renderer.options = this.options; + + if (!this.links) { + throw new + Error('Tokens array requires a `links` property.'); + } + + if (this.options.gfm) { + if (this.options.breaks) { + this.rules = inline.breaks; + } else { + this.rules = inline.gfm; + } + } else if (this.options.pedantic) { + this.rules = inline.pedantic; + } + } + + /** + * Expose Inline Rules + */ + + InlineLexer.rules = inline; + + /** + * Static Lexing/Compiling Method + */ + + InlineLexer.output = function(src, links, options) { + var inline = new InlineLexer(links, options); + return inline.output(src); + }; + + /** + * Lexing/Compiling + */ + + InlineLexer.prototype.output = function(src) { + var out = '' + , link + , text + , href + , cap; + + while (src) { + // escape + if (cap = this.rules.escape.exec(src)) { + src = src.substring(cap[0].length); + out += cap[1]; + continue; + } + + // autolink + if (cap = this.rules.autolink.exec(src)) { + src = src.substring(cap[0].length); + if (cap[2] === '@') { + text = cap[1].charAt(6) === ':' + ? this.mangle(cap[1].substring(7)) + : this.mangle(cap[1]); + href = this.mangle('mailto:') + text; + } else { + text = escape(cap[1]); + href = text; + } + out += this.renderer.link(href, null, text); + continue; + } + + // url (gfm) + if (!this.inLink && (cap = this.rules.url.exec(src))) { + src = src.substring(cap[0].length); + text = escape(cap[1]); + href = text; + out += this.renderer.link(href, null, text); + continue; + } + + // tag + if (cap = this.rules.tag.exec(src)) { + if (!this.inLink && /^<a /i.test(cap[0])) { + this.inLink = true; + } else if (this.inLink && /^<\/a>/i.test(cap[0])) { + this.inLink = false; + } + src = src.substring(cap[0].length); + out += this.options.sanitize + ? this.options.sanitizer + ? this.options.sanitizer(cap[0]) + : escape(cap[0]) + : cap[0]; + continue; + } + + // link + if (cap = this.rules.link.exec(src)) { + src = src.substring(cap[0].length); + this.inLink = true; + out += this.outputLink(cap, { + href: cap[2], + title: cap[3] + }); + this.inLink = false; + continue; + } + + // reflink, nolink + if ((cap = this.rules.reflink.exec(src)) + || (cap = this.rules.nolink.exec(src))) { + src = src.substring(cap[0].length); + link = (cap[2] || cap[1]).replace(/\s+/g, ' '); + link = this.links[link.toLowerCase()]; + if (!link || !link.href) { + out += cap[0].charAt(0); + src = cap[0].substring(1) + src; + continue; + } + this.inLink = true; + out += this.outputLink(cap, link); + this.inLink = false; + continue; + } + + // strong + if (cap = this.rules.strong.exec(src)) { + src = src.substring(cap[0].length); + out += this.renderer.strong(this.output(cap[2] || cap[1])); + continue; + } + + // em + if (cap = this.rules.em.exec(src)) { + src = src.substring(cap[0].length); + out += this.renderer.em(this.output(cap[2] || cap[1])); + continue; + } + + // code + if (cap = this.rules.code.exec(src)) { + src = src.substring(cap[0].length); + out += this.renderer.codespan(escape(cap[2], true)); + continue; + } + + // br + if (cap = this.rules.br.exec(src)) { + src = src.substring(cap[0].length); + out += this.renderer.br(); + continue; + } + + // del (gfm) + if (cap = this.rules.del.exec(src)) { + src = src.substring(cap[0].length); + out += this.renderer.del(this.output(cap[1])); + continue; + } + + // text + if (cap = this.rules.text.exec(src)) { + src = src.substring(cap[0].length); + out += this.renderer.text(escape(this.smartypants(cap[0]))); + continue; + } + + if (src) { + throw new + Error('Infinite loop on byte: ' + src.charCodeAt(0)); + } + } + + return out; + }; + + /** + * Compile Link + */ + + InlineLexer.prototype.outputLink = function(cap, link) { + var href = escape(link.href) + , title = link.title ? escape(link.title) : null; + + return cap[0].charAt(0) !== '!' + ? this.renderer.link(href, title, this.output(cap[1])) + : this.renderer.image(href, title, escape(cap[1])); + }; + + /** + * Smartypants Transformations + */ + + InlineLexer.prototype.smartypants = function(text) { + if (!this.options.smartypants) { return text; } + return text + // em-dashes + .replace(/---/g, '\u2014') + // en-dashes + .replace(/--/g, '\u2013') + // opening singles + .replace(/(^|[-\u2014/(\[{"\s])'/g, '$1\u2018') + // closing singles & apostrophes + .replace(/'/g, '\u2019') + // opening doubles + .replace(/(^|[-\u2014/(\[{\u2018\s])"/g, '$1\u201c') + // closing doubles + .replace(/"/g, '\u201d') + // ellipses + .replace(/\.{3}/g, '\u2026'); + }; + + /** + * Mangle Links + */ + + InlineLexer.prototype.mangle = function(text) { + if (!this.options.mangle) { return text; } + var out = '' + , l = text.length + , i = 0 + , ch; + + for (; i < l; i++) { + ch = text.charCodeAt(i); + if (Math.random() > 0.5) { + ch = 'x' + ch.toString(16); + } + out += '&#' + ch + ';'; + } + + return out; + }; + + /** + * Renderer + */ + + var Renderer = function (options) { + this.options = options || {}; + } + + Renderer.prototype.code = function(code, lang, escaped) { + if (this.options.highlight) { + var out = this.options.highlight(code, lang); + if (out != null && out !== code) { + escaped = true; + code = out; + } + } else { + // hack!!! - it's already escapeD? + escaped = true; + } + + if (!lang) { + return '<pre><code>' + + (escaped ? code : escape(code, true)) + + '\n</code></pre>'; + } + + return '<pre><code class="' + + this.options.langPrefix + + escape(lang, true) + + '">' + + (escaped ? code : escape(code, true)) + + '\n</code></pre>\n'; + }; + + Renderer.prototype.blockquote = function(quote) { + return '<blockquote>\n' + quote + '</blockquote>\n'; + }; + + Renderer.prototype.html = function(html) { + return html; + }; + + Renderer.prototype.heading = function(text, level, raw) { + return '<h' + + level + + ' id="' + + this.options.headerPrefix + + raw.toLowerCase().replace(/[^\w]+/g, '-') + + '">' + + text + + '</h' + + level + + '>\n'; + }; + + Renderer.prototype.hr = function() { + return this.options.xhtml ? '<hr/>\n' : '<hr>\n'; + }; + + Renderer.prototype.list = function(body, ordered) { + var type = ordered ? 'ol' : 'ul'; + return '<' + type + '>\n' + body + '</' + type + '>\n'; + }; + + Renderer.prototype.listitem = function(text) { + return '<li>' + text + '</li>\n'; + }; + + Renderer.prototype.paragraph = function(text) { + return '<p>' + text + '</p>\n'; + }; + + Renderer.prototype.table = function(header, body) { + return '<table class="table table-striped">\n' + + '<thead>\n' + + header + + '</thead>\n' + + '<tbody>\n' + + body + + '</tbody>\n' + + '</table>\n'; + }; + + Renderer.prototype.tablerow = function(content) { + return '<tr>\n' + content + '</tr>\n'; + }; + + Renderer.prototype.tablecell = function(content, flags) { + var type = flags.header ? 'th' : 'td'; + var tag = flags.align + ? '<' + type + ' style="text-align:' + flags.align + '">' + : '<' + type + '>'; + return tag + content + '</' + type + '>\n'; + }; + + // span level renderer + Renderer.prototype.strong = function(text) { + return '<strong>' + text + '</strong>'; + }; + + Renderer.prototype.em = function(text) { + return '<em>' + text + '</em>'; + }; + + Renderer.prototype.codespan = function(text) { + return '<code>' + text + '</code>'; + }; + + Renderer.prototype.br = function() { + return this.options.xhtml ? '<br/>' : '<br>'; + }; + + Renderer.prototype.del = function(text) { + return '<del>' + text + '</del>'; + }; + + Renderer.prototype.link = function(href, title, text) { + if (this.options.sanitize) { + try { + var prot = decodeURIComponent(unescape(href)) + .replace(/[^\w:]/g, '') + .toLowerCase(); + } catch (e) { + return ''; + } + if (prot.indexOf('javascript:') === 0 || prot.indexOf('vbscript:') === 0) { + return ''; + } + } + var out = '<a href="' + href + '"'; + if (title) { + out += ' title="' + title + '"'; + } + out += '>' + text + '</a>'; + return out; + }; + + Renderer.prototype.image = function(href, title, text) { + var out = '<img src="' + href + '" alt="' + text + '"'; + if (title) { + out += ' title="' + title + '"'; + } + out += this.options.xhtml ? '/>' : '>'; + return out; + }; + + Renderer.prototype.text = function(text) { + return text; + }; + + /** + * Parsing & Compiling + */ + + var Parser = function (options) { + this.tokens = []; + this.token = null; + this.options = options || marked.defaults; + this.options.renderer = this.options.renderer || new Renderer; + this.renderer = this.options.renderer; + this.renderer.options = this.options; + } + + /** + * Static Parse Method + */ + + Parser.parse = function(src, options, renderer) { + var parser = new Parser(options, renderer); + return parser.parse(src); + }; + + /** + * Parse Loop + */ + + Parser.prototype.parse = function(src) { + this.inline = new InlineLexer(src.links, this.options, this.renderer); + this.tokens = src.reverse(); + + var out = ''; + while (this.next()) { + out += this.tok(); + } + + return out; + }; + + /** + * Next Token + */ + + Parser.prototype.next = function() { + return this.token = this.tokens.pop(); + }; + + /** + * Preview Next Token + */ + + Parser.prototype.peek = function() { + return this.tokens[this.tokens.length - 1] || 0; + }; + + /** + * Parse Text Tokens + */ + + Parser.prototype.parseText = function() { + var body = this.token.text; + + while (this.peek().type === 'text') { + body += '\n' + this.next().text; + } + + return this.inline.output(body); + }; + + /** + * Parse Current Token + */ + + Parser.prototype.tok = function() { + switch (this.token.type) { + case 'space': { + return ''; + } + case 'hr': { + return this.renderer.hr(); + } + case 'heading': { + return this.renderer.heading( + this.inline.output(this.token.text), + this.token.depth, + this.token.text); + } + case 'code': { + return this.renderer.code(this.token.text, + this.token.lang, + this.token.escaped); + } + case 'table': { + var header = '' + , body = '' + , i + , row + , cell + , flags + , j; + + // header + cell = ''; + for (i = 0; i < this.token.header.length; i++) { + flags = { header: true, align: this.token.align[i] }; + cell += this.renderer.tablecell( + this.inline.output(this.token.header[i]), + { header: true, align: this.token.align[i] } + ); + } + header += this.renderer.tablerow(cell); + + for (i = 0; i < this.token.cells.length; i++) { + row = this.token.cells[i]; + + cell = ''; + for (j = 0; j < row.length; j++) { + cell += this.renderer.tablecell( + this.inline.output(row[j]), + { header: false, align: this.token.align[j] } + ); + } + + body += this.renderer.tablerow(cell); + } + return this.renderer.table(header, body); + } + case 'blockquote_start': { + var body = ''; + + while (this.next().type !== 'blockquote_end') { + body += this.tok(); + } + + return this.renderer.blockquote(body); + } + case 'list_start': { + var body = '' + , ordered = this.token.ordered; + + while (this.next().type !== 'list_end') { + body += this.tok(); + } + + return this.renderer.list(body, ordered); + } + case 'list_item_start': { + var body = ''; + + while (this.next().type !== 'list_item_end') { + body += this.token.type === 'text' + ? this.parseText() + : this.tok(); + } + + return this.renderer.listitem(body); + } + case 'loose_item_start': { + var body = ''; + + while (this.next().type !== 'list_item_end') { + body += this.tok(); + } + + return this.renderer.listitem(body); + } + case 'html': { + var html = !this.token.pre && !this.options.pedantic + ? this.inline.output(this.token.text) + : this.token.text; + return this.renderer.html(html); + } + case 'paragraph': { + return this.renderer.paragraph(this.inline.output(this.token.text)); + } + case 'text': { + return this.renderer.paragraph(this.parseText()); + } + } + }; + + /** + * Helpers + */ + + var escape = function (html, encode) { + return html + .replace(!encode ? /&(?!#?\w+;)/g : /&/g, '&amp;') + .replace(/</g, '&lt;') + .replace(/>/g, '&gt;') + .replace(/"/g, '&quot;') + .replace(/'/g, '&#39;'); + } + + var unescape = function (html) { + // explicitly match decimal, hex, and named HTML entities + return html.replace(/&(#(?:\d+)|(?:#x[0-9A-Fa-f]+)|(?:\w+));?/g, function(_, n) { + n = n.toLowerCase(); + if (n === 'colon') { return ':'; } + if (n.charAt(0) === '#') { + return n.charAt(1) === 'x' + ? String.fromCharCode(parseInt(n.substring(2), 16)) + : String.fromCharCode(+n.substring(1)); + } + return ''; + }); + } + + var replace = function (regex, opt) { + regex = regex.source; + opt = opt || ''; + return function self(name, val) { + if (!name) { return new RegExp(regex, opt); } + val = val.source || val; + val = val.replace(/(^|[^\[])\^/g, '$1'); + regex = regex.replace(name, val); + return self; + }; + } + + var noop = function () {} + noop.exec = noop; + + function merge(obj) { + var i = 1 + , target + , key; + + for (; i < arguments.length; i++) { + target = arguments[i]; + for (key in target) { + if (Object.prototype.hasOwnProperty.call(target, key)) { + obj[key] = target[key]; + } + } + } + + return obj; + } + + + /** + * Marked + */ + + var marked = function (src, opt, callback) { + if (callback || typeof opt === 'function') { + if (!callback) { + callback = opt; + opt = null; + } + + opt = merge({}, marked.defaults, opt || {}); + + var highlight = opt.highlight + , tokens + , pending + , i = 0; + + try { + tokens = Lexer.lex(src, opt) + } catch (e) { + return callback(e); + } + + pending = tokens.length; + + var done = function(err) { + if (err) { + opt.highlight = highlight; + return callback(err); + } + + var out; + + try { + out = Parser.parse(tokens, opt); + } catch (e) { + err = e; + } + + opt.highlight = highlight; + + return err + ? callback(err) + : callback(null, out); + }; + + if (!highlight || highlight.length < 3) { + return done(); + } + + delete opt.highlight; + + if (!pending) { return done(); } + + for (; i < tokens.length; i++) { + (function(token) { + if (token.type !== 'code') { + return --pending || done(); + } + return highlight(token.text, token.lang, function(err, code) { + if (err) { return done(err); } + if (code == null || code === token.text) { + return --pending || done(); + } + token.text = code; + token.escaped = true; + --pending || done(); + }); + })(tokens[i]); + } + + return; + } + try { + if (opt) { opt = merge({}, marked.defaults, opt); } + return Parser.parse(Lexer.lex(src, opt), opt); + } catch (e) { + e.message += '\nPlease report this to https://github.com/chjj/marked.'; + if ((opt || marked.defaults).silent) { + return '<p>An error occured:</p><pre>' + + escape(e.message + '', true) + + '</pre>'; + } + throw e; + } + } + + /** + * Options + */ + + marked.options = + marked.setOptions = function(opt) { + merge(marked.defaults, opt); + return marked; + }; + + marked.defaults = { + gfm: true, + tables: true, + breaks: false, + pedantic: false, + sanitize: false, + sanitizer: null, + mangle: true, + smartLists: false, + silent: false, + highlight: null, + langPrefix: 'lang-', + smartypants: false, + headerPrefix: '', + renderer: new Renderer, + xhtml: false + }; + + /** + * Expose + */ + + marked.Parser = Parser; + marked.parser = Parser.parse; + + marked.Renderer = Renderer; + + marked.Lexer = Lexer; + marked.lexer = Lexer.lex; + + marked.InlineLexer = InlineLexer; + marked.inlineLexer = InlineLexer.output; + + marked.parse = marked; + + Roo.Markdown.marked = marked; + +})(); \ No newline at end of file diff --git a/docs2/src/Roo_MasterTemplate.js.html b/docs2/src/Roo_MasterTemplate.js.html new file mode 100644 index 0000000000..70e51192c8 --- /dev/null +++ b/docs2/src/Roo_MasterTemplate.js.html @@ -0,0 +1,153 @@ +/home/alan/gitlive/roojs1/Roo/MasterTemplate.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + + + +/** + * @class Roo.MasterTemplate + * @extends Roo.Template + * Provides a template that can have child templates. The syntax is: +<pre><code> +var t = new Roo.MasterTemplate( + '&lt;select name="{name}"&gt;', + '&lt;tpl name="options"&gt;&lt;option value="{value:trim}"&gt;{text:ellipsis(10)}&lt;/option&gt;&lt;/tpl&gt;', + '&lt;/select&gt;' +); +t.add('options', {value: 'foo', text: 'bar'}); +// or you can add multiple child elements in one shot +t.addAll('options', [ + {value: 'foo', text: 'bar'}, + {value: 'foo2', text: 'bar2'}, + {value: 'foo3', text: 'bar3'} +]); +// then append, applying the master template values +t.append('my-form', {name: 'my-select'}); +</code></pre> +* A name attribute for the child template is not required if you have only one child +* template or you want to refer to them by index. + */ +Roo.MasterTemplate = function(){ + Roo.MasterTemplate.superclass.constructor.apply(this, arguments); + this.originalHtml = this.html; + var st = {}; + var m, re = this.subTemplateRe; + re.lastIndex = 0; + var subIndex = 0; + while(m = re.exec(this.html)){ + var name = m[1], content = m[2]; + st[subIndex] = { + name: name, + index: subIndex, + buffer: [], + tpl : new Roo.Template(content) + }; + if(name){ + st[name] = st[subIndex]; + } + st[subIndex].tpl.compile(); + st[subIndex].tpl.call = this.call.createDelegate(this); + subIndex++; + } + this.subCount = subIndex; + this.subs = st; +}; +Roo.extend(Roo.MasterTemplate, Roo.Template, { + /** + * The regular expression used to match sub templates + * @type RegExp + * @property + */ + subTemplateRe : /<tpl(?:\sname="([\w-]+)")?>((?:.|\n)*?)<\/tpl>/gi, + + /** + * Applies the passed values to a child template. + * @param {String/Number} name (optional) The name or index of the child template + * @param {Array/Object} values The values to be applied to the template + * @return {MasterTemplate} this + */ + add : function(name, values){ + if(arguments.length == 1){ + values = arguments[0]; + name = 0; + } + var s = this.subs[name]; + s.buffer[s.buffer.length] = s.tpl.apply(values); + return this; + }, + + /** + * Applies all the passed values to a child template. + * @param {String/Number} name (optional) The name or index of the child template + * @param {Array} values The values to be applied to the template, this should be an array of objects. + * @param {Boolean} reset (optional) True to reset the template first + * @return {MasterTemplate} this + */ + fill : function(name, values, reset){ + var a = arguments; + if(a.length == 1 || (a.length == 2 && typeof a[1] == "boolean")){ + values = a[0]; + name = 0; + reset = a[1]; + } + if(reset){ + this.reset(); + } + for(var i = 0, len = values.length; i < len; i++){ + this.add(name, values[i]); + } + return this; + }, + + /** + * Resets the template for reuse + * @return {MasterTemplate} this + */ + reset : function(){ + var s = this.subs; + for(var i = 0; i < this.subCount; i++){ + s[i].buffer = []; + } + return this; + }, + + applyTemplate : function(values){ + var s = this.subs; + var replaceIndex = -1; + this.html = this.originalHtml.replace(this.subTemplateRe, function(m, name){ + return s[++replaceIndex].buffer.join(""); + }); + return Roo.MasterTemplate.superclass.applyTemplate.call(this, values); + }, + + apply : function(){ + return this.applyTemplate.apply(this, arguments); + }, + + compile : function(){return this;} +}); + +/** + * Alias for fill(). + * @method + */ +Roo.MasterTemplate.prototype.addAll = Roo.MasterTemplate.prototype.fill; + /** + * Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML. e.g. + * var tpl = Roo.MasterTemplate.from('element-id'); + * @param {String/HTMLElement} el + * @param {Object} config + * @static + */ +Roo.MasterTemplate.from = function(el, config){ + el = Roo.getDom(el); + return new Roo.MasterTemplate(el.value || el.innerHTML, config || ''); +}; \ No newline at end of file diff --git a/docs2/src/Roo_MessageBox.js.html b/docs2/src/Roo_MessageBox.js.html new file mode 100644 index 0000000000..72ff9eb771 --- /dev/null +++ b/docs2/src/Roo_MessageBox.js.html @@ -0,0 +1,552 @@ +/home/alan/gitlive/roojs1/Roo/MessageBox.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.MessageBox + * Utility class for generating different styles of message boxes. The alias Roo.Msg can also be used. + * Example usage: + *<pre><code> +// Basic alert: +Roo.Msg.alert('Status', 'Changes saved successfully.'); + +// Prompt for user data: +Roo.Msg.prompt('Name', 'Please enter your name:', function(btn, text){ + if (btn == 'ok'){ + // process text value... + } +}); + +// Show a dialog using config options: +Roo.Msg.show({ + title:'Save Changes?', + msg: 'Your are closing a tab that has unsaved changes. Would you like to save your changes?', + buttons: Roo.Msg.YESNOCANCEL, + fn: processResult, + animEl: 'elId' +}); +</code></pre> + * @singleton + */ +Roo.MessageBox = function(){ + var dlg, opt, mask, waitTimer; + var bodyEl, msgEl, textboxEl, textareaEl, progressEl, pp; + var buttons, activeTextEl, bwidth; + + // private + var handleButton = function(button){ + dlg.hide(); + Roo.callback(opt.fn, opt.scope||window, [button, activeTextEl.dom.value], 1); + }; + + // private + var handleHide = function(){ + if(opt && opt.cls){ + dlg.el.removeClass(opt.cls); + } + if(waitTimer){ + Roo.TaskMgr.stop(waitTimer); + waitTimer = null; + } + }; + + // private + var updateButtons = function(b){ + var width = 0; + if(!b){ + buttons["ok"].hide(); + buttons["cancel"].hide(); + buttons["yes"].hide(); + buttons["no"].hide(); + dlg.footer.dom.style.display = 'none'; + return width; + } + dlg.footer.dom.style.display = ''; + for(var k in buttons){ + if(typeof buttons[k] != "function"){ + if(b[k]){ + buttons[k].show(); + buttons[k].setText(typeof b[k] == "string" ? b[k] : Roo.MessageBox.buttonText[k]); + width += buttons[k].el.getWidth()+15; + }else{ + buttons[k].hide(); + } + } + } + return width; + }; + + // private + var handleEsc = function(d, k, e){ + if(opt && opt.closable !== false){ + dlg.hide(); + } + if(e){ + e.stopEvent(); + } + }; + + return { + /** + * Returns a reference to the underlying {@link Roo.BasicDialog} element + * @return {Roo.BasicDialog} The BasicDialog element + */ + getDialog : function(){ + if(!dlg){ + dlg = new Roo.BasicDialog("x-msg-box", { + autoCreate : true, + shadow: true, + draggable: true, + resizable:false, + constraintoviewport:false, + fixedcenter:true, + collapsible : false, + shim:true, + modal: true, + width:400, height:100, + buttonAlign:"center", + closeClick : function(){ + if(opt && opt.buttons && opt.buttons.no && !opt.buttons.cancel){ + handleButton("no"); + }else{ + handleButton("cancel"); + } + } + }); + dlg.on("hide", handleHide); + mask = dlg.mask; + dlg.addKeyListener(27, handleEsc); + buttons = {}; + var bt = this.buttonText; + buttons["ok"] = dlg.addButton(bt["ok"], handleButton.createCallback("ok")); + buttons["yes"] = dlg.addButton(bt["yes"], handleButton.createCallback("yes")); + buttons["no"] = dlg.addButton(bt["no"], handleButton.createCallback("no")); + buttons["cancel"] = dlg.addButton(bt["cancel"], handleButton.createCallback("cancel")); + bodyEl = dlg.body.createChild({ + + html:'<span class="roo-mb-text"></span><br /><input type="text" class="roo-mb-input" /><textarea class="roo-mb-textarea"></textarea><div class="roo-mb-progress-wrap"><div class="roo-mb-progress"><div class="roo-mb-progress-bar">&#160;</div></div></div>' + }); + msgEl = bodyEl.dom.firstChild; + textboxEl = Roo.get(bodyEl.dom.childNodes[2]); + textboxEl.enableDisplayMode(); + textboxEl.addKeyListener([10,13], function(){ + if(dlg.isVisible() && opt && opt.buttons){ + if(opt.buttons.ok){ + handleButton("ok"); + }else if(opt.buttons.yes){ + handleButton("yes"); + } + } + }); + textareaEl = Roo.get(bodyEl.dom.childNodes[3]); + textareaEl.enableDisplayMode(); + progressEl = Roo.get(bodyEl.dom.childNodes[4]); + progressEl.enableDisplayMode(); + var pf = progressEl.dom.firstChild; + if (pf) { + pp = Roo.get(pf.firstChild); + pp.setHeight(pf.offsetHeight); + } + + } + return dlg; + }, + + /** + * Updates the message box body text + * @param {String} text (optional) Replaces the message box element's innerHTML with the specified string (defaults to + * the XHTML-compliant non-breaking space character '&amp;#160;') + * @return {Roo.MessageBox} This message box + */ + updateText : function(text){ + if(!dlg.isVisible() && !opt.width){ + dlg.resizeTo(this.maxWidth, 100); // resize first so content is never clipped from previous shows + } + msgEl.innerHTML = text || '&#160;'; + + var cw = Math.max(msgEl.offsetWidth, msgEl.parentNode.scrollWidth); + //Roo.log("guesed size: " + JSON.stringify([cw,msgEl.offsetWidth, msgEl.parentNode.scrollWidth])); + var w = Math.max( + Math.min(opt.width || cw , this.maxWidth), + Math.max(opt.minWidth || this.minWidth, bwidth) + ); + if(opt.prompt){ + activeTextEl.setWidth(w); + } + if(dlg.isVisible()){ + dlg.fixedcenter = false; + } + // to big, make it scroll. = But as usual stupid IE does not support + // !important.. + + if ( bodyEl.getHeight() > (Roo.lib.Dom.getViewHeight() - 100)) { + bodyEl.setHeight ( Roo.lib.Dom.getViewHeight() - 100 ); + bodyEl.dom.style.overflowY = 'auto' + ( Roo.isIE ? '' : ' !important'); + } else { + bodyEl.dom.style.height = ''; + bodyEl.dom.style.overflowY = ''; + } + if (cw > w) { + bodyEl.dom.style.get = 'auto' + ( Roo.isIE ? '' : ' !important'); + } else { + bodyEl.dom.style.overflowX = ''; + } + + dlg.setContentSize(w, bodyEl.getHeight()); + if(dlg.isVisible()){ + dlg.fixedcenter = true; + } + return this; + }, + + /** + * Updates a progress-style message box's text and progress bar. Only relevant on message boxes + * initiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true. + * @param {Number} value Any number between 0 and 1 (e.g., .5) + * @param {String} text (optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined) + * @return {Roo.MessageBox} This message box + */ + updateProgress : function(value, text){ + if(text){ + this.updateText(text); + } + if (pp) { // weird bug on my firefox - for some reason this is not defined + pp.setWidth(Math.floor(value*progressEl.dom.firstChild.offsetWidth)); + } + return this; + }, + + /** + * Returns true if the message box is currently displayed + * @return {Boolean} True if the message box is visible, else false + */ + isVisible : function(){ + return dlg && dlg.isVisible(); + }, + + /** + * Hides the message box if it is displayed + */ + hide : function(){ + if(this.isVisible()){ + dlg.hide(); + } + }, + + /** + * Displays a new message box, or reinitializes an existing message box, based on the config options + * passed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally. + * The following config object properties are supported: + * <pre> +Property Type Description +---------- --------------- ------------------------------------------------------------------------------------ +animEl String/Element An id or Element from which the message box should animate as it opens and + closes (defaults to undefined) +buttons Object/Boolean A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo', + cancel:'Bar'}), or false to not show any buttons (defaults to false) +closable Boolean False to hide the top-right close button (defaults to true). Note that + progress and wait dialogs will ignore this property and always hide the + close button as they can only be closed programmatically. +cls String A custom CSS class to apply to the message box element +defaultTextHeight Number The default height in pixels of the message box's multiline textarea if + displayed (defaults to 75) +fn Function A callback function to execute after closing the dialog. The arguments to the + function will be btn (the name of the button that was clicked, if applicable, + e.g. "ok"), and text (the value of the active text field, if applicable). + Progress and wait dialogs will ignore this option since they do not respond to + user actions and can only be closed programmatically, so any required function + should be called by the same code after it closes the dialog. +icon String A CSS class that provides a background image to be used as an icon for + the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '') +maxWidth Number The maximum width in pixels of the message box (defaults to 600) +minWidth Number The minimum width in pixels of the message box (defaults to 100) +modal Boolean False to allow user interaction with the page while the message box is + displayed (defaults to true) +msg String A string that will replace the existing message box body text (defaults + to the XHTML-compliant non-breaking space character '&#160;') +multiline Boolean True to prompt the user to enter multi-line text (defaults to false) +progress Boolean True to display a progress bar (defaults to false) +progressText String The text to display inside the progress bar if progress = true (defaults to '') +prompt Boolean True to prompt the user to enter single-line text (defaults to false) +proxyDrag Boolean True to display a lightweight proxy while dragging (defaults to false) +title String The title text +value String The string value to set into the active textbox element if displayed +wait Boolean True to display a progress bar (defaults to false) +width Number The width of the dialog in pixels +</pre> + * + * Example usage: + * <pre><code> +Roo.Msg.show({ + title: 'Address', + msg: 'Please enter your address:', + width: 300, + buttons: Roo.MessageBox.OKCANCEL, + multiline: true, + fn: saveAddress, + animEl: 'addAddressBtn' +}); +</code></pre> + * @param {Object} config Configuration options + * @return {Roo.MessageBox} This message box + */ + show : function(options) + { + + // this causes nightmares if you show one dialog after another + // especially on callbacks.. + + if(this.isVisible()){ + + this.hide(); + Roo.log("[Roo.Messagebox] Show called while message displayed:" ); + Roo.log("Old Dialog Message:" + msgEl.innerHTML ); + Roo.log("New Dialog Message:" + options.msg ) + //this.alert("ERROR", "Multiple dialogs where displayed at the same time"); + //throw "Roo.MessageBox ERROR : Multiple dialogs where displayed at the same time"; + + } + var d = this.getDialog(); + opt = options; + d.setTitle(opt.title || "&#160;"); + d.close.setDisplayed(opt.closable !== false); + activeTextEl = textboxEl; + opt.prompt = opt.prompt || (opt.multiline ? true : false); + if(opt.prompt){ + if(opt.multiline){ + textboxEl.hide(); + textareaEl.show(); + textareaEl.setHeight(typeof opt.multiline == "number" ? + opt.multiline : this.defaultTextHeight); + activeTextEl = textareaEl; + }else{ + textboxEl.show(); + textareaEl.hide(); + } + }else{ + textboxEl.hide(); + textareaEl.hide(); + } + progressEl.setDisplayed(opt.progress === true); + this.updateProgress(0); + activeTextEl.dom.value = opt.value || ""; + if(opt.prompt){ + dlg.setDefaultButton(activeTextEl); + }else{ + var bs = opt.buttons; + var db = null; + if(bs && bs.ok){ + db = buttons["ok"]; + }else if(bs && bs.yes){ + db = buttons["yes"]; + } + dlg.setDefaultButton(db); + } + bwidth = updateButtons(opt.buttons); + this.updateText(opt.msg); + if(opt.cls){ + d.el.addClass(opt.cls); + } + d.proxyDrag = opt.proxyDrag === true; + d.modal = opt.modal !== false; + d.mask = opt.modal !== false ? mask : false; + if(!d.isVisible()){ + // force it to the end of the z-index stack so it gets a cursor in FF + document.body.appendChild(dlg.el.dom); + d.animateTarget = null; + d.show(options.animEl); + } + return this; + }, + + /** + * Displays a message box with a progress bar. This message box has no buttons and is not closeable by + * the user. You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress} + * and closing the message box when the process is complete. + * @param {String} title The title bar text + * @param {String} msg The message box body text + * @return {Roo.MessageBox} This message box + */ + progress : function(title, msg){ + this.show({ + title : title, + msg : msg, + buttons: false, + progress:true, + closable:false, + minWidth: this.minProgressWidth, + modal : true + }); + return this; + }, + + /** + * Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert). + * If a callback function is passed it will be called after the user clicks the button, and the + * id of the button that was clicked will be passed as the only parameter to the callback + * (could also be the top-right close button). + * @param {String} title The title bar text + * @param {String} msg The message box body text + * @param {Function} fn (optional) The callback function invoked after the message box is closed + * @param {Object} scope (optional) The scope of the callback function + * @return {Roo.MessageBox} This message box + */ + alert : function(title, msg, fn, scope){ + this.show({ + title : title, + msg : msg, + buttons: this.OK, + fn: fn, + scope : scope, + modal : true + }); + return this; + }, + + /** + * Displays a message box with an infinitely auto-updating progress bar. This can be used to block user + * interaction while waiting for a long-running process to complete that does not have defined intervals. + * You are responsible for closing the message box when the process is complete. + * @param {String} msg The message box body text + * @param {String} title (optional) The title bar text + * @return {Roo.MessageBox} This message box + */ + wait : function(msg, title){ + this.show({ + title : title, + msg : msg, + buttons: false, + closable:false, + progress:true, + modal:true, + width:300, + wait:true + }); + waitTimer = Roo.TaskMgr.start({ + run: function(i){ + Roo.MessageBox.updateProgress(((((i+20)%20)+1)*5)*.01); + }, + interval: 1000 + }); + return this; + }, + + /** + * Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm). + * If a callback function is passed it will be called after the user clicks either button, and the id of the + * button that was clicked will be passed as the only parameter to the callback (could also be the top-right close button). + * @param {String} title The title bar text + * @param {String} msg The message box body text + * @param {Function} fn (optional) The callback function invoked after the message box is closed + * @param {Object} scope (optional) The scope of the callback function + * @return {Roo.MessageBox} This message box + */ + confirm : function(title, msg, fn, scope){ + this.show({ + title : title, + msg : msg, + buttons: this.YESNO, + fn: fn, + scope : scope, + modal : true + }); + return this; + }, + + /** + * Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to + * JavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function + * is passed it will be called after the user clicks either button, and the id of the button that was clicked + * (could also be the top-right close button) and the text that was entered will be passed as the two + * parameters to the callback. + * @param {String} title The title bar text + * @param {String} msg The message box body text + * @param {Function} fn (optional) The callback function invoked after the message box is closed + * @param {Object} scope (optional) The scope of the callback function + * @param {Boolean/Number} multiline (optional) True to create a multiline textbox using the defaultTextHeight + * property, or the height in pixels to create the textbox (defaults to false / single-line) + * @return {Roo.MessageBox} This message box + */ + prompt : function(title, msg, fn, scope, multiline){ + this.show({ + title : title, + msg : msg, + buttons: this.OKCANCEL, + fn: fn, + minWidth:250, + scope : scope, + prompt:true, + multiline: multiline, + modal : true + }); + return this; + }, + + /** + * Button config that displays a single OK button + * @type Object + */ + OK : {ok:true}, + /** + * Button config that displays Yes and No buttons + * @type Object + */ + YESNO : {yes:true, no:true}, + /** + * Button config that displays OK and Cancel buttons + * @type Object + */ + OKCANCEL : {ok:true, cancel:true}, + /** + * Button config that displays Yes, No and Cancel buttons + * @type Object + */ + YESNOCANCEL : {yes:true, no:true, cancel:true}, + + /** + * The default height in pixels of the message box's multiline textarea if displayed (defaults to 75) + * @type Number + */ + defaultTextHeight : 75, + /** + * The maximum width in pixels of the message box (defaults to 600) + * @type Number + */ + maxWidth : 600, + /** + * The minimum width in pixels of the message box (defaults to 100) + * @type Number + */ + minWidth : 100, + /** + * The minimum width in pixels of the message box if it is a progress-style dialog. This is useful + * for setting a different minimum width than text-only dialogs may need (defaults to 250) + * @type Number + */ + minProgressWidth : 250, + /** + * An object containing the default button text strings that can be overriden for localized language support. + * Supported properties are: ok, cancel, yes and no. + * Customize the default text like so: Roo.MessageBox.buttonText.yes = "S?"; + * @type Object + */ + buttonText : { + ok : "OK", + cancel : "Cancel", + yes : "Yes", + no : "No" + } + }; +}(); + +/** + * Shorthand for {@link Roo.MessageBox} + */ +Roo.Msg = Roo.MessageBox; \ No newline at end of file diff --git a/docs2/src/Roo_PagingToolbar.js.html b/docs2/src/Roo_PagingToolbar.js.html new file mode 100644 index 0000000000..d9a9a0ede9 --- /dev/null +++ b/docs2/src/Roo_PagingToolbar.js.html @@ -0,0 +1,309 @@ +/home/alan/gitlive/roojs1/Roo/PagingToolbar.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.PagingToolbar + * @extends Roo.Toolbar + * A specialized toolbar that is bound to a {@link Roo.data.Store} and provides automatic paging controls. + * @constructor + * Create a new PagingToolbar + * @param {Object} config The config object + */ +Roo.PagingToolbar = function(el, ds, config) +{ + // old args format still supported... - xtype is prefered.. + if (typeof(el) == 'object' && el.xtype) { + // created from xtype... + config = el; + ds = el.dataSource; + el = config.container; + } + var items = []; + if (config.items) { + items = config.items; + config.items = []; + } + + Roo.PagingToolbar.superclass.constructor.call(this, el, null, config); + this.ds = ds; + this.cursor = 0; + this.renderButtons(this.el); + this.bind(ds); + + // supprot items array. + + Roo.each(items, function(e) { + this.add(Roo.factory(e)); + },this); + +}; + +Roo.extend(Roo.PagingToolbar, Roo.Toolbar, { + /** + * @cfg {Roo.data.Store} dataSource + * The underlying data store providing the paged data + */ + /** + * @cfg {String/HTMLElement/Element} container + * container The id or element that will contain the toolbar + */ + /** + * @cfg {Boolean} displayInfo + * True to display the displayMsg (defaults to false) + */ + /** + * @cfg {Number} pageSize + * The number of records to display per page (defaults to 20) + */ + pageSize: 20, + /** + * @cfg {String} displayMsg + * The paging status message to display (defaults to "Displaying {start} - {end} of {total}") + */ + displayMsg : 'Displaying {0} - {1} of {2}', + /** + * @cfg {String} emptyMsg + * The message to display when no records are found (defaults to "No data to display") + */ + emptyMsg : 'No data to display', + /** + * Customizable piece of the default paging text (defaults to "Page") + * @type String + */ + beforePageText : "Page", + /** + * Customizable piece of the default paging text (defaults to "of %0") + * @type String + */ + afterPageText : "of {0}", + /** + * Customizable piece of the default paging text (defaults to "First Page") + * @type String + */ + firstText : "First Page", + /** + * Customizable piece of the default paging text (defaults to "Previous Page") + * @type String + */ + prevText : "Previous Page", + /** + * Customizable piece of the default paging text (defaults to "Next Page") + * @type String + */ + nextText : "Next Page", + /** + * Customizable piece of the default paging text (defaults to "Last Page") + * @type String + */ + lastText : "Last Page", + /** + * Customizable piece of the default paging text (defaults to "Refresh") + * @type String + */ + refreshText : "Refresh", + + // private + renderButtons : function(el){ + Roo.PagingToolbar.superclass.render.call(this, el); + this.first = this.addButton({ + tooltip: this.firstText, + cls: "x-btn-icon x-grid-page-first", + disabled: true, + handler: this.onClick.createDelegate(this, ["first"]) + }); + this.prev = this.addButton({ + tooltip: this.prevText, + cls: "x-btn-icon x-grid-page-prev", + disabled: true, + handler: this.onClick.createDelegate(this, ["prev"]) + }); + //this.addSeparator(); + this.add(this.beforePageText); + this.field = Roo.get(this.addDom({ + tag: "input", + type: "text", + size: "3", + value: "1", + cls: "x-grid-page-number" + }).el); + this.field.on("keydown", this.onPagingKeydown, this); + this.field.on("focus", function(){this.dom.select();}); + this.afterTextEl = this.addText(String.format(this.afterPageText, 1)); + this.field.setHeight(18); + //this.addSeparator(); + this.next = this.addButton({ + tooltip: this.nextText, + cls: "x-btn-icon x-grid-page-next", + disabled: true, + handler: this.onClick.createDelegate(this, ["next"]) + }); + this.last = this.addButton({ + tooltip: this.lastText, + cls: "x-btn-icon x-grid-page-last", + disabled: true, + handler: this.onClick.createDelegate(this, ["last"]) + }); + //this.addSeparator(); + this.loading = this.addButton({ + tooltip: this.refreshText, + cls: "x-btn-icon x-grid-loading", + handler: this.onClick.createDelegate(this, ["refresh"]) + }); + + if(this.displayInfo){ + this.displayEl = Roo.fly(this.el.dom.firstChild).createChild({cls:'x-paging-info'}); + } + }, + + // private + updateInfo : function(){ + if(this.displayEl){ + var count = this.ds.getCount(); + var msg = count == 0 ? + this.emptyMsg : + String.format( + this.displayMsg, + this.cursor+1, this.cursor+count, this.ds.getTotalCount() + ); + this.displayEl.update(msg); + } + }, + + // private + onLoad : function(ds, r, o){ + this.cursor = o.params ? o.params.start : 0; + var d = this.getPageData(), ap = d.activePage, ps = d.pages; + + this.afterTextEl.el.innerHTML = String.format(this.afterPageText, d.pages); + this.field.dom.value = ap; + this.first.setDisabled(ap == 1); + this.prev.setDisabled(ap == 1); + this.next.setDisabled(ap == ps); + this.last.setDisabled(ap == ps); + this.loading.enable(); + this.updateInfo(); + }, + + // private + getPageData : function(){ + var total = this.ds.getTotalCount(); + return { + total : total, + activePage : Math.ceil((this.cursor+this.pageSize)/this.pageSize), + pages : total < this.pageSize ? 1 : Math.ceil(total/this.pageSize) + }; + }, + + // private + onLoadError : function(){ + this.loading.enable(); + }, + + // private + onPagingKeydown : function(e){ + var k = e.getKey(); + var d = this.getPageData(); + if(k == e.RETURN){ + var v = this.field.dom.value, pageNum; + if(!v || isNaN(pageNum = parseInt(v, 10))){ + this.field.dom.value = d.activePage; + return; + } + pageNum = Math.min(Math.max(1, pageNum), d.pages) - 1; + this.ds.load({params:{start: pageNum * this.pageSize, limit: this.pageSize}}); + e.stopEvent(); + } + else if(k == e.HOME || (k == e.UP && e.ctrlKey) || (k == e.PAGEUP && e.ctrlKey) || (k == e.RIGHT && e.ctrlKey) || k == e.END || (k == e.DOWN && e.ctrlKey) || (k == e.LEFT && e.ctrlKey) || (k == e.PAGEDOWN && e.ctrlKey)) + { + var pageNum = (k == e.HOME || (k == e.DOWN && e.ctrlKey) || (k == e.LEFT && e.ctrlKey) || (k == e.PAGEDOWN && e.ctrlKey)) ? 1 : d.pages; + this.field.dom.value = pageNum; + this.ds.load({params:{start: (pageNum - 1) * this.pageSize, limit: this.pageSize}}); + e.stopEvent(); + } + else if(k == e.UP || k == e.RIGHT || k == e.PAGEUP || k == e.DOWN || k == e.LEFT || k == e.PAGEDOWN) + { + var v = this.field.dom.value, pageNum; + var increment = (e.shiftKey) ? 10 : 1; + if(k == e.DOWN || k == e.LEFT || k == e.PAGEDOWN) { + increment *= -1; + } + if(!v || isNaN(pageNum = parseInt(v, 10))) { + this.field.dom.value = d.activePage; + return; + } + else if(parseInt(v, 10) + increment >= 1 & parseInt(v, 10) + increment <= d.pages) + { + this.field.dom.value = parseInt(v, 10) + increment; + pageNum = Math.min(Math.max(1, pageNum + increment), d.pages) - 1; + this.ds.load({params:{start: pageNum * this.pageSize, limit: this.pageSize}}); + } + e.stopEvent(); + } + }, + + // private + beforeLoad : function(){ + if(this.loading){ + this.loading.disable(); + } + }, + + // private + onClick : function(which){ + var ds = this.ds; + switch(which){ + case "first": + ds.load({params:{start: 0, limit: this.pageSize}}); + break; + case "prev": + ds.load({params:{start: Math.max(0, this.cursor-this.pageSize), limit: this.pageSize}}); + break; + case "next": + ds.load({params:{start: this.cursor+this.pageSize, limit: this.pageSize}}); + break; + case "last": + var total = ds.getTotalCount(); + var extra = total % this.pageSize; + var lastStart = extra ? (total - extra) : total-this.pageSize; + ds.load({params:{start: lastStart, limit: this.pageSize}}); + break; + case "refresh": + ds.load({params:{start: this.cursor, limit: this.pageSize}}); + break; + } + }, + + /** + * Unbinds the paging toolbar from the specified {@link Roo.data.Store} + * @param {Roo.data.Store} store The data store to unbind + */ + unbind : function(ds){ + ds.un("beforeload", this.beforeLoad, this); + ds.un("load", this.onLoad, this); + ds.un("loadexception", this.onLoadError, this); + ds.un("remove", this.updateInfo, this); + ds.un("add", this.updateInfo, this); + this.ds = undefined; + }, + + /** + * Binds the paging toolbar to the specified {@link Roo.data.Store} + * @param {Roo.data.Store} store The data store to bind + */ + bind : function(ds){ + ds.on("beforeload", this.beforeLoad, this); + ds.on("load", this.onLoad, this); + ds.on("loadexception", this.onLoadError, this); + ds.on("remove", this.updateInfo, this); + ds.on("add", this.updateInfo, this); + this.ds = ds; + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_QuickTips.js.html b/docs2/src/Roo_QuickTips.js.html new file mode 100644 index 0000000000..d0e55e42f4 --- /dev/null +++ b/docs2/src/Roo_QuickTips.js.html @@ -0,0 +1,401 @@ +/home/alan/gitlive/roojs1/Roo/QuickTips.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.QuickTips + * Provides attractive and customizable tooltips for any element. + * @singleton + */ +Roo.QuickTips = function(){ + var el, tipBody, tipBodyText, tipTitle, tm, cfg, close, tagEls = {}, esc, removeCls = null, bdLeft, bdRight; + var ce, bd, xy, dd; + var visible = false, disabled = true, inited = false; + var showProc = 1, hideProc = 1, dismissProc = 1, locks = []; + + var onOver = function(e){ + if(disabled){ + return; + } + var t = e.getTarget(); + if(!t || t.nodeType !== 1 || t == document || t == document.body){ + return; + } + if(ce && t == ce.el){ + clearTimeout(hideProc); + return; + } + if(t && tagEls[t.id]){ + tagEls[t.id].el = t; + showProc = show.defer(tm.showDelay, tm, [tagEls[t.id]]); + return; + } + var ttp, et = Roo.fly(t); + var ns = cfg.namespace; + if(tm.interceptTitles && t.title){ + ttp = t.title; + t.qtip = ttp; + t.removeAttribute("title"); + e.preventDefault(); + }else{ + ttp = t.qtip || et.getAttributeNS(ns, cfg.attribute) || et.getAttributeNS(cfg.alt_namespace, cfg.attribute) ; + } + if(ttp){ + showProc = show.defer(tm.showDelay, tm, [{ + el: t, + text: ttp.replace(/\\n/g,'<br/>'), + width: et.getAttributeNS(ns, cfg.width), + autoHide: et.getAttributeNS(ns, cfg.hide) != "user", + title: et.getAttributeNS(ns, cfg.title), + cls: et.getAttributeNS(ns, cfg.cls) + }]); + } + }; + + var onOut = function(e){ + clearTimeout(showProc); + var t = e.getTarget(); + if(t && ce && ce.el == t && (tm.autoHide && ce.autoHide !== false)){ + hideProc = setTimeout(hide, tm.hideDelay); + } + }; + + var onMove = function(e){ + if(disabled){ + return; + } + xy = e.getXY(); + xy[1] += 18; + if(tm.trackMouse && ce){ + el.setXY(xy); + } + }; + + var onDown = function(e){ + clearTimeout(showProc); + clearTimeout(hideProc); + if(!e.within(el)){ + if(tm.hideOnClick){ + hide(); + tm.disable(); + tm.enable.defer(100, tm); + } + } + }; + + var getPad = function(){ + return 2;//bdLeft.getPadding('l')+bdRight.getPadding('r'); + }; + + var show = function(o){ + if(disabled){ + return; + } + clearTimeout(dismissProc); + ce = o; + if(removeCls){ // in case manually hidden + el.removeClass(removeCls); + removeCls = null; + } + if(ce.cls){ + el.addClass(ce.cls); + removeCls = ce.cls; + } + if(ce.title){ + tipTitle.update(ce.title); + tipTitle.show(); + }else{ + tipTitle.update(''); + tipTitle.hide(); + } + el.dom.style.width = tm.maxWidth+'px'; + //tipBody.dom.style.width = ''; + tipBodyText.update(o.text); + var p = getPad(), w = ce.width; + if(!w){ + var td = tipBodyText.dom; + var aw = Math.max(td.offsetWidth, td.clientWidth, td.scrollWidth); + if(aw > tm.maxWidth){ + w = tm.maxWidth; + }else if(aw < tm.minWidth){ + w = tm.minWidth; + }else{ + w = aw; + } + } + //tipBody.setWidth(w); + el.setWidth(parseInt(w, 10) + p); + if(ce.autoHide === false){ + close.setDisplayed(true); + if(dd){ + dd.unlock(); + } + }else{ + close.setDisplayed(false); + if(dd){ + dd.lock(); + } + } + if(xy){ + el.avoidY = xy[1]-18; + el.setXY(xy); + } + if(tm.animate){ + el.setOpacity(.1); + el.setStyle("visibility", "visible"); + el.fadeIn({callback: afterShow}); + }else{ + afterShow(); + } + }; + + var afterShow = function(){ + if(ce){ + el.show(); + esc.enable(); + if(tm.autoDismiss && ce.autoHide !== false){ + dismissProc = setTimeout(hide, tm.autoDismissDelay); + } + } + }; + + var hide = function(noanim){ + clearTimeout(dismissProc); + clearTimeout(hideProc); + ce = null; + if(el.isVisible()){ + esc.disable(); + if(noanim !== true && tm.animate){ + el.fadeOut({callback: afterHide}); + }else{ + afterHide(); + } + } + }; + + var afterHide = function(){ + el.hide(); + if(removeCls){ + el.removeClass(removeCls); + removeCls = null; + } + }; + + return { + /** + * @cfg {Number} minWidth + * The minimum width of the quick tip (defaults to 40) + */ + minWidth : 40, + /** + * @cfg {Number} maxWidth + * The maximum width of the quick tip (defaults to 300) + */ + maxWidth : 300, + /** + * @cfg {Boolean} interceptTitles + * True to automatically use the element's DOM title value if available (defaults to false) + */ + interceptTitles : false, + /** + * @cfg {Boolean} trackMouse + * True to have the quick tip follow the mouse as it moves over the target element (defaults to false) + */ + trackMouse : false, + /** + * @cfg {Boolean} hideOnClick + * True to hide the quick tip if the user clicks anywhere in the document (defaults to true) + */ + hideOnClick : true, + /** + * @cfg {Number} showDelay + * Delay in milliseconds before the quick tip displays after the mouse enters the target element (defaults to 500) + */ + showDelay : 500, + /** + * @cfg {Number} hideDelay + * Delay in milliseconds before the quick tip hides when autoHide = true (defaults to 200) + */ + hideDelay : 200, + /** + * @cfg {Boolean} autoHide + * True to automatically hide the quick tip after the mouse exits the target element (defaults to true). + * Used in conjunction with hideDelay. + */ + autoHide : true, + /** + * @cfg {Boolean} + * True to automatically hide the quick tip after a set period of time, regardless of the user's actions + * (defaults to true). Used in conjunction with autoDismissDelay. + */ + autoDismiss : true, + /** + * @cfg {Number} + * Delay in milliseconds before the quick tip hides when autoDismiss = true (defaults to 5000) + */ + autoDismissDelay : 5000, + /** + * @cfg {Boolean} animate + * True to turn on fade animation. Defaults to false (ClearType/scrollbar flicker issues in IE7). + */ + animate : false, + + /** + * @cfg {String} title + * Title text to display (defaults to ''). This can be any valid HTML markup. + */ + title: '', + /** + * @cfg {String} text + * Body text to display (defaults to ''). This can be any valid HTML markup. + */ + text : '', + /** + * @cfg {String} cls + * A CSS class to apply to the base quick tip element (defaults to ''). + */ + cls : '', + /** + * @cfg {Number} width + * Width in pixels of the quick tip (defaults to auto). Width will be ignored if it exceeds the bounds of + * minWidth or maxWidth. + */ + width : null, + + /** + * Initialize and enable QuickTips for first use. This should be called once before the first attempt to access + * or display QuickTips in a page. + */ + init : function(){ + tm = Roo.QuickTips; + cfg = tm.tagConfig; + if(!inited){ + if(!Roo.isReady){ // allow calling of init() before onReady + Roo.onReady(Roo.QuickTips.init, Roo.QuickTips); + return; + } + el = new Roo.Layer({cls:"x-tip", shadow:"drop", shim: true, constrain:true, shadowOffset:4}); + el.fxDefaults = {stopFx: true}; + // maximum custom styling + //el.update('<div class="x-tip-top-left"><div class="x-tip-top-right"><div class="x-tip-top"></div></div></div><div class="x-tip-bd-left"><div class="x-tip-bd-right"><div class="x-tip-bd"><div class="x-tip-close"></div><h3></h3><div class="x-tip-bd-inner"></div><div class="x-clear"></div></div></div></div><div class="x-tip-ft-left"><div class="x-tip-ft-right"><div class="x-tip-ft"></div></div></div>'); + el.update('<div class="x-tip-bd"><div class="x-tip-close"></div><h3></h3><div class="x-tip-bd-inner"></div><div class="x-clear"></div></div>'); + tipTitle = el.child('h3'); + tipTitle.enableDisplayMode("block"); + tipBody = el.child('div.x-tip-bd'); + tipBodyText = el.child('div.x-tip-bd-inner'); + //bdLeft = el.child('div.x-tip-bd-left'); + //bdRight = el.child('div.x-tip-bd-right'); + close = el.child('div.x-tip-close'); + close.enableDisplayMode("block"); + close.on("click", hide); + var d = Roo.get(document); + d.on("mousedown", onDown); + d.on("mouseover", onOver); + d.on("mouseout", onOut); + d.on("mousemove", onMove); + esc = d.addKeyListener(27, hide); + esc.disable(); + if(Roo.dd.DD){ + dd = el.initDD("default", null, { + onDrag : function(){ + el.sync(); + } + }); + dd.setHandleElId(tipTitle.id); + dd.lock(); + } + inited = true; + } + this.enable(); + }, + + /** + * Configures a new quick tip instance and assigns it to a target element. The following config options + * are supported: + * <pre> +Property Type Description +---------- --------------------- ------------------------------------------------------------------------ +target Element/String/Array An Element, id or array of ids that this quick tip should be tied to + * </ul> + * @param {Object} config The config object + */ + register : function(config){ + var cs = config instanceof Array ? config : arguments; + for(var i = 0, len = cs.length; i < len; i++) { + var c = cs[i]; + var target = c.target; + if(target){ + if(target instanceof Array){ + for(var j = 0, jlen = target.length; j < jlen; j++){ + tagEls[target[j]] = c; + } + }else{ + tagEls[typeof target == 'string' ? target : Roo.id(target)] = c; + } + } + } + }, + + /** + * Removes this quick tip from its element and destroys it. + * @param {String/HTMLElement/Element} el The element from which the quick tip is to be removed. + */ + unregister : function(el){ + delete tagEls[Roo.id(el)]; + }, + + /** + * Enable this quick tip. + */ + enable : function(){ + if(inited && disabled){ + locks.pop(); + if(locks.length < 1){ + disabled = false; + } + } + }, + + /** + * Disable this quick tip. + */ + disable : function(){ + disabled = true; + clearTimeout(showProc); + clearTimeout(hideProc); + clearTimeout(dismissProc); + if(ce){ + hide(true); + } + locks.push(1); + }, + + /** + * Returns true if the quick tip is enabled, else false. + */ + isEnabled : function(){ + return !disabled; + }, + + // private + tagConfig : { + namespace : "roo", // was ext?? this may break.. + alt_namespace : "ext", + attribute : "qtip", + width : "width", + target : "target", + title : "qtitle", + hide : "hide", + cls : "qclass" + } + }; +}(); + +// backwards compat +Roo.QuickTips.tips = Roo.QuickTips.register; \ No newline at end of file diff --git a/docs2/src/Roo_ReaderLayout.js.html b/docs2/src/Roo_ReaderLayout.js.html new file mode 100644 index 0000000000..3ab7ab7ba0 --- /dev/null +++ b/docs2/src/Roo_ReaderLayout.js.html @@ -0,0 +1,109 @@ +/home/alan/gitlive/roojs1/Roo/ReaderLayout.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.ReaderLayout + * @extends Roo.BorderLayout + * This is a pre-built layout that represents a classic, 5-pane application. It consists of a header, a primary + * center region containing two nested regions (a top one for a list view and one for item preview below), + * and regions on either side that can be used for navigation, application commands, informational displays, etc. + * The setup and configuration work exactly the same as it does for a {@link Roo.BorderLayout} - this class simply + * expedites the setup of the overall layout and regions for this common application style. + * Example: + <pre><code> +var reader = new Roo.ReaderLayout(); +var CP = Roo.ContentPanel; // shortcut for adding + +reader.beginUpdate(); +reader.add("north", new CP("north", "North")); +reader.add("west", new CP("west", {title: "West"})); +reader.add("east", new CP("east", {title: "East"})); + +reader.regions.listView.add(new CP("listView", "List")); +reader.regions.preview.add(new CP("preview", "Preview")); +reader.endUpdate(); +</code></pre> +* @constructor +* Create a new ReaderLayout +* @param {Object} config Configuration options +* @param {String/HTMLElement/Element} container (optional) The container this layout is bound to (defaults to +* document.body if omitted) +*/ +Roo.ReaderLayout = function(config, renderTo){ + var c = config || {size:{}}; + Roo.ReaderLayout.superclass.constructor.call(this, renderTo || document.body, { + north: c.north !== false ? Roo.apply({ + split:false, + initialSize: 32, + titlebar: false + }, c.north) : false, + west: c.west !== false ? Roo.apply({ + split:true, + initialSize: 200, + minSize: 175, + maxSize: 400, + titlebar: true, + collapsible: true, + animate: true, + margins:{left:5,right:0,bottom:5,top:5}, + cmargins:{left:5,right:5,bottom:5,top:5} + }, c.west) : false, + east: c.east !== false ? Roo.apply({ + split:true, + initialSize: 200, + minSize: 175, + maxSize: 400, + titlebar: true, + collapsible: true, + animate: true, + margins:{left:0,right:5,bottom:5,top:5}, + cmargins:{left:5,right:5,bottom:5,top:5} + }, c.east) : false, + center: Roo.apply({ + tabPosition: 'top', + autoScroll:false, + closeOnTab: true, + titlebar:false, + margins:{left:c.west!==false ? 0 : 5,right:c.east!==false ? 0 : 5,bottom:5,top:2} + }, c.center) + }); + + this.el.addClass('x-reader'); + + this.beginUpdate(); + + var inner = new Roo.BorderLayout(Roo.get(document.body).createChild(), { + south: c.preview !== false ? Roo.apply({ + split:true, + initialSize: 200, + minSize: 100, + autoScroll:true, + collapsible:true, + titlebar: true, + cmargins:{top:5,left:0, right:0, bottom:0} + }, c.preview) : false, + center: Roo.apply({ + autoScroll:false, + titlebar:false, + minHeight:200 + }, c.listView) + }); + this.add('center', new Roo.NestedLayoutPanel(inner, + Roo.apply({title: c.mainTitle || '',tabTip:''},c.innerPanelCfg))); + + this.endUpdate(); + + this.regions.preview = inner.getRegion('south'); + this.regions.listView = inner.getRegion('center'); +}; + +Roo.extend(Roo.ReaderLayout, Roo.BorderLayout); \ No newline at end of file diff --git a/docs2/src/Roo_Resizable.js.html b/docs2/src/Roo_Resizable.js.html new file mode 100644 index 0000000000..9b2523e38c --- /dev/null +++ b/docs2/src/Roo_Resizable.js.html @@ -0,0 +1,685 @@ +/home/alan/gitlive/roojs1/Roo/Resizable.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.Resizable + * @extends Roo.util.Observable + * <p>Applies drag handles to an element to make it resizable. The drag handles are inserted into the element + * and positioned absolute. Some elements, such as a textarea or image, don't support this. To overcome that, you can wrap + * the textarea in a div and set "resizeChild" to true (or to the id of the element), <b>or</b> set wrap:true in your config and + * the element will be wrapped for you automatically.</p> + * <p>Here is the list of valid resize handles:</p> + * <pre> +Value Description +------ ------------------- + 'n' north + 's' south + 'e' east + 'w' west + 'nw' northwest + 'sw' southwest + 'se' southeast + 'ne' northeast + 'hd' horizontal drag + 'all' all +</pre> + * <p>Here's an example showing the creation of a typical Resizable:</p> + * <pre><code> +var resizer = new Roo.Resizable("element-id", { + handles: 'all', + minWidth: 200, + minHeight: 100, + maxWidth: 500, + maxHeight: 400, + pinned: true +}); +resizer.on("resize", myHandler); +</code></pre> + * <p>To hide a particular handle, set its display to none in CSS, or through script:<br> + * resizer.east.setDisplayed(false);</p> + * @cfg {Boolean/String/Element} resizeChild True to resize the first child, or id/element to resize (defaults to false) + * @cfg {Array/String} adjustments String "auto" or an array [width, height] with values to be <b>added</b> to the + * resize operation's new size (defaults to [0, 0]) + * @cfg {Number} minWidth The minimum width for the element (defaults to 5) + * @cfg {Number} minHeight The minimum height for the element (defaults to 5) + * @cfg {Number} maxWidth The maximum width for the element (defaults to 10000) + * @cfg {Number} maxHeight The maximum height for the element (defaults to 10000) + * @cfg {Boolean} enabled False to disable resizing (defaults to true) + * @cfg {Boolean} wrap True to wrap an element with a div if needed (required for textareas and images, defaults to false) + * @cfg {Number} width The width of the element in pixels (defaults to null) + * @cfg {Number} height The height of the element in pixels (defaults to null) + * @cfg {Boolean} animate True to animate the resize (not compatible with dynamic sizing, defaults to false) + * @cfg {Number} duration Animation duration if animate = true (defaults to .35) + * @cfg {Boolean} dynamic True to resize the element while dragging instead of using a proxy (defaults to false) + * @cfg {String} handles String consisting of the resize handles to display (defaults to undefined) + * @cfg {Boolean} multiDirectional <b>Deprecated</b>. The old style of adding multi-direction resize handles, deprecated + * in favor of the handles config option (defaults to false) + * @cfg {Boolean} disableTrackOver True to disable mouse tracking. This is only applied at config time. (defaults to false) + * @cfg {String} easing Animation easing if animate = true (defaults to 'easingOutStrong') + * @cfg {Number} widthIncrement The increment to snap the width resize in pixels (dynamic must be true, defaults to 0) + * @cfg {Number} heightIncrement The increment to snap the height resize in pixels (dynamic must be true, defaults to 0) + * @cfg {Boolean} pinned True to ensure that the resize handles are always visible, false to display them only when the + * user mouses over the resizable borders. This is only applied at config time. (defaults to false) + * @cfg {Boolean} preserveRatio True to preserve the original ratio between height and width during resize (defaults to false) + * @cfg {Boolean} transparent True for transparent handles. This is only applied at config time. (defaults to false) + * @cfg {Number} minX The minimum allowed page X for the element (only used for west resizing, defaults to 0) + * @cfg {Number} minY The minimum allowed page Y for the element (only used for north resizing, defaults to 0) + * @cfg {Boolean} draggable Convenience to initialize drag drop (defaults to false) + * @constructor + * Create a new resizable component + * @param {String/HTMLElement/Roo.Element} el The id or element to resize + * @param {Object} config configuration options + */ +Roo.Resizable = function(el, config) +{ + this.el = Roo.get(el); + + if(config && config.wrap){ + config.resizeChild = this.el; + this.el = this.el.wrap(typeof config.wrap == "object" ? config.wrap : {cls:"xresizable-wrap"}); + this.el.id = this.el.dom.id = config.resizeChild.id + "-rzwrap"; + this.el.setStyle("overflow", "hidden"); + this.el.setPositioning(config.resizeChild.getPositioning()); + config.resizeChild.clearPositioning(); + if(!config.width || !config.height){ + var csize = config.resizeChild.getSize(); + this.el.setSize(csize.width, csize.height); + } + if(config.pinned && !config.adjustments){ + config.adjustments = "auto"; + } + } + + this.proxy = this.el.createProxy({tag: "div", cls: "x-resizable-proxy", id: this.el.id + "-rzproxy"}); + this.proxy.unselectable(); + this.proxy.enableDisplayMode('block'); + + Roo.apply(this, config); + + if(this.pinned){ + this.disableTrackOver = true; + this.el.addClass("x-resizable-pinned"); + } + // if the element isn't positioned, make it relative + var position = this.el.getStyle("position"); + if(position != "absolute" && position != "fixed"){ + this.el.setStyle("position", "relative"); + } + if(!this.handles){ // no handles passed, must be legacy style + this.handles = 's,e,se'; + if(this.multiDirectional){ + this.handles += ',n,w'; + } + } + if(this.handles == "all"){ + this.handles = "n s e w ne nw se sw"; + } + var hs = this.handles.split(/\s*?[,;]\s*?| /); + var ps = Roo.Resizable.positions; + for(var i = 0, len = hs.length; i < len; i++){ + if(hs[i] && ps[hs[i]]){ + var pos = ps[hs[i]]; + this[pos] = new Roo.Resizable.Handle(this, pos, this.disableTrackOver, this.transparent); + } + } + // legacy + this.corner = this.southeast; + + // updateBox = the box can move.. + if(this.handles.indexOf("n") != -1 || this.handles.indexOf("w") != -1 || this.handles.indexOf("hd") != -1) { + this.updateBox = true; + } + + this.activeHandle = null; + + if(this.resizeChild){ + if(typeof this.resizeChild == "boolean"){ + this.resizeChild = Roo.get(this.el.dom.firstChild, true); + }else{ + this.resizeChild = Roo.get(this.resizeChild, true); + } + } + + if(this.adjustments == "auto"){ + var rc = this.resizeChild; + var hw = this.west, he = this.east, hn = this.north, hs = this.south; + if(rc && (hw || hn)){ + rc.position("relative"); + rc.setLeft(hw ? hw.el.getWidth() : 0); + rc.setTop(hn ? hn.el.getHeight() : 0); + } + this.adjustments = [ + (he ? -he.el.getWidth() : 0) + (hw ? -hw.el.getWidth() : 0), + (hn ? -hn.el.getHeight() : 0) + (hs ? -hs.el.getHeight() : 0) -1 + ]; + } + + if(this.draggable){ + this.dd = this.dynamic ? + this.el.initDD(null) : this.el.initDDProxy(null, {dragElId: this.proxy.id}); + this.dd.setHandleElId(this.resizeChild ? this.resizeChild.id : this.el.id); + } + + // public events + this.addEvents({ + /** + * @event beforeresize + * Fired before resize is allowed. Set enabled to false to cancel resize. + * @param {Roo.Resizable} this + * @param {Roo.EventObject} e The mousedown event + */ + "beforeresize" : true, + /** + * @event resizing + * Fired a resizing. + * @param {Roo.Resizable} this + * @param {Number} x The new x position + * @param {Number} y The new y position + * @param {Number} w The new w width + * @param {Number} h The new h hight + * @param {Roo.EventObject} e The mouseup event + */ + "resizing" : true, + /** + * @event resize + * Fired after a resize. + * @param {Roo.Resizable} this + * @param {Number} width The new width + * @param {Number} height The new height + * @param {Roo.EventObject} e The mouseup event + */ + "resize" : true + }); + + if(this.width !== null && this.height !== null){ + this.resizeTo(this.width, this.height); + }else{ + this.updateChildSize(); + } + if(Roo.isIE){ + this.el.dom.style.zoom = 1; + } + Roo.Resizable.superclass.constructor.call(this); +}; + +Roo.extend(Roo.Resizable, Roo.util.Observable, { + resizeChild : false, + adjustments : [0, 0], + minWidth : 5, + minHeight : 5, + maxWidth : 10000, + maxHeight : 10000, + enabled : true, + animate : false, + duration : .35, + dynamic : false, + handles : false, + multiDirectional : false, + disableTrackOver : false, + easing : 'easeOutStrong', + widthIncrement : 0, + heightIncrement : 0, + pinned : false, + width : null, + height : null, + preserveRatio : false, + transparent: false, + minX: 0, + minY: 0, + draggable: false, + + /** + * @cfg {String/HTMLElement/Element} constrainTo Constrain the resize to a particular element + */ + constrainTo: undefined, + /** + * @cfg {Roo.lib.Region} resizeRegion Constrain the resize to a particular region + */ + resizeRegion: undefined, + + + /** + * Perform a manual resize + * @param {Number} width + * @param {Number} height + */ + resizeTo : function(width, height){ + this.el.setSize(width, height); + this.updateChildSize(); + this.fireEvent("resize", this, width, height, null); + }, + + // private + startSizing : function(e, handle){ + this.fireEvent("beforeresize", this, e); + if(this.enabled){ // 2nd enabled check in case disabled before beforeresize handler + + if(!this.overlay){ + this.overlay = this.el.createProxy({tag: "div", cls: "x-resizable-overlay", html: "&#160;"}); + this.overlay.unselectable(); + this.overlay.enableDisplayMode("block"); + this.overlay.on("mousemove", this.onMouseMove, this); + this.overlay.on("mouseup", this.onMouseUp, this); + } + this.overlay.setStyle("cursor", handle.el.getStyle("cursor")); + + this.resizing = true; + this.startBox = this.el.getBox(); + this.startPoint = e.getXY(); + this.offsets = [(this.startBox.x + this.startBox.width) - this.startPoint[0], + (this.startBox.y + this.startBox.height) - this.startPoint[1]]; + + this.overlay.setSize(Roo.lib.Dom.getViewWidth(true), Roo.lib.Dom.getViewHeight(true)); + this.overlay.show(); + + if(this.constrainTo) { + var ct = Roo.get(this.constrainTo); + this.resizeRegion = ct.getRegion().adjust( + ct.getFrameWidth('t'), + ct.getFrameWidth('l'), + -ct.getFrameWidth('b'), + -ct.getFrameWidth('r') + ); + } + + this.proxy.setStyle('visibility', 'hidden'); // workaround display none + this.proxy.show(); + this.proxy.setBox(this.startBox); + if(!this.dynamic){ + this.proxy.setStyle('visibility', 'visible'); + } + } + }, + + // private + onMouseDown : function(handle, e){ + if(this.enabled){ + e.stopEvent(); + this.activeHandle = handle; + this.startSizing(e, handle); + } + }, + + // private + onMouseUp : function(e){ + var size = this.resizeElement(); + this.resizing = false; + this.handleOut(); + this.overlay.hide(); + this.proxy.hide(); + this.fireEvent("resize", this, size.width, size.height, e); + }, + + // private + updateChildSize : function(){ + + if(this.resizeChild){ + var el = this.el; + var child = this.resizeChild; + var adj = this.adjustments; + if(el.dom.offsetWidth){ + var b = el.getSize(true); + child.setSize(b.width+adj[0], b.height+adj[1]); + } + // Second call here for IE + // The first call enables instant resizing and + // the second call corrects scroll bars if they + // exist + if(Roo.isIE){ + setTimeout(function(){ + if(el.dom.offsetWidth){ + var b = el.getSize(true); + child.setSize(b.width+adj[0], b.height+adj[1]); + } + }, 10); + } + } + }, + + // private + snap : function(value, inc, min){ + if(!inc || !value) { + return value; + } + var newValue = value; + var m = value % inc; + if(m > 0){ + if(m > (inc/2)){ + newValue = value + (inc-m); + }else{ + newValue = value - m; + } + } + return Math.max(min, newValue); + }, + + // private + resizeElement : function(){ + var box = this.proxy.getBox(); + if(this.updateBox){ + this.el.setBox(box, false, this.animate, this.duration, null, this.easing); + }else{ + this.el.setSize(box.width, box.height, this.animate, this.duration, null, this.easing); + } + this.updateChildSize(); + if(!this.dynamic){ + this.proxy.hide(); + } + return box; + }, + + // private + constrain : function(v, diff, m, mx){ + if(v - diff < m){ + diff = v - m; + }else if(v - diff > mx){ + diff = mx - v; + } + return diff; + }, + + // private + onMouseMove : function(e){ + + if(this.enabled){ + try{// try catch so if something goes wrong the user doesn't get hung + + if(this.resizeRegion && !this.resizeRegion.contains(e.getPoint())) { + return; + } + + //var curXY = this.startPoint; + var curSize = this.curSize || this.startBox; + var x = this.startBox.x, y = this.startBox.y; + var ox = x, oy = y; + var w = curSize.width, h = curSize.height; + var ow = w, oh = h; + var mw = this.minWidth, mh = this.minHeight; + var mxw = this.maxWidth, mxh = this.maxHeight; + var wi = this.widthIncrement; + var hi = this.heightIncrement; + + var eventXY = e.getXY(); + var diffX = -(this.startPoint[0] - Math.max(this.minX, eventXY[0])); + var diffY = -(this.startPoint[1] - Math.max(this.minY, eventXY[1])); + + var pos = this.activeHandle.position; + + switch(pos){ + case "east": + w += diffX; + w = Math.min(Math.max(mw, w), mxw); + break; + + case "south": + h += diffY; + h = Math.min(Math.max(mh, h), mxh); + break; + case "southeast": + w += diffX; + h += diffY; + w = Math.min(Math.max(mw, w), mxw); + h = Math.min(Math.max(mh, h), mxh); + break; + case "north": + diffY = this.constrain(h, diffY, mh, mxh); + y += diffY; + h -= diffY; + break; + case "hdrag": + + if (wi) { + var adiffX = Math.abs(diffX); + var sub = (adiffX % wi); // how much + if (sub > (wi/2)) { // far enough to snap + diffX = (diffX > 0) ? diffX-sub + wi : diffX+sub - wi; + } else { + // remove difference.. + diffX = (diffX > 0) ? diffX-sub : diffX+sub; + } + } + x += diffX; + x = Math.max(this.minX, x); + break; + case "west": + diffX = this.constrain(w, diffX, mw, mxw); + x += diffX; + w -= diffX; + break; + case "northeast": + w += diffX; + w = Math.min(Math.max(mw, w), mxw); + diffY = this.constrain(h, diffY, mh, mxh); + y += diffY; + h -= diffY; + break; + case "northwest": + diffX = this.constrain(w, diffX, mw, mxw); + diffY = this.constrain(h, diffY, mh, mxh); + y += diffY; + h -= diffY; + x += diffX; + w -= diffX; + break; + case "southwest": + diffX = this.constrain(w, diffX, mw, mxw); + h += diffY; + h = Math.min(Math.max(mh, h), mxh); + x += diffX; + w -= diffX; + break; + } + + var sw = this.snap(w, wi, mw); + var sh = this.snap(h, hi, mh); + if(sw != w || sh != h){ + switch(pos){ + case "northeast": + y -= sh - h; + break; + case "north": + y -= sh - h; + break; + case "southwest": + x -= sw - w; + break; + case "west": + x -= sw - w; + break; + case "northwest": + x -= sw - w; + y -= sh - h; + break; + } + w = sw; + h = sh; + } + + if(this.preserveRatio){ + switch(pos){ + case "southeast": + case "east": + h = oh * (w/ow); + h = Math.min(Math.max(mh, h), mxh); + w = ow * (h/oh); + break; + case "south": + w = ow * (h/oh); + w = Math.min(Math.max(mw, w), mxw); + h = oh * (w/ow); + break; + case "northeast": + w = ow * (h/oh); + w = Math.min(Math.max(mw, w), mxw); + h = oh * (w/ow); + break; + case "north": + var tw = w; + w = ow * (h/oh); + w = Math.min(Math.max(mw, w), mxw); + h = oh * (w/ow); + x += (tw - w) / 2; + break; + case "southwest": + h = oh * (w/ow); + h = Math.min(Math.max(mh, h), mxh); + var tw = w; + w = ow * (h/oh); + x += tw - w; + break; + case "west": + var th = h; + h = oh * (w/ow); + h = Math.min(Math.max(mh, h), mxh); + y += (th - h) / 2; + var tw = w; + w = ow * (h/oh); + x += tw - w; + break; + case "northwest": + var tw = w; + var th = h; + h = oh * (w/ow); + h = Math.min(Math.max(mh, h), mxh); + w = ow * (h/oh); + y += th - h; + x += tw - w; + break; + + } + } + if (pos == 'hdrag') { + w = ow; + } + this.proxy.setBounds(x, y, w, h); + if(this.dynamic){ + this.resizeElement(); + } + }catch(e){} + } + this.fireEvent("resizing", this, x, y, w, h, e); + }, + + // private + handleOver : function(){ + if(this.enabled){ + this.el.addClass("x-resizable-over"); + } + }, + + // private + handleOut : function(){ + if(!this.resizing){ + this.el.removeClass("x-resizable-over"); + } + }, + + /** + * Returns the element this component is bound to. + * @return {Roo.Element} + */ + getEl : function(){ + return this.el; + }, + + /** + * Returns the resizeChild element (or null). + * @return {Roo.Element} + */ + getResizeChild : function(){ + return this.resizeChild; + }, + groupHandler : function() + { + + }, + /** + * Destroys this resizable. If the element was wrapped and + * removeEl is not true then the element remains. + * @param {Boolean} removeEl (optional) true to remove the element from the DOM + */ + destroy : function(removeEl){ + this.proxy.remove(); + if(this.overlay){ + this.overlay.removeAllListeners(); + this.overlay.remove(); + } + var ps = Roo.Resizable.positions; + for(var k in ps){ + if(typeof ps[k] != "function" && this[ps[k]]){ + var h = this[ps[k]]; + h.el.removeAllListeners(); + h.el.remove(); + } + } + if(removeEl){ + this.el.update(""); + this.el.remove(); + } + } +}); + +// private +// hash to map config positions to true positions +Roo.Resizable.positions = { + n: "north", s: "south", e: "east", w: "west", se: "southeast", sw: "southwest", nw: "northwest", ne: "northeast", + hd: "hdrag" +}; + +// private +Roo.Resizable.Handle = function(rz, pos, disableTrackOver, transparent){ + if(!this.tpl){ + // only initialize the template if resizable is used + var tpl = Roo.DomHelper.createTemplate( + {tag: "div", cls: "x-resizable-handle x-resizable-handle-{0}"} + ); + tpl.compile(); + Roo.Resizable.Handle.prototype.tpl = tpl; + } + this.position = pos; + this.rz = rz; + // show north drag fro topdra + var handlepos = pos == 'hdrag' ? 'north' : pos; + + this.el = this.tpl.append(rz.el.dom, [handlepos], true); + if (pos == 'hdrag') { + this.el.setStyle('cursor', 'pointer'); + } + this.el.unselectable(); + if(transparent){ + this.el.setOpacity(0); + } + this.el.on("mousedown", this.onMouseDown, this); + if(!disableTrackOver){ + this.el.on("mouseover", this.onMouseOver, this); + this.el.on("mouseout", this.onMouseOut, this); + } +}; + +// private +Roo.Resizable.Handle.prototype = { + afterResize : function(rz){ + Roo.log('after?'); + // do nothing + }, + // private + onMouseDown : function(e){ + this.rz.onMouseDown(this, e); + }, + // private + onMouseOver : function(e){ + this.rz.handleOver(this, e); + }, + // private + onMouseOut : function(e){ + this.rz.handleOut(this, e); + } +}; \ No newline at end of file diff --git a/docs2/src/Roo_Shadow.js.html b/docs2/src/Roo_Shadow.js.html new file mode 100644 index 0000000000..6cdd18f8e7 --- /dev/null +++ b/docs2/src/Roo_Shadow.js.html @@ -0,0 +1,198 @@ +/home/alan/gitlive/roojs1/Roo/Shadow.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.Shadow + * Simple class that can provide a shadow effect for any element. Note that the element MUST be absolutely positioned, + * and the shadow does not provide any shimming. This should be used only in simple cases -- for more advanced + * functionality that can also provide the same shadow effect, see the {@link Roo.Layer} class. + * @constructor + * Create a new Shadow + * @param {Object} config The config object + */ +Roo.Shadow = function(config){ + Roo.apply(this, config); + if(typeof this.mode != "string"){ + this.mode = this.defaultMode; + } + var o = this.offset, a = {h: 0}; + var rad = Math.floor(this.offset/2); + switch(this.mode.toLowerCase()){ // all this hideous nonsense calculates the various offsets for shadows + case "drop": + a.w = 0; + a.l = a.t = o; + a.t -= 1; + if(Roo.isIE){ + a.l -= this.offset + rad; + a.t -= this.offset + rad; + a.w -= rad; + a.h -= rad; + a.t += 1; + } + break; + case "sides": + a.w = (o*2); + a.l = -o; + a.t = o-1; + if(Roo.isIE){ + a.l -= (this.offset - rad); + a.t -= this.offset + rad; + a.l += 1; + a.w -= (this.offset - rad)*2; + a.w -= rad + 1; + a.h -= 1; + } + break; + case "frame": + a.w = a.h = (o*2); + a.l = a.t = -o; + a.t += 1; + a.h -= 2; + if(Roo.isIE){ + a.l -= (this.offset - rad); + a.t -= (this.offset - rad); + a.l += 1; + a.w -= (this.offset + rad + 1); + a.h -= (this.offset + rad); + a.h += 1; + } + break; + }; + + this.adjusts = a; +}; + +Roo.Shadow.prototype = { + /** + * @cfg {String} mode + * The shadow display mode. Supports the following options:<br /> + * sides: Shadow displays on both sides and bottom only<br /> + * frame: Shadow displays equally on all four sides<br /> + * drop: Traditional bottom-right drop shadow (default) + */ + /** + * @cfg {String} offset + * The number of pixels to offset the shadow from the element (defaults to 4) + */ + offset: 4, + + // private + defaultMode: "drop", + + /** + * Displays the shadow under the target element + * @param {String/HTMLElement/Element} targetEl The id or element under which the shadow should display + */ + show : function(target){ + target = Roo.get(target); + if(!this.el){ + this.el = Roo.Shadow.Pool.pull(); + if(this.el.dom.nextSibling != target.dom){ + this.el.insertBefore(target); + } + } + this.el.setStyle("z-index", this.zIndex || parseInt(target.getStyle("z-index"), 10)-1); + if(Roo.isIE){ + this.el.dom.style.filter="progid:DXImageTransform.Microsoft.alpha(opacity=50) progid:DXImageTransform.Microsoft.Blur(pixelradius="+(this.offset)+")"; + } + this.realign( + target.getLeft(true), + target.getTop(true), + target.getWidth(), + target.getHeight() + ); + this.el.dom.style.display = "block"; + }, + + /** + * Returns true if the shadow is visible, else false + */ + isVisible : function(){ + return this.el ? true : false; + }, + + /** + * Direct alignment when values are already available. Show must be called at least once before + * calling this method to ensure it is initialized. + * @param {Number} left The target element left position + * @param {Number} top The target element top position + * @param {Number} width The target element width + * @param {Number} height The target element height + */ + realign : function(l, t, w, h){ + if(!this.el){ + return; + } + var a = this.adjusts, d = this.el.dom, s = d.style; + var iea = 0; + s.left = (l+a.l)+"px"; + s.top = (t+a.t)+"px"; + var sw = (w+a.w), sh = (h+a.h), sws = sw +"px", shs = sh + "px"; + + if(s.width != sws || s.height != shs){ + s.width = sws; + s.height = shs; + if(!Roo.isIE){ + var cn = d.childNodes; + var sww = Math.max(0, (sw-12))+"px"; + cn[0].childNodes[1].style.width = sww; + cn[1].childNodes[1].style.width = sww; + cn[2].childNodes[1].style.width = sww; + cn[1].style.height = Math.max(0, (sh-12))+"px"; + } + } + }, + + /** + * Hides this shadow + */ + hide : function(){ + if(this.el){ + this.el.dom.style.display = "none"; + Roo.Shadow.Pool.push(this.el); + delete this.el; + } + }, + + /** + * Adjust the z-index of this shadow + * @param {Number} zindex The new z-index + */ + setZIndex : function(z){ + this.zIndex = z; + if(this.el){ + this.el.setStyle("z-index", z); + } + } +}; + +// Private utility class that manages the internal Shadow cache +Roo.Shadow.Pool = function(){ + var p = []; + var markup = Roo.isIE ? + '<div class="x-ie-shadow"></div>' : + '<div class="x-shadow"><div class="xst"><div class="xstl"></div><div class="xstc"></div><div class="xstr"></div></div><div class="xsc"><div class="xsml"></div><div class="xsmc"></div><div class="xsmr"></div></div><div class="xsb"><div class="xsbl"></div><div class="xsbc"></div><div class="xsbr"></div></div></div>'; + return { + pull : function(){ + var sh = p.shift(); + if(!sh){ + sh = Roo.get(Roo.DomHelper.insertHtml("beforeBegin", document.body.firstChild, markup)); + sh.autoBoxAdjust = false; + } + return sh; + }, + + push : function(sh){ + p.push(sh); + } + }; +}(); \ No newline at end of file diff --git a/docs2/src/Roo_SplitBar.js.html b/docs2/src/Roo_SplitBar.js.html new file mode 100644 index 0000000000..9a79fb23ac --- /dev/null +++ b/docs2/src/Roo_SplitBar.js.html @@ -0,0 +1,442 @@ +/home/alan/gitlive/roojs1/Roo/SplitBar.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.SplitBar + * @extends Roo.util.Observable + * Creates draggable splitter bar functionality from two elements (element to be dragged and element to be resized). + * <br><br> + * Usage: + * <pre><code> +var split = new Roo.SplitBar("elementToDrag", "elementToSize", + Roo.SplitBar.HORIZONTAL, Roo.SplitBar.LEFT); +split.setAdapter(new Roo.SplitBar.AbsoluteLayoutAdapter("container")); +split.minSize = 100; +split.maxSize = 600; +split.animate = true; +split.on('moved', splitterMoved); +</code></pre> + * @constructor + * Create a new SplitBar + * @param {String/HTMLElement/Roo.Element} dragElement The element to be dragged and act as the SplitBar. + * @param {String/HTMLElement/Roo.Element} resizingElement The element to be resized based on where the SplitBar element is dragged + * @param {Number} orientation (optional) Either Roo.SplitBar.HORIZONTAL or Roo.SplitBar.VERTICAL. (Defaults to HORIZONTAL) + * @param {Number} placement (optional) Either Roo.SplitBar.LEFT or Roo.SplitBar.RIGHT for horizontal or + Roo.SplitBar.TOP or Roo.SplitBar.BOTTOM for vertical. (By default, this is determined automatically by the initial + position of the SplitBar). + */ +Roo.SplitBar = function(dragElement, resizingElement, orientation, placement, existingProxy){ + + /** @private */ + this.el = Roo.get(dragElement, true); + this.el.dom.unselectable = "on"; + /** @private */ + this.resizingEl = Roo.get(resizingElement, true); + + /** + * @private + * The orientation of the split. Either Roo.SplitBar.HORIZONTAL or Roo.SplitBar.VERTICAL. (Defaults to HORIZONTAL) + * Note: If this is changed after creating the SplitBar, the placement property must be manually updated + * @type Number + */ + this.orientation = orientation || Roo.SplitBar.HORIZONTAL; + + /** + * The minimum size of the resizing element. (Defaults to 0) + * @type Number + */ + this.minSize = 0; + + /** + * The maximum size of the resizing element. (Defaults to 2000) + * @type Number + */ + this.maxSize = 2000; + + /** + * Whether to animate the transition to the new size + * @type Boolean + */ + this.animate = false; + + /** + * Whether to create a transparent shim that overlays the page when dragging, enables dragging across iframes. + * @type Boolean + */ + this.useShim = false; + + /** @private */ + this.shim = null; + + if(!existingProxy){ + /** @private */ + this.proxy = Roo.SplitBar.createProxy(this.orientation); + }else{ + this.proxy = Roo.get(existingProxy).dom; + } + /** @private */ + this.dd = new Roo.dd.DDProxy(this.el.dom.id, "XSplitBars", {dragElId : this.proxy.id}); + + /** @private */ + this.dd.b4StartDrag = this.onStartProxyDrag.createDelegate(this); + + /** @private */ + this.dd.endDrag = this.onEndProxyDrag.createDelegate(this); + + /** @private */ + this.dragSpecs = {}; + + /** + * @private The adapter to use to positon and resize elements + */ + this.adapter = new Roo.SplitBar.BasicLayoutAdapter(); + this.adapter.init(this); + + if(this.orientation == Roo.SplitBar.HORIZONTAL){ + /** @private */ + this.placement = placement || (this.el.getX() > this.resizingEl.getX() ? Roo.SplitBar.LEFT : Roo.SplitBar.RIGHT); + this.el.addClass("x-splitbar-h"); + }else{ + /** @private */ + this.placement = placement || (this.el.getY() > this.resizingEl.getY() ? Roo.SplitBar.TOP : Roo.SplitBar.BOTTOM); + this.el.addClass("x-splitbar-v"); + } + + this.addEvents({ + /** + * @event resize + * Fires when the splitter is moved (alias for {@link #event-moved}) + * @param {Roo.SplitBar} this + * @param {Number} newSize the new width or height + */ + "resize" : true, + /** + * @event moved + * Fires when the splitter is moved + * @param {Roo.SplitBar} this + * @param {Number} newSize the new width or height + */ + "moved" : true, + /** + * @event beforeresize + * Fires before the splitter is dragged + * @param {Roo.SplitBar} this + */ + "beforeresize" : true, + + "beforeapply" : true + }); + + Roo.util.Observable.call(this); +}; + +Roo.extend(Roo.SplitBar, Roo.util.Observable, { + onStartProxyDrag : function(x, y){ + this.fireEvent("beforeresize", this); + if(!this.overlay){ + var o = Roo.DomHelper.insertFirst(document.body, {cls: "x-drag-overlay", html: "&#160;"}, true); + o.unselectable(); + o.enableDisplayMode("block"); + // all splitbars share the same overlay + Roo.SplitBar.prototype.overlay = o; + } + this.overlay.setSize(Roo.lib.Dom.getViewWidth(true), Roo.lib.Dom.getViewHeight(true)); + this.overlay.show(); + Roo.get(this.proxy).setDisplayed("block"); + var size = this.adapter.getElementSize(this); + this.activeMinSize = this.getMinimumSize();; + this.activeMaxSize = this.getMaximumSize();; + var c1 = size - this.activeMinSize; + var c2 = Math.max(this.activeMaxSize - size, 0); + if(this.orientation == Roo.SplitBar.HORIZONTAL){ + this.dd.resetConstraints(); + this.dd.setXConstraint( + this.placement == Roo.SplitBar.LEFT ? c1 : c2, + this.placement == Roo.SplitBar.LEFT ? c2 : c1 + ); + this.dd.setYConstraint(0, 0); + }else{ + this.dd.resetConstraints(); + this.dd.setXConstraint(0, 0); + this.dd.setYConstraint( + this.placement == Roo.SplitBar.TOP ? c1 : c2, + this.placement == Roo.SplitBar.TOP ? c2 : c1 + ); + } + this.dragSpecs.startSize = size; + this.dragSpecs.startPoint = [x, y]; + Roo.dd.DDProxy.prototype.b4StartDrag.call(this.dd, x, y); + }, + + /** + * @private Called after the drag operation by the DDProxy + */ + onEndProxyDrag : function(e){ + Roo.get(this.proxy).setDisplayed(false); + var endPoint = Roo.lib.Event.getXY(e); + if(this.overlay){ + this.overlay.hide(); + } + var newSize; + if(this.orientation == Roo.SplitBar.HORIZONTAL){ + newSize = this.dragSpecs.startSize + + (this.placement == Roo.SplitBar.LEFT ? + endPoint[0] - this.dragSpecs.startPoint[0] : + this.dragSpecs.startPoint[0] - endPoint[0] + ); + }else{ + newSize = this.dragSpecs.startSize + + (this.placement == Roo.SplitBar.TOP ? + endPoint[1] - this.dragSpecs.startPoint[1] : + this.dragSpecs.startPoint[1] - endPoint[1] + ); + } + newSize = Math.min(Math.max(newSize, this.activeMinSize), this.activeMaxSize); + if(newSize != this.dragSpecs.startSize){ + if(this.fireEvent('beforeapply', this, newSize) !== false){ + this.adapter.setElementSize(this, newSize); + this.fireEvent("moved", this, newSize); + this.fireEvent("resize", this, newSize); + } + } + }, + + /** + * Get the adapter this SplitBar uses + * @return The adapter object + */ + getAdapter : function(){ + return this.adapter; + }, + + /** + * Set the adapter this SplitBar uses + * @param {Object} adapter A SplitBar adapter object + */ + setAdapter : function(adapter){ + this.adapter = adapter; + this.adapter.init(this); + }, + + /** + * Gets the minimum size for the resizing element + * @return {Number} The minimum size + */ + getMinimumSize : function(){ + return this.minSize; + }, + + /** + * Sets the minimum size for the resizing element + * @param {Number} minSize The minimum size + */ + setMinimumSize : function(minSize){ + this.minSize = minSize; + }, + + /** + * Gets the maximum size for the resizing element + * @return {Number} The maximum size + */ + getMaximumSize : function(){ + return this.maxSize; + }, + + /** + * Sets the maximum size for the resizing element + * @param {Number} maxSize The maximum size + */ + setMaximumSize : function(maxSize){ + this.maxSize = maxSize; + }, + + /** + * Sets the initialize size for the resizing element + * @param {Number} size The initial size + */ + setCurrentSize : function(size){ + var oldAnimate = this.animate; + this.animate = false; + this.adapter.setElementSize(this, size); + this.animate = oldAnimate; + }, + + /** + * Destroy this splitbar. + * @param {Boolean} removeEl True to remove the element + */ + destroy : function(removeEl){ + if(this.shim){ + this.shim.remove(); + } + this.dd.unreg(); + this.proxy.parentNode.removeChild(this.proxy); + if(removeEl){ + this.el.remove(); + } + } +}); + +/** + * @private static Create our own proxy element element. So it will be the same same size on all browsers, we won't use borders. Instead we use a background color. + */ +Roo.SplitBar.createProxy = function(dir){ + var proxy = new Roo.Element(document.createElement("div")); + proxy.unselectable(); + var cls = 'x-splitbar-proxy'; + proxy.addClass(cls + ' ' + (dir == Roo.SplitBar.HORIZONTAL ? cls +'-h' : cls + '-v')); + document.body.appendChild(proxy.dom); + return proxy.dom; +}; + +/** + * @class Roo.SplitBar.BasicLayoutAdapter + * Default Adapter. It assumes the splitter and resizing element are not positioned + * elements and only gets/sets the width of the element. Generally used for table based layouts. + */ +Roo.SplitBar.BasicLayoutAdapter = function(){ +}; + +Roo.SplitBar.BasicLayoutAdapter.prototype = { + // do nothing for now + init : function(s){ + + }, + /** + * Called before drag operations to get the current size of the resizing element. + * @param {Roo.SplitBar} s The SplitBar using this adapter + */ + getElementSize : function(s){ + if(s.orientation == Roo.SplitBar.HORIZONTAL){ + return s.resizingEl.getWidth(); + }else{ + return s.resizingEl.getHeight(); + } + }, + + /** + * Called after drag operations to set the size of the resizing element. + * @param {Roo.SplitBar} s The SplitBar using this adapter + * @param {Number} newSize The new size to set + * @param {Function} onComplete A function to be invoked when resizing is complete + */ + setElementSize : function(s, newSize, onComplete){ + if(s.orientation == Roo.SplitBar.HORIZONTAL){ + if(!s.animate){ + s.resizingEl.setWidth(newSize); + if(onComplete){ + onComplete(s, newSize); + } + }else{ + s.resizingEl.setWidth(newSize, true, .1, onComplete, 'easeOut'); + } + }else{ + + if(!s.animate){ + s.resizingEl.setHeight(newSize); + if(onComplete){ + onComplete(s, newSize); + } + }else{ + s.resizingEl.setHeight(newSize, true, .1, onComplete, 'easeOut'); + } + } + } +}; + +/** + *@class Roo.SplitBar.AbsoluteLayoutAdapter + * @extends Roo.SplitBar.BasicLayoutAdapter + * Adapter that moves the splitter element to align with the resized sizing element. + * Used with an absolute positioned SplitBar. + * @param {String/HTMLElement/Roo.Element} container The container that wraps around the absolute positioned content. If it's + * document.body, make sure you assign an id to the body element. + */ +Roo.SplitBar.AbsoluteLayoutAdapter = function(container){ + this.basic = new Roo.SplitBar.BasicLayoutAdapter(); + this.container = Roo.get(container); +}; + +Roo.SplitBar.AbsoluteLayoutAdapter.prototype = { + init : function(s){ + this.basic.init(s); + }, + + getElementSize : function(s){ + return this.basic.getElementSize(s); + }, + + setElementSize : function(s, newSize, onComplete){ + this.basic.setElementSize(s, newSize, this.moveSplitter.createDelegate(this, [s])); + }, + + moveSplitter : function(s){ + var yes = Roo.SplitBar; + switch(s.placement){ + case yes.LEFT: + s.el.setX(s.resizingEl.getRight()); + break; + case yes.RIGHT: + s.el.setStyle("right", (this.container.getWidth() - s.resizingEl.getLeft()) + "px"); + break; + case yes.TOP: + s.el.setY(s.resizingEl.getBottom()); + break; + case yes.BOTTOM: + s.el.setY(s.resizingEl.getTop() - s.el.getHeight()); + break; + } + } +}; + +/** + * Orientation constant - Create a vertical SplitBar + * @static + * @type Number + */ +Roo.SplitBar.VERTICAL = 1; + +/** + * Orientation constant - Create a horizontal SplitBar + * @static + * @type Number + */ +Roo.SplitBar.HORIZONTAL = 2; + +/** + * Placement constant - The resizing element is to the left of the splitter element + * @static + * @type Number + */ +Roo.SplitBar.LEFT = 1; + +/** + * Placement constant - The resizing element is to the right of the splitter element + * @static + * @type Number + */ +Roo.SplitBar.RIGHT = 2; + +/** + * Placement constant - The resizing element is positioned above the splitter element + * @static + * @type Number + */ +Roo.SplitBar.TOP = 3; + +/** + * Placement constant - The resizing element is positioned under splitter element + * @static + * @type Number + */ +Roo.SplitBar.BOTTOM = 4; + \ No newline at end of file diff --git a/docs2/src/Roo_SplitButton.js.html b/docs2/src/Roo_SplitButton.js.html new file mode 100644 index 0000000000..8131f488d6 --- /dev/null +++ b/docs2/src/Roo_SplitButton.js.html @@ -0,0 +1,194 @@ +/home/alan/gitlive/roojs1/Roo/SplitButton.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.SplitButton + * @extends Roo.Button + * A split button that provides a built-in dropdown arrow that can fire an event separately from the default + * click event of the button. Typically this would be used to display a dropdown menu that provides additional + * options to the primary button action, but any custom handler can provide the arrowclick implementation. + * @cfg {Function} arrowHandler A function called when the arrow button is clicked (can be used instead of click event) + * @cfg {String} arrowTooltip The title attribute of the arrow + * @constructor + * Create a new menu button + * @param {String/HTMLElement/Element} renderTo The element to append the button to + * @param {Object} config The config object + */ +Roo.SplitButton = function(renderTo, config){ + Roo.SplitButton.superclass.constructor.call(this, renderTo, config); + /** + * @event arrowclick + * Fires when this button's arrow is clicked + * @param {SplitButton} this + * @param {EventObject} e The click event + */ + this.addEvents({"arrowclick":true}); +}; + +Roo.extend(Roo.SplitButton, Roo.Button, { + render : function(renderTo){ + // this is one sweet looking template! + var tpl = new Roo.Template( + '<table cellspacing="0" class="x-btn-menu-wrap x-btn"><tr><td>', + '<table cellspacing="0" class="x-btn-wrap x-btn-menu-text-wrap"><tbody>', + '<tr><td class="x-btn-left"><i>&#160;</i></td><td class="x-btn-center"><button class="x-btn-text" type="{1}">{0}</button></td></tr>', + "</tbody></table></td><td>", + '<table cellspacing="0" class="x-btn-wrap x-btn-menu-arrow-wrap"><tbody>', + '<tr><td class="x-btn-center"><button class="x-btn-menu-arrow-el" type="button">&#160;</button></td><td class="x-btn-right"><i>&#160;</i></td></tr>', + "</tbody></table></td></tr></table>" + ); + var btn = tpl.append(renderTo, [this.text, this.type], true); + var btnEl = btn.child("button"); + if(this.cls){ + btn.addClass(this.cls); + } + if(this.icon){ + btnEl.setStyle('background-image', 'url(' +this.icon +')'); + } + if(this.iconCls){ + btnEl.addClass(this.iconCls); + if(!this.cls){ + btn.addClass(this.text ? 'x-btn-text-icon' : 'x-btn-icon'); + } + } + this.el = btn; + if(this.handleMouseEvents){ + btn.on("mouseover", this.onMouseOver, this); + btn.on("mouseout", this.onMouseOut, this); + btn.on("mousedown", this.onMouseDown, this); + btn.on("mouseup", this.onMouseUp, this); + } + btn.on(this.clickEvent, this.onClick, this); + if(this.tooltip){ + if(typeof this.tooltip == 'object'){ + Roo.QuickTips.tips(Roo.apply({ + target: btnEl.id + }, this.tooltip)); + } else { + btnEl.dom[this.tooltipType] = this.tooltip; + } + } + if(this.arrowTooltip){ + btn.child("button:nth(2)").dom[this.tooltipType] = this.arrowTooltip; + } + if(this.hidden){ + this.hide(); + } + if(this.disabled){ + this.disable(); + } + if(this.pressed){ + this.el.addClass("x-btn-pressed"); + } + if(Roo.isIE && !Roo.isIE7){ + this.autoWidth.defer(1, this); + }else{ + this.autoWidth(); + } + if(this.menu){ + this.menu.on("show", this.onMenuShow, this); + this.menu.on("hide", this.onMenuHide, this); + } + this.fireEvent('render', this); + }, + + // private + autoWidth : function(){ + if(this.el){ + var tbl = this.el.child("table:first"); + var tbl2 = this.el.child("table:last"); + this.el.setWidth("auto"); + tbl.setWidth("auto"); + if(Roo.isIE7 && Roo.isStrict){ + var ib = this.el.child('button:first'); + if(ib && ib.getWidth() > 20){ + ib.clip(); + ib.setWidth(Roo.util.TextMetrics.measure(ib, this.text).width+ib.getFrameWidth('lr')); + } + } + if(this.minWidth){ + if(this.hidden){ + this.el.beginMeasure(); + } + if((tbl.getWidth()+tbl2.getWidth()) < this.minWidth){ + tbl.setWidth(this.minWidth-tbl2.getWidth()); + } + if(this.hidden){ + this.el.endMeasure(); + } + } + this.el.setWidth(tbl.getWidth()+tbl2.getWidth()); + } + }, + /** + * Sets this button's click handler + * @param {Function} handler The function to call when the button is clicked + * @param {Object} scope (optional) Scope for the function passed above + */ + setHandler : function(handler, scope){ + this.handler = handler; + this.scope = scope; + }, + + /** + * Sets this button's arrow click handler + * @param {Function} handler The function to call when the arrow is clicked + * @param {Object} scope (optional) Scope for the function passed above + */ + setArrowHandler : function(handler, scope){ + this.arrowHandler = handler; + this.scope = scope; + }, + + /** + * Focus the button + */ + focus : function(){ + if(this.el){ + this.el.child("button:first").focus(); + } + }, + + // private + onClick : function(e){ + e.preventDefault(); + if(!this.disabled){ + if(e.getTarget(".x-btn-menu-arrow-wrap")){ + if(this.menu && !this.menu.isVisible()){ + this.menu.show(this.el, this.menuAlign); + } + this.fireEvent("arrowclick", this, e); + if(this.arrowHandler){ + this.arrowHandler.call(this.scope || this, this, e); + } + }else{ + this.fireEvent("click", this, e); + if(this.handler){ + this.handler.call(this.scope || this, this, e); + } + } + } + }, + // private + onMouseDown : function(e){ + if(!this.disabled){ + Roo.fly(e.getTarget("table")).addClass("x-btn-click"); + } + }, + // private + onMouseUp : function(e){ + Roo.fly(e.getTarget("table")).removeClass("x-btn-click"); + } +}); + + +// backwards compat +Roo.MenuButton = Roo.SplitButton; \ No newline at end of file diff --git a/docs2/src/Roo_SplitLayoutRegion.js.html b/docs2/src/Roo_SplitLayoutRegion.js.html new file mode 100644 index 0000000000..7e9f49b801 --- /dev/null +++ b/docs2/src/Roo_SplitLayoutRegion.js.html @@ -0,0 +1,343 @@ +/home/alan/gitlive/roojs1/Roo/SplitLayoutRegion.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + + +/** + * @class Roo.SplitLayoutRegion + * @extends Roo.LayoutRegion + * Adds a splitbar and other (private) useful functionality to a {@link Roo.LayoutRegion}. + */ +Roo.SplitLayoutRegion = function(mgr, config, pos, cursor){ + this.cursor = cursor; + Roo.SplitLayoutRegion.superclass.constructor.call(this, mgr, config, pos); +}; + +Roo.extend(Roo.SplitLayoutRegion, Roo.LayoutRegion, { + splitTip : "Drag to resize.", + collapsibleSplitTip : "Drag to resize. Double click to hide.", + useSplitTips : false, + + applyConfig : function(config){ + Roo.SplitLayoutRegion.superclass.applyConfig.call(this, config); + if(config.split){ + if(!this.split){ + var splitEl = Roo.DomHelper.append(this.mgr.el.dom, + {tag: "div", id: this.el.id + "-split", cls: "x-layout-split x-layout-split-"+this.position, html: "&#160;"}); + /** The SplitBar for this region + * @type Roo.SplitBar */ + this.split = new Roo.SplitBar(splitEl, this.el, this.orientation); + this.split.on("moved", this.onSplitMove, this); + this.split.useShim = config.useShim === true; + this.split.getMaximumSize = this[this.position == 'north' || this.position == 'south' ? 'getVMaxSize' : 'getHMaxSize'].createDelegate(this); + if(this.useSplitTips){ + this.split.el.dom.title = config.collapsible ? this.collapsibleSplitTip : this.splitTip; + } + if(config.collapsible){ + this.split.el.on("dblclick", this.collapse, this); + } + } + if(typeof config.minSize != "undefined"){ + this.split.minSize = config.minSize; + } + if(typeof config.maxSize != "undefined"){ + this.split.maxSize = config.maxSize; + } + if(config.hideWhenEmpty || config.hidden || config.collapsed){ + this.hideSplitter(); + } + } + }, + + getHMaxSize : function(){ + var cmax = this.config.maxSize || 10000; + var center = this.mgr.getRegion("center"); + return Math.min(cmax, (this.el.getWidth()+center.getEl().getWidth())-center.getMinWidth()); + }, + + getVMaxSize : function(){ + var cmax = this.config.maxSize || 10000; + var center = this.mgr.getRegion("center"); + return Math.min(cmax, (this.el.getHeight()+center.getEl().getHeight())-center.getMinHeight()); + }, + + onSplitMove : function(split, newSize){ + this.fireEvent("resized", this, newSize); + }, + + /** + * Returns the {@link Roo.SplitBar} for this region. + * @return {Roo.SplitBar} + */ + getSplitBar : function(){ + return this.split; + }, + + hide : function(){ + this.hideSplitter(); + Roo.SplitLayoutRegion.superclass.hide.call(this); + }, + + hideSplitter : function(){ + if(this.split){ + this.split.el.setLocation(-2000,-2000); + this.split.el.hide(); + } + }, + + show : function(){ + if(this.split){ + this.split.el.show(); + } + Roo.SplitLayoutRegion.superclass.show.call(this); + }, + + beforeSlide: function(){ + if(Roo.isGecko){// firefox overflow auto bug workaround + this.bodyEl.clip(); + if(this.tabs) { + this.tabs.bodyEl.clip(); + } + if(this.activePanel){ + this.activePanel.getEl().clip(); + + if(this.activePanel.beforeSlide){ + this.activePanel.beforeSlide(); + } + } + } + }, + + afterSlide : function(){ + if(Roo.isGecko){// firefox overflow auto bug workaround + this.bodyEl.unclip(); + if(this.tabs) { + this.tabs.bodyEl.unclip(); + } + if(this.activePanel){ + this.activePanel.getEl().unclip(); + if(this.activePanel.afterSlide){ + this.activePanel.afterSlide(); + } + } + } + }, + + initAutoHide : function(){ + if(this.autoHide !== false){ + if(!this.autoHideHd){ + var st = new Roo.util.DelayedTask(this.slideIn, this); + this.autoHideHd = { + "mouseout": function(e){ + if(!e.within(this.el, true)){ + st.delay(500); + } + }, + "mouseover" : function(e){ + st.cancel(); + }, + scope : this + }; + } + this.el.on(this.autoHideHd); + } + }, + + clearAutoHide : function(){ + if(this.autoHide !== false){ + this.el.un("mouseout", this.autoHideHd.mouseout); + this.el.un("mouseover", this.autoHideHd.mouseover); + } + }, + + clearMonitor : function(){ + Roo.get(document).un("click", this.slideInIf, this); + }, + + // these names are backwards but not changed for compat + slideOut : function(){ + if(this.isSlid || this.el.hasActiveFx()){ + return; + } + this.isSlid = true; + if(this.collapseBtn){ + this.collapseBtn.hide(); + } + this.closeBtnState = this.closeBtn.getStyle('display'); + this.closeBtn.hide(); + if(this.stickBtn){ + this.stickBtn.show(); + } + this.el.show(); + this.el.alignTo(this.collapsedEl, this.getCollapseAnchor()); + this.beforeSlide(); + this.el.setStyle("z-index", 10001); + this.el.slideIn(this.getSlideAnchor(), { + callback: function(){ + this.afterSlide(); + this.initAutoHide(); + Roo.get(document).on("click", this.slideInIf, this); + this.fireEvent("slideshow", this); + }, + scope: this, + block: true + }); + }, + + afterSlideIn : function(){ + this.clearAutoHide(); + this.isSlid = false; + this.clearMonitor(); + this.el.setStyle("z-index", ""); + if(this.collapseBtn){ + this.collapseBtn.show(); + } + this.closeBtn.setStyle('display', this.closeBtnState); + if(this.stickBtn){ + this.stickBtn.hide(); + } + this.fireEvent("slidehide", this); + }, + + slideIn : function(cb){ + if(!this.isSlid || this.el.hasActiveFx()){ + Roo.callback(cb); + return; + } + this.isSlid = false; + this.beforeSlide(); + this.el.slideOut(this.getSlideAnchor(), { + callback: function(){ + this.el.setLeftTop(-10000, -10000); + this.afterSlide(); + this.afterSlideIn(); + Roo.callback(cb); + }, + scope: this, + block: true + }); + }, + + slideInIf : function(e){ + if(!e.within(this.el)){ + this.slideIn(); + } + }, + + animateCollapse : function(){ + this.beforeSlide(); + this.el.setStyle("z-index", 20000); + var anchor = this.getSlideAnchor(); + this.el.slideOut(anchor, { + callback : function(){ + this.el.setStyle("z-index", ""); + this.collapsedEl.slideIn(anchor, {duration:.3}); + this.afterSlide(); + this.el.setLocation(-10000,-10000); + this.el.hide(); + this.fireEvent("collapsed", this); + }, + scope: this, + block: true + }); + }, + + animateExpand : function(){ + this.beforeSlide(); + this.el.alignTo(this.collapsedEl, this.getCollapseAnchor(), this.getExpandAdj()); + this.el.setStyle("z-index", 20000); + this.collapsedEl.hide({ + duration:.1 + }); + this.el.slideIn(this.getSlideAnchor(), { + callback : function(){ + this.el.setStyle("z-index", ""); + this.afterSlide(); + if(this.split){ + this.split.el.show(); + } + this.fireEvent("invalidated", this); + this.fireEvent("expanded", this); + }, + scope: this, + block: true + }); + }, + + anchors : { + "west" : "left", + "east" : "right", + "north" : "top", + "south" : "bottom" + }, + + sanchors : { + "west" : "l", + "east" : "r", + "north" : "t", + "south" : "b" + }, + + canchors : { + "west" : "tl-tr", + "east" : "tr-tl", + "north" : "tl-bl", + "south" : "bl-tl" + }, + + getAnchor : function(){ + return this.anchors[this.position]; + }, + + getCollapseAnchor : function(){ + return this.canchors[this.position]; + }, + + getSlideAnchor : function(){ + return this.sanchors[this.position]; + }, + + getAlignAdj : function(){ + var cm = this.cmargins; + switch(this.position){ + case "west": + return [0, 0]; + break; + case "east": + return [0, 0]; + break; + case "north": + return [0, 0]; + break; + case "south": + return [0, 0]; + break; + } + }, + + getExpandAdj : function(){ + var c = this.collapsedEl, cm = this.cmargins; + switch(this.position){ + case "west": + return [-(cm.right+c.getWidth()+cm.left), 0]; + break; + case "east": + return [cm.right+c.getWidth()+cm.left, 0]; + break; + case "north": + return [0, -(cm.top+cm.bottom+c.getHeight())]; + break; + case "south": + return [0, cm.top+cm.bottom+c.getHeight()]; + break; + } + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_TabPanel.js.html b/docs2/src/Roo_TabPanel.js.html new file mode 100644 index 0000000000..76eb1a6081 --- /dev/null +++ b/docs2/src/Roo_TabPanel.js.html @@ -0,0 +1,810 @@ +/home/alan/gitlive/roojs1/Roo/TabPanel.js /* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.TabPanel + * @extends Roo.util.Observable + * A lightweight tab container. + * <br><br> + * Usage: + * <pre><code> +// basic tabs 1, built from existing content +var tabs = new Roo.TabPanel("tabs1"); +tabs.addTab("script", "View Script"); +tabs.addTab("markup", "View Markup"); +tabs.activate("script"); + +// more advanced tabs, built from javascript +var jtabs = new Roo.TabPanel("jtabs"); +jtabs.addTab("jtabs-1", "Normal Tab", "My content was added during construction."); + +// set up the UpdateManager +var tab2 = jtabs.addTab("jtabs-2", "Ajax Tab 1"); +var updater = tab2.getUpdateManager(); +updater.setDefaultUrl("ajax1.htm"); +tab2.on('activate', updater.refresh, updater, true); + +// Use setUrl for Ajax loading +var tab3 = jtabs.addTab("jtabs-3", "Ajax Tab 2"); +tab3.setUrl("ajax2.htm", null, true); + +// Disabled tab +var tab4 = jtabs.addTab("tabs1-5", "Disabled Tab", "Can't see me cause I'm disabled"); +tab4.disable(); + +jtabs.activate("jtabs-1"); + * </code></pre> + * @constructor + * Create a new TabPanel. + * @param {String/HTMLElement/Roo.Element} container The id, DOM element or Roo.Element container where this TabPanel is to be rendered. + * @param {Object/Boolean} config Config object to set any properties for this TabPanel, or true to render the tabs on the bottom. + */ +Roo.TabPanel = function(container, config){ + /** + * The container element for this TabPanel. + * @type Roo.Element + */ + this.el = Roo.get(container, true); + if(config){ + if(typeof config == "boolean"){ + this.tabPosition = config ? "bottom" : "top"; + }else{ + Roo.apply(this, config); + } + } + if(this.tabPosition == "bottom"){ + this.bodyEl = Roo.get(this.createBody(this.el.dom)); + this.el.addClass("x-tabs-bottom"); + } + this.stripWrap = Roo.get(this.createStrip(this.el.dom), true); + this.stripEl = Roo.get(this.createStripList(this.stripWrap.dom), true); + this.stripBody = Roo.get(this.stripWrap.dom.firstChild.firstChild, true); + if(Roo.isIE){ + Roo.fly(this.stripWrap.dom.firstChild).setStyle("overflow-x", "hidden"); + } + if(this.tabPosition != "bottom"){ + /** The body element that contains {@link Roo.TabPanelItem} bodies. + + * @type Roo.Element + */ + this.bodyEl = Roo.get(this.createBody(this.el.dom)); + this.el.addClass("x-tabs-top"); + } + this.items = []; + + this.bodyEl.setStyle("position", "relative"); + + this.active = null; + this.activateDelegate = this.activate.createDelegate(this); + + this.addEvents({ + /** + * @event tabchange + * Fires when the active tab changes + * @param {Roo.TabPanel} this + * @param {Roo.TabPanelItem} activePanel The new active tab + */ + "tabchange": true, + /** + * @event beforetabchange + * Fires before the active tab changes, set cancel to true on the "e" parameter to cancel the change + * @param {Roo.TabPanel} this + * @param {Object} e Set cancel to true on this object to cancel the tab change + * @param {Roo.TabPanelItem} tab The tab being changed to + */ + "beforetabchange" : true + }); + + Roo.EventManager.onWindowResize(this.onResize, this); + this.cpad = this.el.getPadding("lr"); + this.hiddenCount = 0; + + + // toolbar on the tabbar support... + if (this.toolbar) { + var tcfg = this.toolbar; + tcfg.container = this.stripEl.child('td.x-tab-strip-toolbar'); + this.toolbar = new Roo.Toolbar(tcfg); + if (Roo.isSafari) { + var tbl = tcfg.container.child('table', true); + tbl.setAttribute('width', '100%'); + } + + } + + + + Roo.TabPanel.superclass.constructor.call(this); +}; + +Roo.extend(Roo.TabPanel, Roo.util.Observable, { + /* + *@cfg {String} tabPosition "top" or "bottom" (defaults to "top") + */ + tabPosition : "top", + /* + *@cfg {Number} currentTabWidth The width of the current tab (defaults to 0) + */ + currentTabWidth : 0, + /* + *@cfg {Number} minTabWidth The minimum width of a tab (defaults to 40) (ignored if {@link #resizeTabs} is not true) + */ + minTabWidth : 40, + /* + *@cfg {Number} maxTabWidth The maximum width of a tab (defaults to 250) (ignored if {@link #resizeTabs} is not true) + */ + maxTabWidth : 250, + /* + *@cfg {Number} preferredTabWidth The preferred (default) width of a tab (defaults to 175) (ignored if {@link #resizeTabs} is not true) + */ + preferredTabWidth : 175, + /* + *@cfg {Boolean} resizeTabs True to enable dynamic tab resizing (defaults to false) + */ + resizeTabs : false, + /* + *@cfg {Boolean} monitorResize Set this to true to turn on window resize monitoring (ignored if {@link #resizeTabs} is not true) (defaults to true) + */ + monitorResize : true, + /* + *@cfg {Object} toolbar xtype description of toolbar to show at the right of the tab bar. + */ + toolbar : false, + + /** + * Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one. + * @param {String} id The id of the div to use <b>or create</b> + * @param {String} text The text for the tab + * @param {String} content (optional) Content to put in the TabPanelItem body + * @param {Boolean} closable (optional) True to create a close icon on the tab + * @return {Roo.TabPanelItem} The created TabPanelItem + */ + addTab : function(id, text, content, closable){ + var item = new Roo.TabPanelItem(this, id, text, closable); + this.addTabItem(item); + if(content){ + item.setContent(content); + } + return item; + }, + + /** + * Returns the {@link Roo.TabPanelItem} with the specified id/index + * @param {String/Number} id The id or index of the TabPanelItem to fetch. + * @return {Roo.TabPanelItem} + */ + getTab : function(id){ + return this.items[id]; + }, + + /** + * Hides the {@link Roo.TabPanelItem} with the specified id/index + * @param {String/Number} id The id or index of the TabPanelItem to hide. + */ + hideTab : function(id){ + var t = this.items[id]; + if(!t.isHidden()){ + t.setHidden(true); + this.hiddenCount++; + this.autoSizeTabs(); + } + }, + + /** + * "Unhides" the {@link Roo.TabPanelItem} with the specified id/index. + * @param {String/Number} id The id or index of the TabPanelItem to unhide. + */ + unhideTab : function(id){ + var t = this.items[id]; + if(t.isHidden()){ + t.setHidden(false); + this.hiddenCount--; + this.autoSizeTabs(); + } + }, + + /** + * Adds an existing {@link Roo.TabPanelItem}. + * @param {Roo.TabPanelItem} item The TabPanelItem to add + */ + addTabItem : function(item){ + this.items[item.id] = item; + this.items.push(item); + if(this.resizeTabs){ + item.setWidth(this.currentTabWidth || this.preferredTabWidth); + this.autoSizeTabs(); + }else{ + item.autoSize(); + } + }, + + /** + * Removes a {@link Roo.TabPanelItem}. + * @param {String/Number} id The id or index of the TabPanelItem to remove. + */ + removeTab : function(id){ + var items = this.items; + var tab = items[id]; + if(!tab) { return; } + var index = items.indexOf(tab); + if(this.active == tab && items.length > 1){ + var newTab = this.getNextAvailable(index); + if(newTab) { + newTab.activate(); + } + } + this.stripEl.dom.removeChild(tab.pnode.dom); + if(tab.bodyEl.dom.parentNode == this.bodyEl.dom){ // if it was moved already prevent error + this.bodyEl.dom.removeChild(tab.bodyEl.dom); + } + items.splice(index, 1); + delete this.items[tab.id]; + tab.fireEvent("close", tab); + tab.purgeListeners(); + this.autoSizeTabs(); + }, + + getNextAvailable : function(start){ + var items = this.items; + var index = start; + // look for a next tab that will slide over to + // replace the one being removed + while(index < items.length){ + var item = items[++index]; + if(item && !item.isHidden()){ + return item; + } + } + // if one isn't found select the previous tab (on the left) + index = start; + while(index >= 0){ + var item = items[--index]; + if(item && !item.isHidden()){ + return item; + } + } + return null; + }, + + /** + * Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored. + * @param {String/Number} id The id or index of the TabPanelItem to disable. + */ + disableTab : function(id){ + var tab = this.items[id]; + if(tab && this.active != tab){ + tab.disable(); + } + }, + + /** + * Enables a {@link Roo.TabPanelItem} that is disabled. + * @param {String/Number} id The id or index of the TabPanelItem to enable. + */ + enableTab : function(id){ + var tab = this.items[id]; + tab.enable(); + }, + + /** + * Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated. + * @param {String/Number} id The id or index of the TabPanelItem to activate. + * @return {Roo.TabPanelItem} The TabPanelItem. + */ + activate : function(id){ + var tab = this.items[id]; + if(!tab){ + return null; + } + if(tab == this.active || tab.disabled){ + return tab; + } + var e = {}; + this.fireEvent("beforetabchange", this, e, tab); + if(e.cancel !== true && !tab.disabled){ + if(this.active){ + this.active.hide(); + } + this.active = this.items[id]; + this.active.show(); + this.fireEvent("tabchange", this, this.active); + } + return tab; + }, + + /** + * Gets the active {@link Roo.TabPanelItem}. + * @return {Roo.TabPanelItem} The active TabPanelItem or null if none are active. + */ + getActiveTab : function(){ + return this.active; + }, + + /** + * Updates the tab body element to fit the height of the container element + * for overflow scrolling + * @param {Number} targetHeight (optional) Override the starting height from the elements height + */ + syncHeight : function(targetHeight){ + var height = (targetHeight || this.el.getHeight())-this.el.getBorderWidth("tb")-this.el.getPadding("tb"); + var bm = this.bodyEl.getMargins(); + var newHeight = height-(this.stripWrap.getHeight()||0)-(bm.top+bm.bottom); + this.bodyEl.setHeight(newHeight); + return newHeight; + }, + + onResize : function(){ + if(this.monitorResize){ + this.autoSizeTabs(); + } + }, + + /** + * Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing) + */ + beginUpdate : function(){ + this.updating = true; + }, + + /** + * Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing) + */ + endUpdate : function(){ + this.updating = false; + this.autoSizeTabs(); + }, + + /** + * Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing) + */ + autoSizeTabs : function(){ + var count = this.items.length; + var vcount = count - this.hiddenCount; + if(!this.resizeTabs || count < 1 || vcount < 1 || this.updating) { + return; + } + var w = Math.max(this.el.getWidth() - this.cpad, 10); + var availWidth = Math.floor(w / vcount); + var b = this.stripBody; + if(b.getWidth() > w){ + var tabs = this.items; + this.setTabWidth(Math.max(availWidth, this.minTabWidth)-2); + if(availWidth < this.minTabWidth){ + /*if(!this.sleft){ // incomplete scrolling code + this.createScrollButtons(); + } + this.showScroll(); + this.stripClip.setWidth(w - (this.sleft.getWidth()+this.sright.getWidth()));*/ + } + }else{ + if(this.currentTabWidth < this.preferredTabWidth){ + this.setTabWidth(Math.min(availWidth, this.preferredTabWidth)-2); + } + } + }, + + /** + * Returns the number of tabs in this TabPanel. + * @return {Number} + */ + getCount : function(){ + return this.items.length; + }, + + /** + * Resizes all the tabs to the passed width + * @param {Number} The new width + */ + setTabWidth : function(width){ + this.currentTabWidth = width; + for(var i = 0, len = this.items.length; i < len; i++) { + if(!this.items[i].isHidden()) { + this.items[i].setWidth(width); + } + } + }, + + /** + * Destroys this TabPanel + * @param {Boolean} removeEl (optional) True to remove the element from the DOM as well (defaults to undefined) + */ + destroy : function(removeEl){ + Roo.EventManager.removeResizeListener(this.onResize, this); + for(var i = 0, len = this.items.length; i < len; i++){ + this.items[i].purgeListeners(); + } + if(removeEl === true){ + this.el.update(""); + this.el.remove(); + } + } +}); + +/** + * @class Roo.TabPanelItem + * @extends Roo.util.Observable + * Represents an individual item (tab plus body) in a TabPanel. + * @param {Roo.TabPanel} tabPanel The {@link Roo.TabPanel} this TabPanelItem belongs to + * @param {String} id The id of this TabPanelItem + * @param {String} text The text for the tab of this TabPanelItem + * @param {Boolean} closable True to allow this TabPanelItem to be closable (defaults to false) + */ +Roo.TabPanelItem = function(tabPanel, id, text, closable){ + /** + * The {@link Roo.TabPanel} this TabPanelItem belongs to + * @type Roo.TabPanel + */ + this.tabPanel = tabPanel; + /** + * The id for this TabPanelItem + * @type String + */ + this.id = id; + /** @private */ + this.disabled = false; + /** @private */ + this.text = text; + /** @private */ + this.loaded = false; + this.closable = closable; + + /** + * The body element for this TabPanelItem. + * @type Roo.Element + */ + this.bodyEl = Roo.get(tabPanel.createItemBody(tabPanel.bodyEl.dom, id)); + this.bodyEl.setVisibilityMode(Roo.Element.VISIBILITY); + this.bodyEl.setStyle("display", "block"); + this.bodyEl.setStyle("zoom", "1"); + this.hideAction(); + + var els = tabPanel.createStripElements(tabPanel.stripEl.dom, text, closable); + /** @private */ + this.el = Roo.get(els.el, true); + this.inner = Roo.get(els.inner, true); + this.textEl = Roo.get(this.el.dom.firstChild.firstChild.firstChild, true); + this.pnode = Roo.get(els.el.parentNode, true); + this.el.on("mousedown", this.onTabMouseDown, this); + this.el.on("click", this.onTabClick, this); + /** @private */ + if(closable){ + var c = Roo.get(els.close, true); + c.dom.title = this.closeText; + c.addClassOnOver("close-over"); + c.on("click", this.closeClick, this); + } + + this.addEvents({ + /** + * @event activate + * Fires when this tab becomes the active tab. + * @param {Roo.TabPanel} tabPanel The parent TabPanel + * @param {Roo.TabPanelItem} this + */ + "activate": true, + /** + * @event beforeclose + * Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true). + * @param {Roo.TabPanelItem} this + * @param {Object} e Set cancel to true on this object to cancel the close. + */ + "beforeclose": true, + /** + * @event close + * Fires when this tab is closed. + * @param {Roo.TabPanelItem} this + */ + "close": true, + /** + * @event deactivate + * Fires when this tab is no longer the active tab. + * @param {Roo.TabPanel} tabPanel The parent TabPanel + * @param {Roo.TabPanelItem} this + */ + "deactivate" : true + }); + this.hidden = false; + + Roo.TabPanelItem.superclass.constructor.call(this); +}; + +Roo.extend(Roo.TabPanelItem, Roo.util.Observable, { + purgeListeners : function(){ + Roo.util.Observable.prototype.purgeListeners.call(this); + this.el.removeAllListeners(); + }, + /** + * Shows this TabPanelItem -- this <b>does not</b> deactivate the currently active TabPanelItem. + */ + show : function(){ + this.pnode.addClass("on"); + this.showAction(); + if(Roo.isOpera){ + this.tabPanel.stripWrap.repaint(); + } + this.fireEvent("activate", this.tabPanel, this); + }, + + /** + * Returns true if this tab is the active tab. + * @return {Boolean} + */ + isActive : function(){ + return this.tabPanel.getActiveTab() == this; + }, + + /** + * Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd. + */ + hide : function(){ + this.pnode.removeClass("on"); + this.hideAction(); + this.fireEvent("deactivate", this.tabPanel, this); + }, + + hideAction : function(){ + this.bodyEl.hide(); + this.bodyEl.setStyle("position", "absolute"); + this.bodyEl.setLeft("-20000px"); + this.bodyEl.setTop("-20000px"); + }, + + showAction : function(){ + this.bodyEl.setStyle("position", "relative"); + this.bodyEl.setTop(""); + this.bodyEl.setLeft(""); + this.bodyEl.show(); + }, + + /** + * Set the tooltip for the tab. + * @param {String} tooltip The tab's tooltip + */ + setTooltip : function(text){ + if(Roo.QuickTips && Roo.QuickTips.isEnabled()){ + this.textEl.dom.qtip = text; + this.textEl.dom.removeAttribute('title'); + }else{ + this.textEl.dom.title = text; + } + }, + + onTabClick : function(e){ + e.preventDefault(); + this.tabPanel.activate(this.id); + }, + + onTabMouseDown : function(e){ + e.preventDefault(); + this.tabPanel.activate(this.id); + }, + + getWidth : function(){ + return this.inner.getWidth(); + }, + + setWidth : function(width){ + var iwidth = width - this.pnode.getPadding("lr"); + this.inner.setWidth(iwidth); + this.textEl.setWidth(iwidth-this.inner.getPadding("lr")); + this.pnode.setWidth(width); + }, + + /** + * Show or hide the tab + * @param {Boolean} hidden True to hide or false to show. + */ + setHidden : function(hidden){ + this.hidden = hidden; + this.pnode.setStyle("display", hidden ? "none" : ""); + }, + + /** + * Returns true if this tab is "hidden" + * @return {Boolean} + */ + isHidden : function(){ + return this.hidden; + }, + + /** + * Returns the text for this tab + * @return {String} + */ + getText : function(){ + return this.text; + }, + + autoSize : function(){ + //this.el.beginMeasure(); + this.textEl.setWidth(1); + /* + * #2804 [new] Tabs in Roojs + * increase the width by 2-4 pixels to prevent the ellipssis showing in chrome + */ + this.setWidth(this.textEl.dom.scrollWidth+this.pnode.getPadding("lr")+this.inner.getPadding("lr") + 2); + //this.el.endMeasure(); + }, + + /** + * Sets the text for the tab (Note: this also sets the tooltip text) + * @param {String} text The tab's text and tooltip + */ + setText : function(text){ + this.text = text; + this.textEl.update(text); + this.setTooltip(text); + if(!this.tabPanel.resizeTabs){ + this.autoSize(); + } + }, + /** + * Activates this TabPanelItem -- this <b>does</b> deactivate the currently active TabPanelItem. + */ + activate : function(){ + this.tabPanel.activate(this.id); + }, + + /** + * Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem. + */ + disable : function(){ + if(this.tabPanel.active != this){ + this.disabled = true; + this.pnode.addClass("disabled"); + } + }, + + /** + * Enables this TabPanelItem if it was previously disabled. + */ + enable : function(){ + this.disabled = false; + this.pnode.removeClass("disabled"); + }, + + /** + * Sets the content for this TabPanelItem. + * @param {String} content The content + * @param {Boolean} loadScripts true to look for and load scripts + */ + setContent : function(content, loadScripts){ + this.bodyEl.update(content, loadScripts); + }, + + /** + * Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates. + * @return {Roo.UpdateManager} The UpdateManager + */ + getUpdateManager : function(){ + return this.bodyEl.getUpdateManager(); + }, + + /** + * Set a URL to be used to load the content for this TabPanelItem. + * @param {String/Function} url The URL to load the content from, or a function to call to get the URL + * @param {String/Object} params (optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null) + * @param {Boolean} loadOnce (optional) Whether to only load the content once. If this is false it makes the Ajax call every time this TabPanelItem is activated. (Defaults to false) + * @return {Roo.UpdateManager} The UpdateManager + */ + setUrl : function(url, params, loadOnce){ + if(this.refreshDelegate){ + this.un('activate', this.refreshDelegate); + } + this.refreshDelegate = this._handleRefresh.createDelegate(this, [url, params, loadOnce]); + this.on("activate", this.refreshDelegate); + return this.bodyEl.getUpdateManager(); + }, + + /** @private */ + _handleRefresh : function(url, params, loadOnce){ + if(!loadOnce || !this.loaded){ + var updater = this.bodyEl.getUpdateManager(); + updater.update(url, params, this._setLoaded.createDelegate(this)); + } + }, + + /** + * Forces a content refresh from the URL specified in the {@link #setUrl} method. + * Will fail silently if the setUrl method has not been called. + * This does not activate the panel, just updates its content. + */ + refresh : function(){ + if(this.refreshDelegate){ + this.loaded = false; + this.refreshDelegate(); + } + }, + + /** @private */ + _setLoaded : function(){ + this.loaded = true; + }, + + /** @private */ + closeClick : function(e){ + var o = {}; + e.stopEvent(); + this.fireEvent("beforeclose", this, o); + if(o.cancel !== true){ + this.tabPanel.removeTab(this.id); + } + }, + /** + * The text displayed in the tooltip for the close icon. + * @type String + */ + closeText : "Close this tab" +}); + +/** @private */ +Roo.TabPanel.prototype.createStrip = function(container){ + var strip = document.createElement("div"); + strip.className = "x-tabs-wrap"; + container.appendChild(strip); + return strip; +}; +/** @private */ +Roo.TabPanel.prototype.createStripList = function(strip){ + // div wrapper for retard IE + // returns the "tr" element. + strip.innerHTML = '<div class="x-tabs-strip-wrap">'+ + '<table class="x-tabs-strip" cellspacing="0" cellpadding="0" border="0"><tbody><tr>'+ + '<td class="x-tab-strip-toolbar"></td></tr></tbody></table></div>'; + return strip.firstChild.firstChild.firstChild.firstChild; +}; +/** @private */ +Roo.TabPanel.prototype.createBody = function(container){ + var body = document.createElement("div"); + Roo.id(body, "tab-body"); + Roo.fly(body).addClass("x-tabs-body"); + container.appendChild(body); + return body; +}; +/** @private */ +Roo.TabPanel.prototype.createItemBody = function(bodyEl, id){ + var body = Roo.getDom(id); + if(!body){ + body = document.createElement("div"); + body.id = id; + } + Roo.fly(body).addClass("x-tabs-item-body"); + bodyEl.insertBefore(body, bodyEl.firstChild); + return body; +}; +/** @private */ +Roo.TabPanel.prototype.createStripElements = function(stripEl, text, closable){ + var td = document.createElement("td"); + stripEl.insertBefore(td, stripEl.childNodes[stripEl.childNodes.length-1]); + //stripEl.appendChild(td); + if(closable){ + td.className = "x-tabs-closable"; + if(!this.closeTpl){ + this.closeTpl = new Roo.Template( + '<a href="#" class="x-tabs-right"><span class="x-tabs-left"><em class="x-tabs-inner">' + + '<span unselectable="on"' + (this.disableTooltips ? '' : ' title="{text}"') +' class="x-tabs-text">{text}</span>' + + '<div unselectable="on" class="close-icon">&#160;</div></em></span></a>' + ); + } + var el = this.closeTpl.overwrite(td, {"text": text}); + var close = el.getElementsByTagName("div")[0]; + var inner = el.getElementsByTagName("em")[0]; + return {"el": el, "close": close, "inner": inner}; + } else { + if(!this.tabTpl){ + this.tabTpl = new Roo.Template( + '<a href="#" class="x-tabs-right"><span class="x-tabs-left"><em class="x-tabs-inner">' + + '<span unselectable="on"' + (this.disableTooltips ? '' : ' title="{text}"') +' class="x-tabs-text">{text}</span></em></span></a>' + ); + } + var el = this.tabTpl.overwrite(td, {"text": text}); + var inner = el.getElementsByTagName("em")[0]; + return {"el": el, "inner": inner}; + } +}; \ No newline at end of file diff --git a/docs2/src/Roo_Template.js.html b/docs2/src/Roo_Template.js.html new file mode 100644 index 0000000000..6efe5e83a2 --- /dev/null +++ b/docs2/src/Roo_Template.js.html @@ -0,0 +1,296 @@ +/home/alan/gitlive/roojs1/Roo/Template.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** +* @class Roo.Template +* Represents an HTML fragment template. Templates can be precompiled for greater performance. +* For a list of available format functions, see {@link Roo.util.Format}.<br /> +* Usage: +<pre><code> +var t = new Roo.Template({ + html : '&lt;div name="{id}"&gt;' + + '&lt;span class="{cls}"&gt;{name:trim} {someval:this.myformat}{value:ellipsis(10)}&lt;/span&gt;' + + '&lt;/div&gt;', + myformat: function (value, allValues) { + return 'XX' + value; + } +}); +t.append('some-element', {id: 'myid', cls: 'myclass', name: 'foo', value: 'bar'}); +</code></pre> +* For more information see this blog post with examples: +* <a href="http://www.cnitblog.com/seeyeah/archive/2011/12/30/38728.html/">DomHelper + - Create Elements using DOM, HTML fragments and Templates</a>. +* @constructor +* @param {Object} cfg - Configuration object. +*/ +Roo.Template = function(cfg){ + // BC! + if(cfg instanceof Array){ + cfg = cfg.join(""); + }else if(arguments.length > 1){ + cfg = Array.prototype.join.call(arguments, ""); + } + + + if (typeof(cfg) == 'object') { + Roo.apply(this,cfg) + } else { + // bc + this.html = cfg; + } + if (this.url) { + this.load(); + } + +}; +Roo.Template.prototype = { + + /** + * @cfg {String} url The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly.. + * it should be fixed so that template is observable... + */ + url : false, + /** + * @cfg {String} html The HTML fragment or an array of fragments to join("") or multiple arguments to join("") + */ + html : '', + /** + * Returns an HTML fragment of this template with the specified values applied. + * @param {Object} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'}) + * @return {String} The HTML fragment + */ + applyTemplate : function(values){ + try { + + if(this.compiled){ + return this.compiled(values); + } + var useF = this.disableFormats !== true; + var fm = Roo.util.Format, tpl = this; + var fn = function(m, name, format, args){ + if(format && useF){ + if(format.substr(0, 5) == "this."){ + return tpl.call(format.substr(5), values[name], values); + }else{ + if(args){ + // quoted values are required for strings in compiled templates, + // but for non compiled we need to strip them + // quoted reversed for jsmin + var re = /^\s*['"](.*)["']\s*$/; + args = args.split(','); + for(var i = 0, len = args.length; i < len; i++){ + args[i] = args[i].replace(re, "$1"); + } + args = [values[name]].concat(args); + }else{ + args = [values[name]]; + } + return fm[format].apply(fm, args); + } + }else{ + return values[name] !== undefined ? values[name] : ""; + } + }; + return this.html.replace(this.re, fn); + } catch (e) { + Roo.log(e); + throw e; + } + + }, + + loading : false, + + load : function () + { + + if (this.loading) { + return; + } + var _t = this; + + this.loading = true; + this.compiled = false; + + var cx = new Roo.data.Connection(); + cx.request({ + url : this.url, + method : 'GET', + success : function (response) { + _t.loading = false; + _t.html = response.responseText; + _t.url = false; + _t.compile(); + }, + failure : function(response) { + Roo.log("Template failed to load from " + _t.url); + _t.loading = false; + } + }); + }, + + /** + * Sets the HTML used as the template and optionally compiles it. + * @param {String} html + * @param {Boolean} compile (optional) True to compile the template (defaults to undefined) + * @return {Roo.Template} this + */ + set : function(html, compile){ + this.html = html; + this.compiled = null; + if(compile){ + this.compile(); + } + return this; + }, + + /** + * True to disable format functions (defaults to false) + * @type Boolean + */ + disableFormats : false, + + /** + * The regular expression used to match template variables + * @type RegExp + * @property + */ + re : /\{([\w-]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?\}/g, + + /** + * Compiles the template into an internal function, eliminating the RegEx overhead. + * @return {Roo.Template} this + */ + compile : function(){ + var fm = Roo.util.Format; + var useF = this.disableFormats !== true; + var sep = Roo.isGecko ? "+" : ","; + var fn = function(m, name, format, args){ + if(format && useF){ + args = args ? ',' + args : ""; + if(format.substr(0, 5) != "this."){ + format = "fm." + format + '('; + }else{ + format = 'this.call("'+ format.substr(5) + '", '; + args = ", values"; + } + }else{ + args= ''; format = "(values['" + name + "'] == undefined ? '' : "; + } + return "'"+ sep + format + "values['" + name + "']" + args + ")"+sep+"'"; + }; + var body; + // branched to use + in gecko and [].join() in others + if(Roo.isGecko){ + body = "this.compiled = function(values){ return '" + + this.html.replace(/\\/g, '\\\\').replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn) + + "';};"; + }else{ + body = ["this.compiled = function(values){ return ['"]; + body.push(this.html.replace(/\\/g, '\\\\').replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn)); + body.push("'].join('');};"); + body = body.join(''); + } + /** + * eval:var:values + * eval:var:fm + */ + eval(body); + return this; + }, + + // private function used to call members + call : function(fnName, value, allValues){ + return this[fnName](value, allValues); + }, + + /** + * Applies the supplied values to the template and inserts the new node(s) as the first child of el. + * @param {String/HTMLElement/Roo.Element} el The context element + * @param {Object} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'}) + * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined) + * @return {HTMLElement/Roo.Element} The new node or Element + */ + insertFirst: function(el, values, returnElement){ + return this.doInsert('afterBegin', el, values, returnElement); + }, + + /** + * Applies the supplied values to the template and inserts the new node(s) before el. + * @param {String/HTMLElement/Roo.Element} el The context element + * @param {Object} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'}) + * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined) + * @return {HTMLElement/Roo.Element} The new node or Element + */ + insertBefore: function(el, values, returnElement){ + return this.doInsert('beforeBegin', el, values, returnElement); + }, + + /** + * Applies the supplied values to the template and inserts the new node(s) after el. + * @param {String/HTMLElement/Roo.Element} el The context element + * @param {Object} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'}) + * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined) + * @return {HTMLElement/Roo.Element} The new node or Element + */ + insertAfter : function(el, values, returnElement){ + return this.doInsert('afterEnd', el, values, returnElement); + }, + + /** + * Applies the supplied values to the template and appends the new node(s) to el. + * @param {String/HTMLElement/Roo.Element} el The context element + * @param {Object} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'}) + * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined) + * @return {HTMLElement/Roo.Element} The new node or Element + */ + append : function(el, values, returnElement){ + return this.doInsert('beforeEnd', el, values, returnElement); + }, + + doInsert : function(where, el, values, returnEl){ + el = Roo.getDom(el); + var newNode = Roo.DomHelper.insertHtml(where, el, this.applyTemplate(values)); + return returnEl ? Roo.get(newNode, true) : newNode; + }, + + /** + * Applies the supplied values to the template and overwrites the content of el with the new node(s). + * @param {String/HTMLElement/Roo.Element} el The context element + * @param {Object} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'}) + * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined) + * @return {HTMLElement/Roo.Element} The new node or Element + */ + overwrite : function(el, values, returnElement){ + el = Roo.getDom(el); + el.innerHTML = this.applyTemplate(values); + return returnElement ? Roo.get(el.firstChild, true) : el.firstChild; + } +}; +/** + * Alias for {@link #applyTemplate} + * @method + */ +Roo.Template.prototype.apply = Roo.Template.prototype.applyTemplate; + +// backwards compat +Roo.DomHelper.Template = Roo.Template; + +/** + * Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML. + * @param {String/HTMLElement} el A DOM element or its id + * @returns {Roo.Template} The created template + * @static + */ +Roo.Template.from = function(el){ + el = Roo.getDom(el); + return new Roo.Template(el.value || el.innerHTML); +}; \ No newline at end of file diff --git a/docs2/src/Roo_Toolbar.js.html b/docs2/src/Roo_Toolbar.js.html new file mode 100644 index 0000000000..f40333c859 --- /dev/null +++ b/docs2/src/Roo_Toolbar.js.html @@ -0,0 +1,655 @@ +/home/alan/gitlive/roojs1/Roo/Toolbar.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.Toolbar + * Basic Toolbar class. + * @constructor + * Creates a new Toolbar + * @param {Object} container The config object + */ +Roo.Toolbar = function(container, buttons, config) +{ + /// old consturctor format still supported.. + if(container instanceof Array){ // omit the container for later rendering + buttons = container; + config = buttons; + container = null; + } + if (typeof(container) == 'object' && container.xtype) { + config = container; + container = config.container; + buttons = config.buttons || []; // not really - use items!! + } + var xitems = []; + if (config && config.items) { + xitems = config.items; + delete config.items; + } + Roo.apply(this, config); + this.buttons = buttons; + + if(container){ + this.render(container); + } + this.xitems = xitems; + Roo.each(xitems, function(b) { + this.add(b); + }, this); + +}; + +Roo.Toolbar.prototype = { + /** + * @cfg {Array} items + * array of button configs or elements to add (will be converted to a MixedCollection) + */ + + /** + * @cfg {String/HTMLElement/Element} container + * The id or element that will contain the toolbar + */ + // private + render : function(ct){ + this.el = Roo.get(ct); + if(this.cls){ + this.el.addClass(this.cls); + } + // using a table allows for vertical alignment + // 100% width is needed by Safari... + this.el.update('<div class="x-toolbar x-small-editor"><table cellspacing="0"><tr></tr></table></div>'); + this.tr = this.el.child("tr", true); + var autoId = 0; + this.items = new Roo.util.MixedCollection(false, function(o){ + return o.id || ("item" + (++autoId)); + }); + if(this.buttons){ + this.add.apply(this, this.buttons); + delete this.buttons; + } + }, + + /** + * Adds element(s) to the toolbar -- this function takes a variable number of + * arguments of mixed type and adds them to the toolbar. + * @param {Mixed} arg1 The following types of arguments are all valid:<br /> + * <ul> + * <li>{@link Roo.Toolbar.Button} config: A valid button config object (equivalent to {@link #addButton})</li> + * <li>HtmlElement: Any standard HTML element (equivalent to {@link #addElement})</li> + * <li>Field: Any form field (equivalent to {@link #addField})</li> + * <li>Item: Any subclass of {@link Roo.Toolbar.Item} (equivalent to {@link #addItem})</li> + * <li>String: Any generic string (gets wrapped in a {@link Roo.Toolbar.TextItem}, equivalent to {@link #addText}). + * Note that there are a few special strings that are treated differently as explained nRoo.</li> + * <li>'separator' or '-': Creates a separator element (equivalent to {@link #addSeparator})</li> + * <li>' ': Creates a spacer element (equivalent to {@link #addSpacer})</li> + * <li>'->': Creates a fill element (equivalent to {@link #addFill})</li> + * </ul> + * @param {Mixed} arg2 + * @param {Mixed} etc. + */ + add : function(){ + var a = arguments, l = a.length; + for(var i = 0; i < l; i++){ + this._add(a[i]); + } + }, + // private.. + _add : function(el) { + + if (el.xtype) { + el = Roo.factory(el, typeof(Roo.Toolbar[el.xtype]) == 'undefined' ? Roo.form : Roo.Toolbar); + } + + if (el.applyTo){ // some kind of form field + return this.addField(el); + } + if (el.render){ // some kind of Toolbar.Item + return this.addItem(el); + } + if (typeof el == "string"){ // string + if(el == "separator" || el == "-"){ + return this.addSeparator(); + } + if (el == " "){ + return this.addSpacer(); + } + if(el == "->"){ + return this.addFill(); + } + return this.addText(el); + + } + if(el.tagName){ // element + return this.addElement(el); + } + if(typeof el == "object"){ // must be button config? + return this.addButton(el); + } + // and now what?!?! + return false; + + }, + + /** + * Add an Xtype element + * @param {Object} xtype Xtype Object + * @return {Object} created Object + */ + addxtype : function(e){ + return this.add(e); + }, + + /** + * Returns the Element for this toolbar. + * @return {Roo.Element} + */ + getEl : function(){ + return this.el; + }, + + /** + * Adds a separator + * @return {Roo.Toolbar.Item} The separator item + */ + addSeparator : function(){ + return this.addItem(new Roo.Toolbar.Separator()); + }, + + /** + * Adds a spacer element + * @return {Roo.Toolbar.Spacer} The spacer item + */ + addSpacer : function(){ + return this.addItem(new Roo.Toolbar.Spacer()); + }, + + /** + * Adds a fill element that forces subsequent additions to the right side of the toolbar + * @return {Roo.Toolbar.Fill} The fill item + */ + addFill : function(){ + return this.addItem(new Roo.Toolbar.Fill()); + }, + + /** + * Adds any standard HTML element to the toolbar + * @param {String/HTMLElement/Element} el The element or id of the element to add + * @return {Roo.Toolbar.Item} The element's item + */ + addElement : function(el){ + return this.addItem(new Roo.Toolbar.Item(el)); + }, + /** + * Collection of items on the toolbar.. (only Toolbar Items, so use fields to retrieve fields) + * @type Roo.util.MixedCollection + */ + items : false, + + /** + * Adds any Toolbar.Item or subclass + * @param {Roo.Toolbar.Item} item + * @return {Roo.Toolbar.Item} The item + */ + addItem : function(item){ + var td = this.nextBlock(); + item.render(td); + this.items.add(item); + return item; + }, + + /** + * Adds a button (or buttons). See {@link Roo.Toolbar.Button} for more info on the config. + * @param {Object/Array} config A button config or array of configs + * @return {Roo.Toolbar.Button/Array} + */ + addButton : function(config){ + if(config instanceof Array){ + var buttons = []; + for(var i = 0, len = config.length; i < len; i++) { + buttons.push(this.addButton(config[i])); + } + return buttons; + } + var b = config; + if(!(config instanceof Roo.Toolbar.Button)){ + b = config.split ? + new Roo.Toolbar.SplitButton(config) : + new Roo.Toolbar.Button(config); + } + var td = this.nextBlock(); + b.render(td); + this.items.add(b); + return b; + }, + + /** + * Adds text to the toolbar + * @param {String} text The text to add + * @return {Roo.Toolbar.Item} The element's item + */ + addText : function(text){ + return this.addItem(new Roo.Toolbar.TextItem(text)); + }, + + /** + * Inserts any {@link Roo.Toolbar.Item}/{@link Roo.Toolbar.Button} at the specified index. + * @param {Number} index The index where the item is to be inserted + * @param {Object/Roo.Toolbar.Item/Roo.Toolbar.Button (may be Array)} item The button, or button config object to be inserted. + * @return {Roo.Toolbar.Button/Item} + */ + insertButton : function(index, item){ + if(item instanceof Array){ + var buttons = []; + for(var i = 0, len = item.length; i < len; i++) { + buttons.push(this.insertButton(index + i, item[i])); + } + return buttons; + } + if (!(item instanceof Roo.Toolbar.Button)){ + item = new Roo.Toolbar.Button(item); + } + var td = document.createElement("td"); + this.tr.insertBefore(td, this.tr.childNodes[index]); + item.render(td); + this.items.insert(index, item); + return item; + }, + + /** + * Adds a new element to the toolbar from the passed {@link Roo.DomHelper} config. + * @param {Object} config + * @return {Roo.Toolbar.Item} The element's item + */ + addDom : function(config, returnEl){ + var td = this.nextBlock(); + Roo.DomHelper.overwrite(td, config); + var ti = new Roo.Toolbar.Item(td.firstChild); + ti.render(td); + this.items.add(ti); + return ti; + }, + + /** + * Collection of fields on the toolbar.. usefull for quering (value is false if there are no fields) + * @type Roo.util.MixedCollection + */ + fields : false, + + /** + * Adds a dynamically rendered Roo.form field (TextField, ComboBox, etc). + * Note: the field should not have been rendered yet. For a field that has already been + * rendered, use {@link #addElement}. + * @param {Roo.form.Field} field + * @return {Roo.ToolbarItem} + */ + + + addField : function(field) { + if (!this.fields) { + var autoId = 0; + this.fields = new Roo.util.MixedCollection(false, function(o){ + return o.id || ("item" + (++autoId)); + }); + + } + + var td = this.nextBlock(); + field.render(td); + var ti = new Roo.Toolbar.Item(td.firstChild); + ti.render(td); + this.items.add(ti); + this.fields.add(field); + return ti; + }, + /** + * Hide the toolbar + * @method hide + */ + + + hide : function() + { + this.el.child('div').setVisibilityMode(Roo.Element.DISPLAY); + this.el.child('div').hide(); + }, + /** + * Show the toolbar + * @method show + */ + show : function() + { + this.el.child('div').show(); + }, + + // private + nextBlock : function(){ + var td = document.createElement("td"); + this.tr.appendChild(td); + return td; + }, + + // private + destroy : function(){ + if(this.items){ // rendered? + Roo.destroy.apply(Roo, this.items.items); + } + if(this.fields){ // rendered? + Roo.destroy.apply(Roo, this.fields.items); + } + Roo.Element.uncache(this.el, this.tr); + } +}; + +/** + * @class Roo.Toolbar.Item + * The base class that other classes should extend in order to get some basic common toolbar item functionality. + * @constructor + * Creates a new Item + * @param {HTMLElement} el + */ +Roo.Toolbar.Item = function(el){ + var cfg = {}; + if (typeof (el.xtype) != 'undefined') { + cfg = el; + el = cfg.el; + } + + this.el = Roo.getDom(el); + this.id = Roo.id(this.el); + this.hidden = false; + + this.addEvents({ + /** + * @event render + * Fires when the button is rendered + * @param {Button} this + */ + 'render': true + }); + Roo.Toolbar.Item.superclass.constructor.call(this,cfg); +}; +Roo.extend(Roo.Toolbar.Item, Roo.util.Observable, { +//Roo.Toolbar.Item.prototype = { + + /** + * Get this item's HTML Element + * @return {HTMLElement} + */ + getEl : function(){ + return this.el; + }, + + // private + render : function(td){ + + this.td = td; + td.appendChild(this.el); + + this.fireEvent('render', this); + }, + + /** + * Removes and destroys this item. + */ + destroy : function(){ + this.td.parentNode.removeChild(this.td); + }, + + /** + * Shows this item. + */ + show: function(){ + this.hidden = false; + this.td.style.display = ""; + }, + + /** + * Hides this item. + */ + hide: function(){ + this.hidden = true; + this.td.style.display = "none"; + }, + + /** + * Convenience function for boolean show/hide. + * @param {Boolean} visible true to show/false to hide + */ + setVisible: function(visible){ + if(visible) { + this.show(); + }else{ + this.hide(); + } + }, + + /** + * Try to focus this item. + */ + focus : function(){ + Roo.fly(this.el).focus(); + }, + + /** + * Disables this item. + */ + disable : function(){ + Roo.fly(this.td).addClass("x-item-disabled"); + this.disabled = true; + this.el.disabled = true; + }, + + /** + * Enables this item. + */ + enable : function(){ + Roo.fly(this.td).removeClass("x-item-disabled"); + this.disabled = false; + this.el.disabled = false; + } +}); + + +/** + * @class Roo.Toolbar.Separator + * @extends Roo.Toolbar.Item + * A simple toolbar separator class + * @constructor + * Creates a new Separator + */ +Roo.Toolbar.Separator = function(cfg){ + + var s = document.createElement("span"); + s.className = "ytb-sep"; + if (cfg) { + cfg.el = s; + } + + Roo.Toolbar.Separator.superclass.constructor.call(this, cfg || s); +}; +Roo.extend(Roo.Toolbar.Separator, Roo.Toolbar.Item, { + enable:Roo.emptyFn, + disable:Roo.emptyFn, + focus:Roo.emptyFn +}); + +/** + * @class Roo.Toolbar.Spacer + * @extends Roo.Toolbar.Item + * A simple element that adds extra horizontal space to a toolbar. + * @constructor + * Creates a new Spacer + */ +Roo.Toolbar.Spacer = function(cfg){ + var s = document.createElement("div"); + s.className = "ytb-spacer"; + if (cfg) { + cfg.el = s; + } + Roo.Toolbar.Spacer.superclass.constructor.call(this, cfg || s); +}; +Roo.extend(Roo.Toolbar.Spacer, Roo.Toolbar.Item, { + enable:Roo.emptyFn, + disable:Roo.emptyFn, + focus:Roo.emptyFn +}); + +/** + * @class Roo.Toolbar.Fill + * @extends Roo.Toolbar.Spacer + * A simple element that adds a greedy (100% width) horizontal space to a toolbar. + * @constructor + * Creates a new Spacer + */ +Roo.Toolbar.Fill = Roo.extend(Roo.Toolbar.Spacer, { + // private + render : function(td){ + td.style.width = '100%'; + Roo.Toolbar.Fill.superclass.render.call(this, td); + } +}); + +/** + * @class Roo.Toolbar.TextItem + * @extends Roo.Toolbar.Item + * A simple class that renders text directly into a toolbar. + * @constructor + * Creates a new TextItem + * @param {String} text + */ +Roo.Toolbar.TextItem = function(cfg){ + var text = cfg || ""; + if (typeof(cfg) == 'object') { + text = cfg.text || ""; + } else { + cfg = null; + } + var s = document.createElement("span"); + s.className = "ytb-text"; + s.innerHTML = text; + if (cfg) { + cfg.el = s; + } + + Roo.Toolbar.TextItem.superclass.constructor.call(this, cfg || s); +}; +Roo.extend(Roo.Toolbar.TextItem, Roo.Toolbar.Item, { + + + enable:Roo.emptyFn, + disable:Roo.emptyFn, + focus:Roo.emptyFn +}); + +/** + * @class Roo.Toolbar.Button + * @extends Roo.Button + * A button that renders into a toolbar. + * @constructor + * Creates a new Button + * @param {Object} config A standard {@link Roo.Button} config object + */ +Roo.Toolbar.Button = function(config){ + Roo.Toolbar.Button.superclass.constructor.call(this, null, config); +}; +Roo.extend(Roo.Toolbar.Button, Roo.Button, { + render : function(td){ + this.td = td; + Roo.Toolbar.Button.superclass.render.call(this, td); + }, + + /** + * Removes and destroys this button + */ + destroy : function(){ + Roo.Toolbar.Button.superclass.destroy.call(this); + this.td.parentNode.removeChild(this.td); + }, + + /** + * Shows this button + */ + show: function(){ + this.hidden = false; + this.td.style.display = ""; + }, + + /** + * Hides this button + */ + hide: function(){ + this.hidden = true; + this.td.style.display = "none"; + }, + + /** + * Disables this item + */ + disable : function(){ + Roo.fly(this.td).addClass("x-item-disabled"); + this.disabled = true; + }, + + /** + * Enables this item + */ + enable : function(){ + Roo.fly(this.td).removeClass("x-item-disabled"); + this.disabled = false; + } +}); +// backwards compat +Roo.ToolbarButton = Roo.Toolbar.Button; + +/** + * @class Roo.Toolbar.SplitButton + * @extends Roo.SplitButton + * A menu button that renders into a toolbar. + * @constructor + * Creates a new SplitButton + * @param {Object} config A standard {@link Roo.SplitButton} config object + */ +Roo.Toolbar.SplitButton = function(config){ + Roo.Toolbar.SplitButton.superclass.constructor.call(this, null, config); +}; +Roo.extend(Roo.Toolbar.SplitButton, Roo.SplitButton, { + render : function(td){ + this.td = td; + Roo.Toolbar.SplitButton.superclass.render.call(this, td); + }, + + /** + * Removes and destroys this button + */ + destroy : function(){ + Roo.Toolbar.SplitButton.superclass.destroy.call(this); + this.td.parentNode.removeChild(this.td); + }, + + /** + * Shows this button + */ + show: function(){ + this.hidden = false; + this.td.style.display = ""; + }, + + /** + * Hides this button + */ + hide: function(){ + this.hidden = true; + this.td.style.display = "none"; + } +}); + +// backwards compat +Roo.Toolbar.MenuButton = Roo.Toolbar.SplitButton; \ No newline at end of file diff --git a/docs2/src/Roo_UpdateManager.js.html b/docs2/src/Roo_UpdateManager.js.html new file mode 100644 index 0000000000..727d2ea7cc --- /dev/null +++ b/docs2/src/Roo_UpdateManager.js.html @@ -0,0 +1,486 @@ +/home/alan/gitlive/roojs1/Roo/UpdateManager.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.UpdateManager + * @extends Roo.util.Observable + * Provides AJAX-style update for Element object.<br><br> + * Usage:<br> + * <pre><code> + * // Get it from a Roo.Element object + * var el = Roo.get("foo"); + * var mgr = el.getUpdateManager(); + * mgr.update("http://myserver.com/index.php", "param1=1&amp;param2=2"); + * ... + * mgr.formUpdate("myFormId", "http://myserver.com/index.php"); + * <br> + * // or directly (returns the same UpdateManager instance) + * var mgr = new Roo.UpdateManager("myElementId"); + * mgr.startAutoRefresh(60, "http://myserver.com/index.php"); + * mgr.on("update", myFcnNeedsToKnow); + * <br> + // short handed call directly from the element object + Roo.get("foo").load({ + url: "bar.php", + scripts:true, + params: "for=bar", + text: "Loading Foo..." + }); + * </code></pre> + * @constructor + * Create new UpdateManager directly. + * @param {String/HTMLElement/Roo.Element} el The element to update + * @param {Boolean} forceNew (optional) By default the constructor checks to see if the passed element already has an UpdateManager and if it does it returns the same instance. This will skip that check (useful for extending this class). + */ +Roo.UpdateManager = function(el, forceNew){ + el = Roo.get(el); + if(!forceNew && el.updateManager){ + return el.updateManager; + } + /** + * The Element object + * @type Roo.Element + */ + this.el = el; + /** + * Cached url to use for refreshes. Overwritten every time update() is called unless "discardUrl" param is set to true. + * @type String + */ + this.defaultUrl = null; + + this.addEvents({ + /** + * @event beforeupdate + * Fired before an update is made, return false from your handler and the update is cancelled. + * @param {Roo.Element} el + * @param {String/Object/Function} url + * @param {String/Object} params + */ + "beforeupdate": true, + /** + * @event update + * Fired after successful update is made. + * @param {Roo.Element} el + * @param {Object} oResponseObject The response Object + */ + "update": true, + /** + * @event failure + * Fired on update failure. + * @param {Roo.Element} el + * @param {Object} oResponseObject The response Object + */ + "failure": true + }); + var d = Roo.UpdateManager.defaults; + /** + * Blank page URL to use with SSL file uploads (Defaults to Roo.UpdateManager.defaults.sslBlankUrl or "about:blank"). + * @type String + */ + this.sslBlankUrl = d.sslBlankUrl; + /** + * Whether to append unique parameter on get request to disable caching (Defaults to Roo.UpdateManager.defaults.disableCaching or false). + * @type Boolean + */ + this.disableCaching = d.disableCaching; + /** + * Text for loading indicator (Defaults to Roo.UpdateManager.defaults.indicatorText or '&lt;div class="loading-indicator"&gt;Loading...&lt;/div&gt;'). + * @type String + */ + this.indicatorText = d.indicatorText; + /** + * Whether to show indicatorText when loading (Defaults to Roo.UpdateManager.defaults.showLoadIndicator or true). + * @type String + */ + this.showLoadIndicator = d.showLoadIndicator; + /** + * Timeout for requests or form posts in seconds (Defaults to Roo.UpdateManager.defaults.timeout or 30 seconds). + * @type Number + */ + this.timeout = d.timeout; + + /** + * True to process scripts in the output (Defaults to Roo.UpdateManager.defaults.loadScripts (false)). + * @type Boolean + */ + this.loadScripts = d.loadScripts; + + /** + * Transaction object of current executing transaction + */ + this.transaction = null; + + /** + * @private + */ + this.autoRefreshProcId = null; + /** + * Delegate for refresh() prebound to "this", use myUpdater.refreshDelegate.createCallback(arg1, arg2) to bind arguments + * @type Function + */ + this.refreshDelegate = this.refresh.createDelegate(this); + /** + * Delegate for update() prebound to "this", use myUpdater.updateDelegate.createCallback(arg1, arg2) to bind arguments + * @type Function + */ + this.updateDelegate = this.update.createDelegate(this); + /** + * Delegate for formUpdate() prebound to "this", use myUpdater.formUpdateDelegate.createCallback(arg1, arg2) to bind arguments + * @type Function + */ + this.formUpdateDelegate = this.formUpdate.createDelegate(this); + /** + * @private + */ + this.successDelegate = this.processSuccess.createDelegate(this); + /** + * @private + */ + this.failureDelegate = this.processFailure.createDelegate(this); + + if(!this.renderer){ + /** + * The renderer for this UpdateManager. Defaults to {@link Roo.UpdateManager.BasicRenderer}. + */ + this.renderer = new Roo.UpdateManager.BasicRenderer(); + } + + Roo.UpdateManager.superclass.constructor.call(this); +}; + +Roo.extend(Roo.UpdateManager, Roo.util.Observable, { + /** + * Get the Element this UpdateManager is bound to + * @return {Roo.Element} The element + */ + getEl : function(){ + return this.el; + }, + /** + * Performs an async request, updating this element with the response. If params are specified it uses POST, otherwise it uses GET. + * @param {Object/String/Function} url The url for this request or a function to call to get the url or a config object containing any of the following options: +<pre><code> +um.update({<br/> + url: "your-url.php",<br/> + params: {param1: "foo", param2: "bar"}, // or a URL encoded string<br/> + callback: yourFunction,<br/> + scope: yourObject, //(optional scope) <br/> + discardUrl: false, <br/> + nocache: false,<br/> + text: "Loading...",<br/> + timeout: 30,<br/> + scripts: false<br/> +}); +</code></pre> + * The only required property is url. The optional properties nocache, text and scripts + * are shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this UpdateManager instance. + * @param {String/Object} params (optional) The parameters to pass as either a url encoded string "param1=1&amp;param2=2" or an object {param1: 1, param2: 2} + * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse) + * @param {Boolean} discardUrl (optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url. + */ + update : function(url, params, callback, discardUrl){ + if(this.fireEvent("beforeupdate", this.el, url, params) !== false){ + var method = this.method, + cfg; + if(typeof url == "object"){ // must be config object + cfg = url; + url = cfg.url; + params = params || cfg.params; + callback = callback || cfg.callback; + discardUrl = discardUrl || cfg.discardUrl; + if(callback && cfg.scope){ + callback = callback.createDelegate(cfg.scope); + } + if(typeof cfg.method != "undefined"){method = cfg.method;}; + if(typeof cfg.nocache != "undefined"){this.disableCaching = cfg.nocache;}; + if(typeof cfg.text != "undefined"){this.indicatorText = '<div class="loading-indicator">'+cfg.text+"</div>";}; + if(typeof cfg.scripts != "undefined"){this.loadScripts = cfg.scripts;}; + if(typeof cfg.timeout != "undefined"){this.timeout = cfg.timeout;}; + } + this.showLoading(); + if(!discardUrl){ + this.defaultUrl = url; + } + if(typeof url == "function"){ + url = url.call(this); + } + + method = method || (params ? "POST" : "GET"); + if(method == "GET"){ + url = this.prepareUrl(url); + } + + var o = Roo.apply(cfg ||{}, { + url : url, + params: params, + success: this.successDelegate, + failure: this.failureDelegate, + callback: undefined, + timeout: (this.timeout*1000), + argument: {"url": url, "form": null, "callback": callback, "params": params} + }); + Roo.log("updated manager called with timeout of " + o.timeout); + this.transaction = Roo.Ajax.request(o); + } + }, + + /** + * Performs an async form post, updating this element with the response. If the form has the attribute enctype="multipart/form-data", it assumes it's a file upload. + * Uses this.sslBlankUrl for SSL file uploads to prevent IE security warning. + * @param {String/HTMLElement} form The form Id or form element + * @param {String} url (optional) The url to pass the form to. If omitted the action attribute on the form will be used. + * @param {Boolean} reset (optional) Whether to try to reset the form after the update + * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse) + */ + formUpdate : function(form, url, reset, callback){ + if(this.fireEvent("beforeupdate", this.el, form, url) !== false){ + if(typeof url == "function"){ + url = url.call(this); + } + form = Roo.getDom(form); + this.transaction = Roo.Ajax.request({ + form: form, + url:url, + success: this.successDelegate, + failure: this.failureDelegate, + timeout: (this.timeout*1000), + argument: {"url": url, "form": form, "callback": callback, "reset": reset} + }); + this.showLoading.defer(1, this); + } + }, + + /** + * Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately + * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess) + */ + refresh : function(callback){ + if(this.defaultUrl == null){ + return; + } + this.update(this.defaultUrl, null, callback, true); + }, + + /** + * Set this element to auto refresh. + * @param {Number} interval How often to update (in seconds). + * @param {String/Function} url (optional) The url for this request or a function to call to get the url (Defaults to the last used url) + * @param {String/Object} params (optional) The parameters to pass as either a url encoded string "&param1=1&param2=2" or as an object {param1: 1, param2: 2} + * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess) + * @param {Boolean} refreshNow (optional) Whether to execute the refresh now, or wait the interval + */ + startAutoRefresh : function(interval, url, params, callback, refreshNow){ + if(refreshNow){ + this.update(url || this.defaultUrl, params, callback, true); + } + if(this.autoRefreshProcId){ + clearInterval(this.autoRefreshProcId); + } + this.autoRefreshProcId = setInterval(this.update.createDelegate(this, [url || this.defaultUrl, params, callback, true]), interval*1000); + }, + + /** + * Stop auto refresh on this element. + */ + stopAutoRefresh : function(){ + if(this.autoRefreshProcId){ + clearInterval(this.autoRefreshProcId); + delete this.autoRefreshProcId; + } + }, + + isAutoRefreshing : function(){ + return this.autoRefreshProcId ? true : false; + }, + /** + * Called to update the element to "Loading" state. Override to perform custom action. + */ + showLoading : function(){ + if(this.showLoadIndicator){ + this.el.update(this.indicatorText); + } + }, + + /** + * Adds unique parameter to query string if disableCaching = true + * @private + */ + prepareUrl : function(url){ + if(this.disableCaching){ + var append = "_dc=" + (new Date().getTime()); + if(url.indexOf("?") !== -1){ + url += "&" + append; + }else{ + url += "?" + append; + } + } + return url; + }, + + /** + * @private + */ + processSuccess : function(response){ + this.transaction = null; + if(response.argument.form && response.argument.reset){ + try{ // put in try/catch since some older FF releases had problems with this + response.argument.form.reset(); + }catch(e){} + } + if(this.loadScripts){ + this.renderer.render(this.el, response, this, + this.updateComplete.createDelegate(this, [response])); + }else{ + this.renderer.render(this.el, response, this); + this.updateComplete(response); + } + }, + + updateComplete : function(response){ + this.fireEvent("update", this.el, response); + if(typeof response.argument.callback == "function"){ + response.argument.callback(this.el, true, response); + } + }, + + /** + * @private + */ + processFailure : function(response){ + this.transaction = null; + this.fireEvent("failure", this.el, response); + if(typeof response.argument.callback == "function"){ + response.argument.callback(this.el, false, response); + } + }, + + /** + * Set the content renderer for this UpdateManager. See {@link Roo.UpdateManager.BasicRenderer#render} for more details. + * @param {Object} renderer The object implementing the render() method + */ + setRenderer : function(renderer){ + this.renderer = renderer; + }, + + getRenderer : function(){ + return this.renderer; + }, + + /** + * Set the defaultUrl used for updates + * @param {String/Function} defaultUrl The url or a function to call to get the url + */ + setDefaultUrl : function(defaultUrl){ + this.defaultUrl = defaultUrl; + }, + + /** + * Aborts the executing transaction + */ + abort : function(){ + if(this.transaction){ + Roo.Ajax.abort(this.transaction); + } + }, + + /** + * Returns true if an update is in progress + * @return {Boolean} + */ + isUpdating : function(){ + if(this.transaction){ + return Roo.Ajax.isLoading(this.transaction); + } + return false; + } +}); + +/** + * @class Roo.UpdateManager.defaults + * @static (not really - but it helps the doc tool) + * The defaults collection enables customizing the default properties of UpdateManager + */ + Roo.UpdateManager.defaults = { + /** + * Timeout for requests or form posts in seconds (Defaults 30 seconds). + * @type Number + */ + timeout : 30, + + /** + * True to process scripts by default (Defaults to false). + * @type Boolean + */ + loadScripts : false, + + /** + * Blank page URL to use with SSL file uploads (Defaults to "javascript:false"). + * @type String + */ + sslBlankUrl : (Roo.SSL_SECURE_URL || "javascript:false"), + /** + * Whether to append unique parameter on get request to disable caching (Defaults to false). + * @type Boolean + */ + disableCaching : false, + /** + * Whether to show indicatorText when loading (Defaults to true). + * @type Boolean + */ + showLoadIndicator : true, + /** + * Text for loading indicator (Defaults to '&lt;div class="loading-indicator"&gt;Loading...&lt;/div&gt;'). + * @type String + */ + indicatorText : '<div class="loading-indicator">Loading...</div>' + }; + +/** + * Static convenience method. This method is deprecated in favor of el.load({url:'foo.php', ...}). + *Usage: + * <pre><code>Roo.UpdateManager.updateElement("my-div", "stuff.php");</code></pre> + * @param {String/HTMLElement/Roo.Element} el The element to update + * @param {String} url The url + * @param {String/Object} params (optional) Url encoded param string or an object of name/value pairs + * @param {Object} options (optional) A config object with any of the UpdateManager properties you want to set - for example: {disableCaching:true, indicatorText: "Loading data..."} + * @static + * @deprecated + * @member Roo.UpdateManager + */ +Roo.UpdateManager.updateElement = function(el, url, params, options){ + var um = Roo.get(el, true).getUpdateManager(); + Roo.apply(um, options); + um.update(url, params, options ? options.callback : null); +}; +// alias for backwards compat +Roo.UpdateManager.update = Roo.UpdateManager.updateElement; +/** + * @class Roo.UpdateManager.BasicRenderer + * Default Content renderer. Updates the elements innerHTML with the responseText. + */ +Roo.UpdateManager.BasicRenderer = function(){}; + +Roo.UpdateManager.BasicRenderer.prototype = { + /** + * This is called when the transaction is completed and it's time to update the element - The BasicRenderer + * updates the elements innerHTML with the responseText - To perform a custom render (i.e. XML or JSON processing), + * create an object with a "render(el, response)" method and pass it to setRenderer on the UpdateManager. + * @param {Roo.Element} el The element being rendered + * @param {Object} response The YUI Connect response object + * @param {UpdateManager} updateManager The calling update manager + * @param {Function} callback A callback that will need to be called if loadScripts is true on the UpdateManager + */ + render : function(el, response, updateManager, callback){ + el.update(response.responseText, updateManager.loadScripts, callback); + } +}; + \ No newline at end of file diff --git a/docs2/src/Roo_View.js.html b/docs2/src/Roo_View.js.html new file mode 100644 index 0000000000..52dafc1bee --- /dev/null +++ b/docs2/src/Roo_View.js.html @@ -0,0 +1,697 @@ +/home/alan/gitlive/roojs1/Roo/View.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.View + * @extends Roo.util.Observable + * Create a "View" for an element based on a data model or UpdateManager and the supplied DomHelper template. + * This class also supports single and multi selection modes. <br> + * Create a data model bound view: + <pre><code> + var store = new Roo.data.Store(...); + + var view = new Roo.View({ + el : "my-element", + tpl : '&lt;div id="{0}"&gt;{2} - {1}&lt;/div&gt;', // auto create template + + singleSelect: true, + selectedClass: "ydataview-selected", + store: store + }); + + // listen for node click? + view.on("click", function(vw, index, node, e){ + alert('Node "' + node.id + '" at index: ' + index + " was clicked."); + }); + + // load XML data + dataModel.load("foobar.xml"); + </code></pre> + For an example of creating a JSON/UpdateManager view, see {@link Roo.JsonView}. + * <br><br> + * <b>Note: The root of your template must be a single node. Table/row implementations may work but are not supported due to + * IE"s limited insertion support with tables and Opera"s faulty event bubbling.</b> + * + * Note: old style constructor is still suported (container, template, config) + * + * @constructor + * Create a new View + * @param {Object} config The config object + * + */ +Roo.View = function(config, depreciated_tpl, depreciated_config){ + + this.parent = false; + + if (typeof(depreciated_tpl) == 'undefined') { + // new way.. - universal constructor. + Roo.apply(this, config); + this.el = Roo.get(this.el); + } else { + // old format.. + this.el = Roo.get(config); + this.tpl = depreciated_tpl; + Roo.apply(this, depreciated_config); + } + this.wrapEl = this.el.wrap().wrap(); + ///this.el = this.wrapEla.appendChild(document.createElement("div")); + + + if(typeof(this.tpl) == "string"){ + this.tpl = new Roo.Template(this.tpl); + } else { + // support xtype ctors.. + this.tpl = new Roo.factory(this.tpl, Roo); + } + + + this.tpl.compile(); + + /** @private */ + this.addEvents({ + /** + * @event beforeclick + * Fires before a click is processed. Returns false to cancel the default action. + * @param {Roo.View} this + * @param {Number} index The index of the target node + * @param {HTMLElement} node The target node + * @param {Roo.EventObject} e The raw event object + */ + "beforeclick" : true, + /** + * @event click + * Fires when a template node is clicked. + * @param {Roo.View} this + * @param {Number} index The index of the target node + * @param {HTMLElement} node The target node + * @param {Roo.EventObject} e The raw event object + */ + "click" : true, + /** + * @event dblclick + * Fires when a template node is double clicked. + * @param {Roo.View} this + * @param {Number} index The index of the target node + * @param {HTMLElement} node The target node + * @param {Roo.EventObject} e The raw event object + */ + "dblclick" : true, + /** + * @event contextmenu + * Fires when a template node is right clicked. + * @param {Roo.View} this + * @param {Number} index The index of the target node + * @param {HTMLElement} node The target node + * @param {Roo.EventObject} e The raw event object + */ + "contextmenu" : true, + /** + * @event selectionchange + * Fires when the selected nodes change. + * @param {Roo.View} this + * @param {Array} selections Array of the selected nodes + */ + "selectionchange" : true, + + /** + * @event beforeselect + * Fires before a selection is made. If any handlers return false, the selection is cancelled. + * @param {Roo.View} this + * @param {HTMLElement} node The node to be selected + * @param {Array} selections Array of currently selected nodes + */ + "beforeselect" : true, + /** + * @event preparedata + * Fires on every row to render, to allow you to change the data. + * @param {Roo.View} this + * @param {Object} data to be rendered (change this) + */ + "preparedata" : true + + + }); + + + + this.el.on({ + "click": this.onClick, + "dblclick": this.onDblClick, + "contextmenu": this.onContextMenu, + scope:this + }); + + this.selections = []; + this.nodes = []; + this.cmp = new Roo.CompositeElementLite([]); + if(this.store){ + this.store = Roo.factory(this.store, Roo.data); + this.setStore(this.store, true); + } + + if ( this.footer && this.footer.xtype) { + + var fctr = this.wrapEl.appendChild(document.createElement("div")); + + this.footer.dataSource = this.store; + this.footer.container = fctr; + this.footer = Roo.factory(this.footer, Roo); + fctr.insertFirst(this.el); + + // this is a bit insane - as the paging toolbar seems to detach the el.. +// dom.parentNode.parentNode.parentNode + // they get detached? + } + + + Roo.View.superclass.constructor.call(this); + + +}; + +Roo.extend(Roo.View, Roo.util.Observable, { + + /** + * @cfg {Roo.data.Store} store Data store to load data from. + */ + store : false, + + /** + * @cfg {String|Roo.Element} el The container element. + */ + el : '', + + /** + * @cfg {String|Roo.Template} tpl The template used by this View + */ + tpl : false, + /** + * @cfg {String} dataName the named area of the template to use as the data area + * Works with domtemplates roo-name="name" + */ + dataName: false, + /** + * @cfg {String} selectedClass The css class to add to selected nodes + */ + selectedClass : "x-view-selected", + /** + * @cfg {String} emptyText The empty text to show when nothing is loaded. + */ + emptyText : "", + + /** + * @cfg {String} text to display on mask (default Loading) + */ + mask : false, + /** + * @cfg {Boolean} multiSelect Allow multiple selection + */ + multiSelect : false, + /** + * @cfg {Boolean} singleSelect Allow single selection + */ + singleSelect: false, + + /** + * @cfg {Boolean} toggleSelect - selecting + */ + toggleSelect : false, + + /** + * @cfg {Boolean} tickable - selecting + */ + tickable : false, + + /** + * Returns the element this view is bound to. + * @return {Roo.Element} + */ + getEl : function(){ + return this.wrapEl; + }, + + + + /** + * Refreshes the view. - called by datachanged on the store. - do not call directly. + */ + refresh : function(){ + //Roo.log('refresh'); + var t = this.tpl; + + // if we are using something like 'domtemplate', then + // the what gets used is: + // t.applySubtemplate(NAME, data, wrapping data..) + // the outer template then get' applied with + // the store 'extra data' + // and the body get's added to the + // roo-name="data" node? + // <span class='roo-tpl-{name}'></span> ????? + + + + this.clearSelections(); + this.el.update(""); + var html = []; + var records = this.store.getRange(); + if(records.length < 1) { + + // is this valid?? = should it render a template?? + + this.el.update(this.emptyText); + return; + } + var el = this.el; + if (this.dataName) { + this.el.update(t.apply(this.store.meta)); //???? + el = this.el.child('.roo-tpl-' + this.dataName); + } + + for(var i = 0, len = records.length; i < len; i++){ + var data = this.prepareData(records[i].data, i, records[i]); + this.fireEvent("preparedata", this, data, i, records[i]); + + var d = Roo.apply({}, data); + + if(this.tickable){ + Roo.apply(d, {'roo-id' : Roo.id()}); + + var _this = this; + + Roo.each(this.parent.item, function(item){ + if(item[_this.parent.valueField] != data[_this.parent.valueField]){ + return; + } + Roo.apply(d, {'roo-data-checked' : 'checked'}); + }); + } + + html[html.length] = Roo.util.Format.trim( + this.dataName ? + t.applySubtemplate(this.dataName, d, this.store.meta) : + t.apply(d) + ); + } + + + + el.update(html.join("")); + this.nodes = el.dom.childNodes; + this.updateIndexes(0); + }, + + + /** + * Function to override to reformat the data that is sent to + * the template for each node. + * DEPRICATED - use the preparedata event handler. + * @param {Array/Object} data The raw data (array of colData for a data model bound view or + * a JSON object for an UpdateManager bound view). + */ + prepareData : function(data, index, record) + { + this.fireEvent("preparedata", this, data, index, record); + return data; + }, + + onUpdate : function(ds, record){ + // Roo.log('on update'); + this.clearSelections(); + var index = this.store.indexOf(record); + var n = this.nodes[index]; + this.tpl.insertBefore(n, this.prepareData(record.data, index, record)); + n.parentNode.removeChild(n); + this.updateIndexes(index, index); + }, + + + +// --------- FIXME + onAdd : function(ds, records, index) + { + //Roo.log(['on Add', ds, records, index] ); + this.clearSelections(); + if(this.nodes.length == 0){ + this.refresh(); + return; + } + var n = this.nodes[index]; + for(var i = 0, len = records.length; i < len; i++){ + var d = this.prepareData(records[i].data, i, records[i]); + if(n){ + this.tpl.insertBefore(n, d); + }else{ + + this.tpl.append(this.el, d); + } + } + this.updateIndexes(index); + }, + + onRemove : function(ds, record, index){ + // Roo.log('onRemove'); + this.clearSelections(); + var el = this.dataName ? + this.el.child('.roo-tpl-' + this.dataName) : + this.el; + + el.dom.removeChild(this.nodes[index]); + this.updateIndexes(index); + }, + + /** + * Refresh an individual node. + * @param {Number} index + */ + refreshNode : function(index){ + this.onUpdate(this.store, this.store.getAt(index)); + }, + + updateIndexes : function(startIndex, endIndex){ + var ns = this.nodes; + startIndex = startIndex || 0; + endIndex = endIndex || ns.length - 1; + for(var i = startIndex; i <= endIndex; i++){ + ns[i].nodeIndex = i; + } + }, + + /** + * Changes the data store this view uses and refresh the view. + * @param {Store} store + */ + setStore : function(store, initial){ + if(!initial && this.store){ + this.store.un("datachanged", this.refresh); + this.store.un("add", this.onAdd); + this.store.un("remove", this.onRemove); + this.store.un("update", this.onUpdate); + this.store.un("clear", this.refresh); + this.store.un("beforeload", this.onBeforeLoad); + this.store.un("load", this.onLoad); + this.store.un("loadexception", this.onLoad); + } + if(store){ + + store.on("datachanged", this.refresh, this); + store.on("add", this.onAdd, this); + store.on("remove", this.onRemove, this); + store.on("update", this.onUpdate, this); + store.on("clear", this.refresh, this); + store.on("beforeload", this.onBeforeLoad, this); + store.on("load", this.onLoad, this); + store.on("loadexception", this.onLoad, this); + } + + if(store){ + this.refresh(); + } + }, + /** + * onbeforeLoad - masks the loading area. + * + */ + onBeforeLoad : function(store,opts) + { + //Roo.log('onBeforeLoad'); + if (!opts.add) { + this.el.update(""); + } + this.el.mask(this.mask ? this.mask : "Loading" ); + }, + onLoad : function () + { + this.el.unmask(); + }, + + + /** + * Returns the template node the passed child belongs to or null if it doesn't belong to one. + * @param {HTMLElement} node + * @return {HTMLElement} The template node + */ + findItemFromChild : function(node){ + var el = this.dataName ? + this.el.child('.roo-tpl-' + this.dataName,true) : + this.el.dom; + + if(!node || node.parentNode == el){ + return node; + } + var p = node.parentNode; + while(p && p != el){ + if(p.parentNode == el){ + return p; + } + p = p.parentNode; + } + return null; + }, + + /** @ignore */ + onClick : function(e){ + var item = this.findItemFromChild(e.getTarget()); + if(item){ + var index = this.indexOf(item); + if(this.onItemClick(item, index, e) !== false){ + this.fireEvent("click", this, index, item, e); + } + }else{ + this.clearSelections(); + } + }, + + /** @ignore */ + onContextMenu : function(e){ + var item = this.findItemFromChild(e.getTarget()); + if(item){ + this.fireEvent("contextmenu", this, this.indexOf(item), item, e); + } + }, + + /** @ignore */ + onDblClick : function(e){ + var item = this.findItemFromChild(e.getTarget()); + if(item){ + this.fireEvent("dblclick", this, this.indexOf(item), item, e); + } + }, + + onItemClick : function(item, index, e) + { + if(this.fireEvent("beforeclick", this, index, item, e) === false){ + return false; + } + if (this.toggleSelect) { + var m = this.isSelected(item) ? 'unselect' : 'select'; + //Roo.log(m); + var _t = this; + _t[m](item, true, false); + return true; + } + if(this.multiSelect || this.singleSelect){ + if(this.multiSelect && e.shiftKey && this.lastSelection){ + this.select(this.getNodes(this.indexOf(this.lastSelection), index), false); + }else{ + this.select(item, this.multiSelect && e.ctrlKey); + this.lastSelection = item; + } + + if(!this.tickable){ + e.preventDefault(); + } + + } + return true; + }, + + /** + * Get the number of selected nodes. + * @return {Number} + */ + getSelectionCount : function(){ + return this.selections.length; + }, + + /** + * Get the currently selected nodes. + * @return {Array} An array of HTMLElements + */ + getSelectedNodes : function(){ + return this.selections; + }, + + /** + * Get the indexes of the selected nodes. + * @return {Array} + */ + getSelectedIndexes : function(){ + var indexes = [], s = this.selections; + for(var i = 0, len = s.length; i < len; i++){ + indexes.push(s[i].nodeIndex); + } + return indexes; + }, + + /** + * Clear all selections + * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange event + */ + clearSelections : function(suppressEvent){ + if(this.nodes && (this.multiSelect || this.singleSelect) && this.selections.length > 0){ + this.cmp.elements = this.selections; + this.cmp.removeClass(this.selectedClass); + this.selections = []; + if(!suppressEvent){ + this.fireEvent("selectionchange", this, this.selections); + } + } + }, + + /** + * Returns true if the passed node is selected + * @param {HTMLElement/Number} node The node or node index + * @return {Boolean} + */ + isSelected : function(node){ + var s = this.selections; + if(s.length < 1){ + return false; + } + node = this.getNode(node); + return s.indexOf(node) !== -1; + }, + + /** + * Selects nodes. + * @param {Array/HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select + * @param {Boolean} keepExisting (optional) true to keep existing selections + * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent + */ + select : function(nodeInfo, keepExisting, suppressEvent){ + if(nodeInfo instanceof Array){ + if(!keepExisting){ + this.clearSelections(true); + } + for(var i = 0, len = nodeInfo.length; i < len; i++){ + this.select(nodeInfo[i], true, true); + } + return; + } + var node = this.getNode(nodeInfo); + if(!node || this.isSelected(node)){ + return; // already selected. + } + if(!keepExisting){ + this.clearSelections(true); + } + + if(this.fireEvent("beforeselect", this, node, this.selections) !== false){ + Roo.fly(node).addClass(this.selectedClass); + this.selections.push(node); + if(!suppressEvent){ + this.fireEvent("selectionchange", this, this.selections); + } + } + + + }, + /** + * Unselects nodes. + * @param {Array/HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select + * @param {Boolean} keepExisting (optional) true IGNORED (for campatibility with select) + * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent + */ + unselect : function(nodeInfo, keepExisting, suppressEvent) + { + if(nodeInfo instanceof Array){ + Roo.each(this.selections, function(s) { + this.unselect(s, nodeInfo); + }, this); + return; + } + var node = this.getNode(nodeInfo); + if(!node || !this.isSelected(node)){ + //Roo.log("not selected"); + return; // not selected. + } + // fireevent??? + var ns = []; + Roo.each(this.selections, function(s) { + if (s == node ) { + Roo.fly(node).removeClass(this.selectedClass); + + return; + } + ns.push(s); + },this); + + this.selections= ns; + this.fireEvent("selectionchange", this, this.selections); + }, + + /** + * Gets a template node. + * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node + * @return {HTMLElement} The node or null if it wasn't found + */ + getNode : function(nodeInfo){ + if(typeof nodeInfo == "string"){ + return document.getElementById(nodeInfo); + }else if(typeof nodeInfo == "number"){ + return this.nodes[nodeInfo]; + } + return nodeInfo; + }, + + /** + * Gets a range template nodes. + * @param {Number} startIndex + * @param {Number} endIndex + * @return {Array} An array of nodes + */ + getNodes : function(start, end){ + var ns = this.nodes; + start = start || 0; + end = typeof end == "undefined" ? ns.length - 1 : end; + var nodes = []; + if(start <= end){ + for(var i = start; i <= end; i++){ + nodes.push(ns[i]); + } + } else{ + for(var i = start; i >= end; i--){ + nodes.push(ns[i]); + } + } + return nodes; + }, + + /** + * Finds the index of the passed node + * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node + * @return {Number} The index of the node or -1 + */ + indexOf : function(node){ + node = this.getNode(node); + if(typeof node.nodeIndex == "number"){ + return node.nodeIndex; + } + var ns = this.nodes; + for(var i = 0, len = ns.length; i < len; i++){ + if(ns[i] == node){ + return i; + } + } + return -1; + } +}); + \ No newline at end of file diff --git a/docs2/src/Roo_XComponent.js.html b/docs2/src/Roo_XComponent.js.html new file mode 100644 index 0000000000..2e51756bb2 --- /dev/null +++ b/docs2/src/Roo_XComponent.js.html @@ -0,0 +1,757 @@ +/home/alan/gitlive/roojs1/Roo/XComponent.js/* + * Original code for Roojs - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.XComponent + * A delayed Element creator... + * Or a way to group chunks of interface together. + * technically this is a wrapper around a tree of Roo elements (which defines a 'module'), + * used in conjunction with XComponent.build() it will create an instance of each element, + * then call addxtype() to build the User interface. + * + * Mypart.xyx = new Roo.XComponent({ + + parent : 'Mypart.xyz', // empty == document.element.!! + order : '001', + name : 'xxxx' + region : 'xxxx' + disabled : function() {} + + tree : function() { // return an tree of xtype declared components + var MODULE = this; + return + { + xtype : 'NestedLayoutPanel', + // technicall + } + ] + *}) + * + * + * It can be used to build a big heiracy, with parent etc. + * or you can just use this to render a single compoent to a dom element + * MYPART.render(Roo.Element | String(id) | dom_element ) + * + * + * Usage patterns. + * + * Classic Roo + * + * Roo is designed primarily as a single page application, so the UI build for a standard interface will + * expect a single 'TOP' level module normally indicated by the 'parent' of the XComponent definition being defined as false. + * + * Each sub module is expected to have a parent pointing to the class name of it's parent module. + * + * When the top level is false, a 'Roo.BorderLayout' is created and the element is flagged as 'topModule' + * - if mulitple topModules exist, the last one is defined as the top module. + * + * Embeded Roo + * + * When the top level or multiple modules are to embedded into a existing HTML page, + * the parent element can container '#id' of the element where the module will be drawn. + * + * Bootstrap Roo + * + * Unlike classic Roo, the bootstrap tends not to be used as a single page. + * it relies more on a include mechanism, where sub modules are included into an outer page. + * This is normally managed by the builder tools using Roo.apply( options, Included.Sub.Module ) + * + * Bootstrap Roo Included elements + * + * Our builder application needs the ability to preview these sub compoennts. They will normally have parent=false set, + * hence confusing the component builder as it thinks there are multiple top level elements. + * + * String Over-ride & Translations + * + * Our builder application writes all the strings as _strings and _named_strings. This is to enable the translation of elements, + * and also the 'overlaying of string values - needed when different versions of the same application with different text content + * are needed. @see Roo.XComponent.overlayString + * + * + * + * @extends Roo.util.Observable + * @constructor + * @param cfg {Object} configuration of component + * + */ +Roo.XComponent = function(cfg) { + Roo.apply(this, cfg); + this.addEvents({ + /** + * @event built + * Fires when this the componnt is built + * @param {Roo.XComponent} c the component + */ + 'built' : true + + }); + this.region = this.region || 'center'; // default.. + Roo.XComponent.register(this); + this.modules = false; + this.el = false; // where the layout goes.. + + +} +Roo.extend(Roo.XComponent, Roo.util.Observable, { + /** + * @property el + * The created element (with Roo.factory()) + * @type {Roo.Layout} + */ + el : false, + + /** + * @property el + * for BC - use el in new code + * @type {Roo.Layout} + */ + panel : false, + + /** + * @property layout + * for BC - use el in new code + * @type {Roo.Layout} + */ + layout : false, + + /** + * @cfg {Function|boolean} disabled + * If this module is disabled by some rule, return true from the funtion + */ + disabled : false, + + /** + * @cfg {String} parent + * Name of parent element which it get xtype added to.. + */ + parent: false, + + /** + * @cfg {String} order + * Used to set the order in which elements are created (usefull for multiple tabs) + */ + + order : false, + /** + * @cfg {String} name + * String to display while loading. + */ + name : false, + /** + * @cfg {String} region + * Region to render component to (defaults to center) + */ + region : 'center', + + /** + * @cfg {Array} items + * A single item array - the first element is the root of the tree.. + * It's done this way to stay compatible with the Xtype system... + */ + items : false, + + /** + * @property _tree + * The method that retuns the tree of parts that make up this compoennt + * @type {function} + */ + _tree : false, + + /** + * render + * render element to dom or tree + * @param {Roo.Element|String|DomElement} optional render to if parent is not set. + */ + + render : function(el) + { + + el = el || false; + var hp = this.parent ? 1 : 0; + Roo.debug && Roo.log(this); + + var tree = this._tree ? this._tree() : this.tree(); + + + if (!el && typeof(this.parent) == 'string' && this.parent.substring(0,1) == '#') { + // if parent is a '#.....' string, then let's use that.. + var ename = this.parent.substr(1); + this.parent = false; + Roo.debug && Roo.log(ename); + switch (ename) { + case 'bootstrap-body': + if (typeof(tree.el) != 'undefined' && tree.el == document.body) { + // this is the BorderLayout standard? + this.parent = { el : true }; + break; + } + if (["Nest", "Content", "Grid", "Tree"].indexOf(tree.xtype) > -1) { + // need to insert stuff... + this.parent = { + el : new Roo.bootstrap.layout.Border({ + el : document.body, + + center: { + titlebar: false, + autoScroll:false, + closeOnTab: true, + tabPosition: 'top', + //resizeTabs: true, + alwaysShowTabs: true, + hideTabs: false + //minTabWidth: 140 + } + }) + + }; + break; + } + + if (typeof(Roo.bootstrap.Body) != 'undefined' ) { + this.parent = { el : new Roo.bootstrap.Body() }; + Roo.debug && Roo.log("setting el to doc body"); + + } else { + throw "Container is bootstrap body, but Roo.bootstrap.Body is not defined"; + } + break; + case 'bootstrap': + this.parent = { el : true}; + // fall through + default: + el = Roo.get(ename); + if (typeof(Roo.bootstrap) != 'undefined' && tree['|xns'] == 'Roo.bootstrap') { + this.parent = { el : true}; + } + + break; + } + + + if (!el && !this.parent) { + Roo.debug && Roo.log("Warning - element can not be found :#" + ename ); + return; + } + } + + Roo.debug && Roo.log("EL:"); + Roo.debug && Roo.log(el); + Roo.debug && Roo.log("this.parent.el:"); + Roo.debug && Roo.log(this.parent.el); + + + // altertive root elements ??? - we need a better way to indicate these. + var is_alt = Roo.XComponent.is_alt || + (typeof(tree.el) != 'undefined' && tree.el == document.body) || + (typeof(Roo.bootstrap) != 'undefined' && tree.xns == Roo.bootstrap) || + (typeof(Roo.mailer) != 'undefined' && tree.xns == Roo.mailer) ; + + + + if (!this.parent && is_alt) { + //el = Roo.get(document.body); + this.parent = { el : true }; + } + + + + if (!this.parent) { + + Roo.debug && Roo.log("no parent - creating one"); + + el = el ? Roo.get(el) : false; + + if (typeof(Roo.BorderLayout) == 'undefined' ) { + + this.parent = { + el : new Roo.bootstrap.layout.Border({ + el: el || document.body, + + center: { + titlebar: false, + autoScroll:false, + closeOnTab: true, + tabPosition: 'top', + //resizeTabs: true, + alwaysShowTabs: false, + hideTabs: true, + minTabWidth: 140, + overflow: 'visible' + } + }) + }; + } else { + + // it's a top level one.. + this.parent = { + el : new Roo.BorderLayout(el || document.body, { + center: { + titlebar: false, + autoScroll:false, + closeOnTab: true, + tabPosition: 'top', + //resizeTabs: true, + alwaysShowTabs: el && hp? false : true, + hideTabs: el || !hp ? true : false, + minTabWidth: 140 + } + }) + }; + } + } + + if (!this.parent.el) { + // probably an old style ctor, which has been disabled. + return; + + } + // The 'tree' method is '_tree now' + + tree.region = tree.region || this.region; + var is_body = false; + if (this.parent.el === true) { + // bootstrap... - body.. + if (el) { + tree.el = el; + } + this.parent.el = Roo.factory(tree); + is_body = true; + } + + this.el = this.parent.el.addxtype(tree, undefined, is_body); + this.fireEvent('built', this); + + this.panel = this.el; + this.layout = this.panel.layout; + this.parentLayout = this.parent.layout || false; + + } + +}); + +Roo.apply(Roo.XComponent, { + /** + * @property hideProgress + * true to disable the building progress bar.. usefull on single page renders. + * @type Boolean + */ + hideProgress : false, + /** + * @property buildCompleted + * True when the builder has completed building the interface. + * @type Boolean + */ + buildCompleted : false, + + /** + * @property topModule + * the upper most module - uses document.element as it's constructor. + * @type Object + */ + + topModule : false, + + /** + * @property modules + * array of modules to be created by registration system. + * @type {Array} of Roo.XComponent + */ + + modules : [], + /** + * @property elmodules + * array of modules to be created by which use #ID + * @type {Array} of Roo.XComponent + */ + + elmodules : [], + + /** + * @property is_alt + * Is an alternative Root - normally used by bootstrap or other systems, + * where the top element in the tree can wrap 'body' + * @type {boolean} (default false) + */ + + is_alt : false, + /** + * @property build_from_html + * Build elements from html - used by bootstrap HTML stuff + * - this is cleared after build is completed + * @type {boolean} (default false) + */ + + build_from_html : false, + /** + * Register components to be built later. + * + * This solves the following issues + * - Building is not done on page load, but after an authentication process has occured. + * - Interface elements are registered on page load + * - Parent Interface elements may not be loaded before child, so this handles that.. + * + * + * example: + * + * MyApp.register({ + order : '000001', + module : 'Pman.Tab.projectMgr', + region : 'center', + parent : 'Pman.layout', + disabled : false, // or use a function.. + }) + + * * @param {Object} details about module + */ + register : function(obj) { + + Roo.XComponent.event.fireEvent('register', obj); + switch(typeof(obj.disabled) ) { + + case 'undefined': + break; + + case 'function': + if ( obj.disabled() ) { + return; + } + break; + + default: + if (obj.disabled || obj.region == '#disabled') { + return; + } + break; + } + + this.modules.push(obj); + + }, + /** + * convert a string to an object.. + * eg. 'AAA.BBB' -> finds AAA.BBB + + */ + + toObject : function(str) + { + if (!str || typeof(str) == 'object') { + return str; + } + if (str.substring(0,1) == '#') { + return str; + } + + var ar = str.split('.'); + var rt, o; + rt = ar.shift(); + /** eval:var:o */ + try { + eval('if (typeof ' + rt + ' == "undefined"){ o = false;} o = ' + rt + ';'); + } catch (e) { + throw "Module not found : " + str; + } + + if (o === false) { + throw "Module not found : " + str; + } + Roo.each(ar, function(e) { + if (typeof(o[e]) == 'undefined') { + throw "Module not found : " + str; + } + o = o[e]; + }); + + return o; + + }, + + + /** + * move modules into their correct place in the tree.. + * + */ + preBuild : function () + { + var _t = this; + Roo.each(this.modules , function (obj) + { + Roo.XComponent.event.fireEvent('beforebuild', obj); + + var opar = obj.parent; + try { + obj.parent = this.toObject(opar); + } catch(e) { + Roo.debug && Roo.log("parent:toObject failed: " + e.toString()); + return; + } + + if (!obj.parent) { + Roo.debug && Roo.log("GOT top level module"); + Roo.debug && Roo.log(obj); + obj.modules = new Roo.util.MixedCollection(false, + function(o) { return o.order + '' } + ); + this.topModule = obj; + return; + } + // parent is a string (usually a dom element name..) + if (typeof(obj.parent) == 'string') { + this.elmodules.push(obj); + return; + } + if (obj.parent.constructor != Roo.XComponent) { + Roo.debug && Roo.log("Warning : Object Parent is not instance of XComponent:" + obj.name) + } + if (!obj.parent.modules) { + obj.parent.modules = new Roo.util.MixedCollection(false, + function(o) { return o.order + '' } + ); + } + if (obj.parent.disabled) { + obj.disabled = true; + } + obj.parent.modules.add(obj); + }, this); + }, + + /** + * make a list of modules to build. + * @return {Array} list of modules. + */ + + buildOrder : function() + { + var _this = this; + var cmp = function(a,b) { + return String(a).toUpperCase() > String(b).toUpperCase() ? 1 : -1; + }; + if ((!this.topModule || !this.topModule.modules) && !this.elmodules.length) { + throw "No top level modules to build"; + } + + // make a flat list in order of modules to build. + var mods = this.topModule ? [ this.topModule ] : []; + + + // elmodules (is a list of DOM based modules ) + Roo.each(this.elmodules, function(e) { + mods.push(e); + if (!this.topModule && + typeof(e.parent) == 'string' && + e.parent.substring(0,1) == '#' && + Roo.get(e.parent.substr(1)) + ) { + + _this.topModule = e; + } + + }); + + + // add modules to their parents.. + var addMod = function(m) { + Roo.debug && Roo.log("build Order: add: " + m.name); + + mods.push(m); + if (m.modules && !m.disabled) { + Roo.debug && Roo.log("build Order: " + m.modules.length + " child modules"); + m.modules.keySort('ASC', cmp ); + Roo.debug && Roo.log("build Order: " + m.modules.length + " child modules (after sort)"); + + m.modules.each(addMod); + } else { + Roo.debug && Roo.log("build Order: no child modules"); + } + // not sure if this is used any more.. + if (m.finalize) { + m.finalize.name = m.name + " (clean up) "; + mods.push(m.finalize); + } + + } + if (this.topModule && this.topModule.modules) { + this.topModule.modules.keySort('ASC', cmp ); + this.topModule.modules.each(addMod); + } + return mods; + }, + + /** + * Build the registered modules. + * @param {Object} parent element. + * @param {Function} optional method to call after module has been added. + * + */ + + build : function(opts) + { + + if (typeof(opts) != 'undefined') { + Roo.apply(this,opts); + } + + this.preBuild(); + var mods = this.buildOrder(); + + //this.allmods = mods; + //Roo.debug && Roo.log(mods); + //return; + if (!mods.length) { // should not happen + throw "NO modules!!!"; + } + + + var msg = "Building Interface..."; + // flash it up as modal - so we store the mask!? + if (!this.hideProgress && Roo.MessageBox) { + Roo.MessageBox.show({ title: 'loading' }); + Roo.MessageBox.show({ + title: "Please wait...", + msg: msg, + width:450, + progress:true, + buttons : false, + closable:false, + modal: false + + }); + } + var total = mods.length; + + var _this = this; + var progressRun = function() { + if (!mods.length) { + Roo.debug && Roo.log('hide?'); + if (!this.hideProgress && Roo.MessageBox) { + Roo.MessageBox.hide(); + } + Roo.XComponent.build_from_html = false; // reset, so dialogs will be build from javascript + + Roo.XComponent.event.fireEvent('buildcomplete', _this.topModule); + + // THE END... + return false; + } + + var m = mods.shift(); + + + Roo.debug && Roo.log(m); + // not sure if this is supported any more.. - modules that are are just function + if (typeof(m) == 'function') { + m.call(this); + return progressRun.defer(10, _this); + } + + + msg = "Building Interface " + (total - mods.length) + + " of " + total + + (m.name ? (' - ' + m.name) : ''); + Roo.debug && Roo.log(msg); + if (!_this.hideProgress && Roo.MessageBox) { + Roo.MessageBox.updateProgress( (total - mods.length)/total, msg ); + } + + + // is the module disabled? + var disabled = (typeof(m.disabled) == 'function') ? + m.disabled.call(m.module.disabled) : m.disabled; + + + if (disabled) { + return progressRun(); // we do not update the display! + } + + // now build + + + + m.render(); + // it's 10 on top level, and 1 on others??? why... + return progressRun.defer(10, _this); + + } + progressRun.defer(1, _this); + + + + }, + /** + * Overlay a set of modified strings onto a component + * This is dependant on our builder exporting the strings and 'named strings' elements. + * + * @param {Object} element to overlay on - eg. Pman.Dialog.Login + * @param {Object} associative array of 'named' string and it's new value. + * + */ + overlayStrings : function( component, strings ) + { + if (typeof(component['_named_strings']) == 'undefined') { + throw "ERROR: component does not have _named_strings"; + } + for ( var k in strings ) { + var md = typeof(component['_named_strings'][k]) == 'undefined' ? false : component['_named_strings'][k]; + if (md !== false) { + component['_strings'][md] = strings[k]; + } else { + Roo.log('could not find named string: ' + k + ' in'); + Roo.log(component); + } + + } + + }, + + + /** + * Event Object. + * + * + */ + event: false, + /** + * wrapper for event.on - aliased later.. + * Typically use to register a event handler for register: + * + * eg. Roo.XComponent.on('register', function(comp) { comp.disable = true } ); + * + */ + on : false + + + +}); + +Roo.XComponent.event = new Roo.util.Observable({ + events : { + /** + * @event register + * Fires when an Component is registered, + * set the disable property on the Component to stop registration. + * @param {Roo.XComponent} c the component being registerd. + * + */ + 'register' : true, + /** + * @event beforebuild + * Fires before each Component is built + * can be used to apply permissions. + * @param {Roo.XComponent} c the component being registerd. + * + */ + 'beforebuild' : true, + /** + * @event buildcomplete + * Fires on the top level element when all elements have been built + * @param {Roo.XComponent} the top level component. + */ + 'buildcomplete' : true + + } +}); + +Roo.XComponent.on = Roo.XComponent.event.on.createDelegate(Roo.XComponent.event); + \ No newline at end of file diff --git a/docs2/src/Roo_XTemplate.js.html b/docs2/src/Roo_XTemplate.js.html new file mode 100644 index 0000000000..94e1e89cbc --- /dev/null +++ b/docs2/src/Roo_XTemplate.js.html @@ -0,0 +1,319 @@ +/home/alan/gitlive/roojs1/Roo/XTemplate.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.XTemplate + * @extends Roo.Template + * Provides a template that can have nested templates for loops or conditionals. The syntax is: +<pre><code> +var t = new Roo.XTemplate( + '&lt;select name="{name}"&gt;', + '&lt;tpl for="options"&gt;&lt;option value="{value:trim}"&gt;{text:ellipsis(10)}&lt;/option&gt;&lt;/tpl&gt;', + '&lt;/select&gt;' +); + +// then append, applying the master template values + </code></pre> + * + * Supported features: + * + * Tags: + +<pre><code> + {a_variable} - output encoded. + {a_variable.format:("Y-m-d")} - call a method on the variable + {a_variable:raw} - unencoded output + {a_variable:toFixed(1,2)} - Roo.util.Format."toFixed" + {a_variable:this.method_on_template(...)} - call a method on the template object. + +</code></pre> + * The tpl tag: +<pre><code> + &lt;tpl for="a_variable or condition.."&gt;&lt;/tpl&gt; + &lt;tpl if="a_variable or condition"&gt;&lt;/tpl&gt; + &lt;tpl exec="some javascript"&gt;&lt;/tpl&gt; + &lt;tpl name="named_template"&gt;&lt;/tpl&gt; (experimental) + + &lt;tpl for="."&gt;&lt;/tpl&gt; - just iterate the property.. + &lt;tpl for=".."&gt;&lt;/tpl&gt; - iterates with the parent (probably the template) +</code></pre> + * + */ +Roo.XTemplate = function() +{ + Roo.XTemplate.superclass.constructor.apply(this, arguments); + if (this.html) { + this.compile(); + } +}; + + +Roo.extend(Roo.XTemplate, Roo.Template, { + + /** + * The various sub templates + */ + tpls : false, + /** + * + * basic tag replacing syntax + * WORD:WORD() + * + * // you can fake an object call by doing this + * x.t:(test,tesT) + * + */ + re : /\{([\w-\.]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?\}/g, + + /** + * compile the template + * + * This is not recursive, so I'm not sure how nested templates are really going to be handled.. + * + */ + compile: function() + { + var s = this.html; + + s = ['<tpl>', s, '</tpl>'].join(''); + + var re = /<tpl\b[^>]*>((?:(?=([^<]+))\2|<(?!tpl\b[^>]*>))*?)<\/tpl>/, + nameRe = /^<tpl\b[^>]*?for="(.*?)"/, + ifRe = /^<tpl\b[^>]*?if="(.*?)"/, + execRe = /^<tpl\b[^>]*?exec="(.*?)"/, + namedRe = /^<tpl\b[^>]*?name="(\w+)"/, // named templates.. + m, + id = 0, + tpls = []; + + while(true == !!(m = s.match(re))){ + var forMatch = m[0].match(nameRe), + ifMatch = m[0].match(ifRe), + execMatch = m[0].match(execRe), + namedMatch = m[0].match(namedRe), + + exp = null, + fn = null, + exec = null, + name = forMatch && forMatch[1] ? forMatch[1] : ''; + + if (ifMatch) { + // if - puts fn into test.. + exp = ifMatch && ifMatch[1] ? ifMatch[1] : null; + if(exp){ + fn = new Function('values', 'parent', 'with(values){ return '+(Roo.util.Format.htmlDecode(exp))+'; }'); + } + } + + if (execMatch) { + // exec - calls a function... returns empty if true is returned. + exp = execMatch && execMatch[1] ? execMatch[1] : null; + if(exp){ + exec = new Function('values', 'parent', 'with(values){ '+(Roo.util.Format.htmlDecode(exp))+'; }'); + } + } + + + if (name) { + // for = + switch(name){ + case '.': name = new Function('values', 'parent', 'with(values){ return values; }'); break; + case '..': name = new Function('values', 'parent', 'with(values){ return parent; }'); break; + default: name = new Function('values', 'parent', 'with(values){ return '+name+'; }'); + } + } + var uid = namedMatch ? namedMatch[1] : id; + + + tpls.push({ + id: namedMatch ? namedMatch[1] : id, + target: name, + exec: exec, + test: fn, + body: m[1] || '' + }); + if (namedMatch) { + s = s.replace(m[0], ''); + } else { + s = s.replace(m[0], '{xtpl'+ id + '}'); + } + ++id; + } + this.tpls = []; + for(var i = tpls.length-1; i >= 0; --i){ + this.compileTpl(tpls[i]); + this.tpls[tpls[i].id] = tpls[i]; + } + this.master = tpls[tpls.length-1]; + return this; + }, + /** + * same as applyTemplate, except it's done to one of the subTemplates + * when using named templates, you can do: + * + * var str = pl.applySubTemplate('your-name', values); + * + * + * @param {Number} id of the template + * @param {Object} values to apply to template + * @param {Object} parent (normaly the instance of this object) + */ + applySubTemplate : function(id, values, parent) + { + + + var t = this.tpls[id]; + + + try { + if(t.test && !t.test.call(this, values, parent)){ + return ''; + } + } catch(e) { + Roo.log("Xtemplate.applySubTemplate 'test': Exception thrown"); + Roo.log(e.toString()); + Roo.log(t.test); + return '' + } + try { + + if(t.exec && t.exec.call(this, values, parent)){ + return ''; + } + } catch(e) { + Roo.log("Xtemplate.applySubTemplate 'exec': Exception thrown"); + Roo.log(e.toString()); + Roo.log(t.exec); + return '' + } + try { + var vs = t.target ? t.target.call(this, values, parent) : values; + parent = t.target ? values : parent; + if(t.target && vs instanceof Array){ + var buf = []; + for(var i = 0, len = vs.length; i < len; i++){ + buf[buf.length] = t.compiled.call(this, vs[i], parent); + } + return buf.join(''); + } + return t.compiled.call(this, vs, parent); + } catch (e) { + Roo.log("Xtemplate.applySubTemplate : Exception thrown"); + Roo.log(e.toString()); + Roo.log(t.compiled); + return ''; + } + }, + + compileTpl : function(tpl) + { + var fm = Roo.util.Format; + var useF = this.disableFormats !== true; + var sep = Roo.isGecko ? "+" : ","; + var undef = function(str) { + Roo.log("Property not found :" + str); + return ''; + }; + + var fn = function(m, name, format, args) + { + //Roo.log(arguments); + args = args ? args.replace(/\\'/g,"'") : args; + //["{TEST:(a,b,c)}", "TEST", "", "a,b,c", 0, "{TEST:(a,b,c)}"] + if (typeof(format) == 'undefined') { + format= 'htmlEncode'; + } + if (format == 'raw' ) { + format = false; + } + + if(name.substr(0, 4) == 'xtpl'){ + return "'"+ sep +'this.applySubTemplate('+name.substr(4)+', values, parent)'+sep+"'"; + } + + // build an array of options to determine if value is undefined.. + + // basically get 'xxxx.yyyy' then do + // (typeof(xxxx) == 'undefined' || typeof(xxx.yyyy) == 'undefined') ? + // (function () { Roo.log("Property not found"); return ''; })() : + // ...... + + var udef_ar = []; + var lookfor = ''; + Roo.each(name.split('.'), function(st) { + lookfor += (lookfor.length ? '.': '') + st; + udef_ar.push( "(typeof(" + lookfor + ") == 'undefined')" ); + }); + + var udef_st = '((' + udef_ar.join(" || ") +") ? undef('" + name + "') : "; // .. needs ) + + + if(format && useF){ + + args = args ? ',' + args : ""; + + if(format.substr(0, 5) != "this."){ + format = "fm." + format + '('; + }else{ + format = 'this.call("'+ format.substr(5) + '", '; + args = ", values"; + } + + return "'"+ sep + udef_st + format + name + args + "))"+sep+"'"; + } + + if (args.length) { + // called with xxyx.yuu:(test,test) + // change to () + return "'"+ sep + udef_st + name + '(' + args + "))"+sep+"'"; + } + // raw.. - :raw modifier.. + return "'"+ sep + udef_st + name + ")"+sep+"'"; + + }; + var body; + // branched to use + in gecko and [].join() in others + if(Roo.isGecko){ + body = "tpl.compiled = function(values, parent){ with(values) { return '" + + tpl.body.replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn) + + "';};};"; + }else{ + body = ["tpl.compiled = function(values, parent){ with (values) { return ['"]; + body.push(tpl.body.replace(/(\r\n|\n)/g, + '\\n').replace(/'/g, "\\'").replace(this.re, fn)); + body.push("'].join('');};};"); + body = body.join(''); + } + + Roo.debug && Roo.log(body.replace(/\\n/,'\n')); + + /** eval:var:tpl eval:var:fm eval:var:useF eval:var:undef */ + eval(body); + + return this; + }, + + applyTemplate : function(values){ + return this.master.compiled.call(this, values, {}); + //var s = this.subs; + }, + + apply : function(){ + return this.applyTemplate.apply(this, arguments); + } + + }); + +Roo.XTemplate.from = function(el){ + el = Roo.getDom(el); + return new Roo.XTemplate(el.value || el.innerHTML); +}; \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Alert.js.html b/docs2/src/Roo_bootstrap_Alert.js.html new file mode 100644 index 0000000000..90449b1c07 --- /dev/null +++ b/docs2/src/Roo_bootstrap_Alert.js.html @@ -0,0 +1,120 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Alert.js/* + * - LGPL + * + * Alert + * + */ + +/** + * @class Roo.bootstrap.Alert + * @extends Roo.bootstrap.Component + * Bootstrap Alert class + * @cfg {String} title The title of alert + * @cfg {String} html The content of alert + * @cfg {String} weight ( success | info | warning | danger ) + * @cfg {String} faicon font-awesomeicon + * + * @constructor + * Create a new alert + * @param {Object} config The config object + */ + + +Roo.bootstrap.Alert = function(config){ + Roo.bootstrap.Alert.superclass.constructor.call(this, config); + +}; + +Roo.extend(Roo.bootstrap.Alert, Roo.bootstrap.Component, { + + title: '', + html: '', + weight: false, + faicon: false, + + getAutoCreate : function() + { + + var cfg = { + tag : 'div', + cls : 'alert', + cn : [ + { + tag : 'i', + cls : 'roo-alert-icon' + + }, + { + tag : 'b', + cls : 'roo-alert-title', + html : this.title + }, + { + tag : 'span', + cls : 'roo-alert-text', + html : this.html + } + ] + }; + + if(this.faicon){ + cfg.cn[0].cls += ' fa ' + this.faicon; + } + + if(this.weight){ + cfg.cls += ' alert-' + this.weight; + } + + return cfg; + }, + + initEvents: function() + { + this.el.setVisibilityMode(Roo.Element.DISPLAY); + }, + + setTitle : function(str) + { + this.el.select('.roo-alert-title',true).first().dom.innerHTML = str; + }, + + setText : function(str) + { + this.el.select('.roo-alert-text',true).first().dom.innerHTML = str; + }, + + setWeight : function(weight) + { + if(this.weight){ + this.el.select('.alert',true).first().removeClass('alert-' + this.weight); + } + + this.weight = weight; + + this.el.select('.alert',true).first().addClass('alert-' + this.weight); + }, + + setIcon : function(icon) + { + if(this.faicon){ + this.el.select('.roo-alert-icon',true).first().removeClass(['fa', 'fa-' + this.faicon]); + } + + this.faicon = icon; + + this.el.select('.roo-alert-icon',true).first().addClass(['fa', 'fa-' + this.faicon]); + }, + + hide: function() + { + this.el.hide(); + }, + + show: function() + { + this.el.show(); + } + +}); + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_BezierSignature.js.html b/docs2/src/Roo_bootstrap_BezierSignature.js.html new file mode 100644 index 0000000000..a0892af4a9 --- /dev/null +++ b/docs2/src/Roo_bootstrap_BezierSignature.js.html @@ -0,0 +1,595 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/BezierSignature.js/** +* This script refer to: +* Title: Signature Pad +* Author: szimek +* Availability: https://github.com/szimek/signature_pad +**/ + +/** + * @class Roo.bootstrap.BezierSignature + * @extends Roo.bootstrap.Component + * Bootstrap BezierSignature class + * + * @constructor + * Create a new BezierSignature + * @param {Object} config The config object + */ + +Roo.bootstrap.BezierSignature = function(config){ + Roo.bootstrap.BezierSignature.superclass.constructor.call(this, config); + this.addEvents({ + "resize" : true + }); +}; + +Roo.extend(Roo.bootstrap.BezierSignature, Roo.bootstrap.Component, { + + curve_data: [], + + is_empty: true, + + mouse_btn_down: true, + + /** + * @cfg(int) canvas height + */ + canvas_height: '200px', + + /** + * @cfg(float or function) Radius of a single dot. + */ + dot_size: false, + + /** + * @cfg(float) Minimum width of a line. Defaults to 0.5. + */ + min_width: 0.5, + + /** + * @cfg(float) Maximum width of a line. Defaults to 2.5. + */ + max_width: 2.5, + + /** + * @cfg(integer) Draw the next point at most once per every x milliseconds. Set it to 0 to turn off throttling. Defaults to 16. + */ + throttle: 16, + + /** + * @cfg(integer) Add the next point only if the previous one is farther than x pixels. Defaults to 5. + */ + min_distance: 5, + + /** + * @cfg(string) Color used to clear the background. Can be any color format accepted by context.fillStyle. Defaults to "rgba(0,0,0,0)" (transparent black). Use a non-transparent color e.g. "rgb(255,255,255)" (opaque white) if you'd like to save signatures as JPEG images. + */ + bg_color: 'rgba(0, 0, 0, 0)', + + /** + * @cfg(string) Color used to draw the lines. Can be any color format accepted by context.fillStyle. Defaults to "black". + */ + dot_color: 'black', + + /** + * @cfg(float) Weight used to modify new velocity based on the previous velocity. Defaults to 0.7. + */ + velocity_filter_weight: 0.7, + + /** + * @cfg(function) Callback when stroke begin. + */ + onBegin: false, + + /** + * @cfg(function) Callback when stroke end. + */ + onEnd: false, + + getAutoCreate : function() + { + var cls = 'roo-signature column'; + + if(this.cls){ + cls += ' ' + this.cls; + } + + var col_sizes = [ + 'lg', + 'md', + 'sm', + 'xs' + ]; + + for(var i = 0; i < col_sizes.length; i++) { + if(this[col_sizes[i]]) { + cls += " col-"+col_sizes[i]+"-"+this[col_sizes[i]]; + } + } + + var cfg = { + tag: 'div', + cls: cls, + cn: [ + { + tag: 'div', + cls: 'roo-signature-body', + cn: [ + { + tag: 'canvas', + cls: 'roo-signature-body-canvas', + height: this.canvas_height, + width: this.canvas_width + } + ] + }, + { + tag: 'input', + type: 'file', + style: 'display: none' + } + ] + }; + + return cfg; + }, + + initEvents: function() + { + Roo.bootstrap.BezierSignature.superclass.initEvents.call(this); + + var canvas = this.canvasEl(); + + // mouse && touch event swapping... + canvas.dom.style.touchAction = 'none'; + canvas.dom.style.msTouchAction = 'none'; + + this.mouse_btn_down = false; + canvas.on('mousedown', this._handleMouseDown, this); + canvas.on('mousemove', this._handleMouseMove, this); + Roo.select('html').first().on('mouseup', this._handleMouseUp, this); + + if (window.PointerEvent) { + canvas.on('pointerdown', this._handleMouseDown, this); + canvas.on('pointermove', this._handleMouseMove, this); + Roo.select('html').first().on('pointerup', this._handleMouseUp, this); + } + + if ('ontouchstart' in window) { + canvas.on('touchstart', this._handleTouchStart, this); + canvas.on('touchmove', this._handleTouchMove, this); + canvas.on('touchend', this._handleTouchEnd, this); + } + + Roo.EventManager.onWindowResize(this.resize, this, true); + + // file input event + this.fileEl().on('change', this.uploadImage, this); + + this.clear(); + + this.resize(); + }, + + resize: function(){ + + var canvas = this.canvasEl().dom; + var ctx = this.canvasElCtx(); + var img_data = ctx.getImageData(0, 0, canvas.width, canvas.height); + + // setting canvas width will clean img data + canvas.width = 0; + + var style = window.getComputedStyle ? + getComputedStyle(this.el.dom, null) : this.el.dom.currentStyle; + + var padding_left = parseInt(style.paddingLeft) || 0; + var padding_right = parseInt(style.paddingRight) || 0; + + canvas.width = this.el.dom.clientWidth - padding_left - padding_right; + + ctx.putImageData(img_data, 0, 0); + }, + + _handleMouseDown: function(e) + { + if (e.browserEvent.which === 1) { + this.mouse_btn_down = true; + this.strokeBegin(e); + } + }, + + _handleMouseMove: function (e) + { + if (this.mouse_btn_down) { + this.strokeMoveUpdate(e); + } + }, + + _handleMouseUp: function (e) + { + if (e.browserEvent.which === 1 && this.mouse_btn_down) { + this.mouse_btn_down = false; + this.strokeEnd(e); + } + }, + + _handleTouchStart: function (e) { + + e.preventDefault(); + if (e.browserEvent.targetTouches.length === 1) { + // var touch = e.browserEvent.changedTouches[0]; + // this.strokeBegin(touch); + + this.strokeBegin(e); // assume e catching the correct xy... + } + }, + + _handleTouchMove: function (e) { + e.preventDefault(); + // var touch = event.targetTouches[0]; + // _this._strokeMoveUpdate(touch); + this.strokeMoveUpdate(e); + }, + + _handleTouchEnd: function (e) { + var wasCanvasTouched = e.target === this.canvasEl().dom; + if (wasCanvasTouched) { + e.preventDefault(); + // var touch = event.changedTouches[0]; + // _this._strokeEnd(touch); + this.strokeEnd(e); + } + }, + + reset: function () { + this._lastPoints = []; + this._lastVelocity = 0; + this._lastWidth = (this.min_width + this.max_width) / 2; + this.canvasElCtx().fillStyle = this.dot_color; + }, + + strokeMoveUpdate: function(e) + { + this.strokeUpdate(e); + + if (this.throttle) { + this.throttle(this.strokeUpdate, this.throttle); + } + else { + this.strokeUpdate(e); + } + }, + + strokeBegin: function(e) + { + var newPointGroup = { + color: this.dot_color, + points: [] + }; + + if (typeof this.onBegin === 'function') { + this.onBegin(e); + } + + this.curve_data.push(newPointGroup); + this.reset(); + this.strokeUpdate(e); + }, + + strokeUpdate: function(e) + { + var rect = this.canvasEl().dom.getBoundingClientRect(); + var point = new this.Point(e.xy[0] - rect.left, e.xy[1] - rect.top, new Date().getTime()); + var lastPointGroup = this.curve_data[this.curve_data.length - 1]; + var lastPoints = lastPointGroup.points; + var lastPoint = lastPoints.length > 0 && lastPoints[lastPoints.length - 1]; + var isLastPointTooClose = lastPoint + ? point.distanceTo(lastPoint) <= this.min_distance + : false; + var color = lastPointGroup.color; + if (!lastPoint || !(lastPoint && isLastPointTooClose)) { + var curve = this.addPoint(point); + if (!lastPoint) { + this.drawDot({color: color, point: point}); + } + else if (curve) { + this.drawCurve({color: color, curve: curve}); + } + lastPoints.push({ + time: point.time, + x: point.x, + y: point.y + }); + } + }, + + strokeEnd: function(e) + { + this.strokeUpdate(e); + if (typeof this.onEnd === 'function') { + this.onEnd(e); + } + }, + + addPoint: function (point) { + var _lastPoints = this._lastPoints; + _lastPoints.push(point); + if (_lastPoints.length > 2) { + if (_lastPoints.length === 3) { + _lastPoints.unshift(_lastPoints[0]); + } + var widths = this.calculateCurveWidths(_lastPoints[1], _lastPoints[2]); + var curve = this.Bezier.fromPoints(_lastPoints, widths, this); + _lastPoints.shift(); + return curve; + } + return null; + }, + + calculateCurveWidths: function (startPoint, endPoint) { + var velocity = this.velocity_filter_weight * endPoint.velocityFrom(startPoint) + + (1 - this.velocity_filter_weight) * this._lastVelocity; + + var newWidth = Math.max(this.max_width / (velocity + 1), this.min_width); + var widths = { + end: newWidth, + start: this._lastWidth + }; + + this._lastVelocity = velocity; + this._lastWidth = newWidth; + return widths; + }, + + drawDot: function (_a) { + var color = _a.color, point = _a.point; + var ctx = this.canvasElCtx(); + var width = typeof this.dot_size === 'function' ? this.dot_size() : this.dot_size; + ctx.beginPath(); + this.drawCurveSegment(point.x, point.y, width); + ctx.closePath(); + ctx.fillStyle = color; + ctx.fill(); + }, + + drawCurve: function (_a) { + var color = _a.color, curve = _a.curve; + var ctx = this.canvasElCtx(); + var widthDelta = curve.endWidth - curve.startWidth; + var drawSteps = Math.floor(curve.length()) * 2; + ctx.beginPath(); + ctx.fillStyle = color; + for (var i = 0; i < drawSteps; i += 1) { + var t = i / drawSteps; + var tt = t * t; + var ttt = tt * t; + var u = 1 - t; + var uu = u * u; + var uuu = uu * u; + var x = uuu * curve.startPoint.x; + x += 3 * uu * t * curve.control1.x; + x += 3 * u * tt * curve.control2.x; + x += ttt * curve.endPoint.x; + var y = uuu * curve.startPoint.y; + y += 3 * uu * t * curve.control1.y; + y += 3 * u * tt * curve.control2.y; + y += ttt * curve.endPoint.y; + var width = curve.startWidth + ttt * widthDelta; + this.drawCurveSegment(x, y, width); + } + ctx.closePath(); + ctx.fill(); + }, + + drawCurveSegment: function (x, y, width) { + var ctx = this.canvasElCtx(); + ctx.moveTo(x, y); + ctx.arc(x, y, width, 0, 2 * Math.PI, false); + this.is_empty = false; + }, + + clear: function() + { + var ctx = this.canvasElCtx(); + var canvas = this.canvasEl().dom; + ctx.fillStyle = this.bg_color; + ctx.clearRect(0, 0, canvas.width, canvas.height); + ctx.fillRect(0, 0, canvas.width, canvas.height); + this.curve_data = []; + this.reset(); + this.is_empty = true; + }, + + fileEl: function() + { + return this.el.select('input',true).first(); + }, + + canvasEl: function() + { + return this.el.select('canvas',true).first(); + }, + + canvasElCtx: function() + { + return this.el.select('canvas',true).first().dom.getContext('2d'); + }, + + getImage: function(type) + { + if(this.is_empty) { + return false; + } + + // encryption ? + return this.canvasEl().dom.toDataURL('image/'+type, 1); + }, + + drawFromImage: function(img_src) + { + var img = new Image(); + + img.onload = function(){ + this.canvasElCtx().drawImage(img, 0, 0); + }.bind(this); + + img.src = img_src; + + this.is_empty = false; + }, + + selectImage: function() + { + this.fileEl().dom.click(); + }, + + uploadImage: function(e) + { + var reader = new FileReader(); + + reader.onload = function(e){ + var img = new Image(); + img.onload = function(){ + this.reset(); + this.canvasElCtx().drawImage(img, 0, 0); + }.bind(this); + img.src = e.target.result; + }.bind(this); + + reader.readAsDataURL(e.target.files[0]); + }, + + // Bezier Point Constructor + Point: (function () { + function Point(x, y, time) { + this.x = x; + this.y = y; + this.time = time || Date.now(); + } + Point.prototype.distanceTo = function (start) { + return Math.sqrt(Math.pow(this.x - start.x, 2) + Math.pow(this.y - start.y, 2)); + }; + Point.prototype.equals = function (other) { + return this.x === other.x && this.y === other.y && this.time === other.time; + }; + Point.prototype.velocityFrom = function (start) { + return this.time !== start.time + ? this.distanceTo(start) / (this.time - start.time) + : 0; + }; + return Point; + }()), + + + // Bezier Constructor + Bezier: (function () { + function Bezier(startPoint, control2, control1, endPoint, startWidth, endWidth) { + this.startPoint = startPoint; + this.control2 = control2; + this.control1 = control1; + this.endPoint = endPoint; + this.startWidth = startWidth; + this.endWidth = endWidth; + } + Bezier.fromPoints = function (points, widths, scope) { + var c2 = this.calculateControlPoints(points[0], points[1], points[2], scope).c2; + var c3 = this.calculateControlPoints(points[1], points[2], points[3], scope).c1; + return new Bezier(points[1], c2, c3, points[2], widths.start, widths.end); + }; + Bezier.calculateControlPoints = function (s1, s2, s3, scope) { + var dx1 = s1.x - s2.x; + var dy1 = s1.y - s2.y; + var dx2 = s2.x - s3.x; + var dy2 = s2.y - s3.y; + var m1 = { x: (s1.x + s2.x) / 2.0, y: (s1.y + s2.y) / 2.0 }; + var m2 = { x: (s2.x + s3.x) / 2.0, y: (s2.y + s3.y) / 2.0 }; + var l1 = Math.sqrt(dx1 * dx1 + dy1 * dy1); + var l2 = Math.sqrt(dx2 * dx2 + dy2 * dy2); + var dxm = m1.x - m2.x; + var dym = m1.y - m2.y; + var k = l2 / (l1 + l2); + var cm = { x: m2.x + dxm * k, y: m2.y + dym * k }; + var tx = s2.x - cm.x; + var ty = s2.y - cm.y; + return { + c1: new scope.Point(m1.x + tx, m1.y + ty), + c2: new scope.Point(m2.x + tx, m2.y + ty) + }; + }; + Bezier.prototype.length = function () { + var steps = 10; + var length = 0; + var px; + var py; + for (var i = 0; i <= steps; i += 1) { + var t = i / steps; + var cx = this.point(t, this.startPoint.x, this.control1.x, this.control2.x, this.endPoint.x); + var cy = this.point(t, this.startPoint.y, this.control1.y, this.control2.y, this.endPoint.y); + if (i > 0) { + var xdiff = cx - px; + var ydiff = cy - py; + length += Math.sqrt(xdiff * xdiff + ydiff * ydiff); + } + px = cx; + py = cy; + } + return length; + }; + Bezier.prototype.point = function (t, start, c1, c2, end) { + return (start * (1.0 - t) * (1.0 - t) * (1.0 - t)) + + (3.0 * c1 * (1.0 - t) * (1.0 - t) * t) + + (3.0 * c2 * (1.0 - t) * t * t) + + (end * t * t * t); + }; + return Bezier; + }()), + + throttle: function(fn, wait) { + if (wait === void 0) { wait = 250; } + var previous = 0; + var timeout = null; + var result; + var storedContext; + var storedArgs; + var later = function () { + previous = Date.now(); + timeout = null; + result = fn.apply(storedContext, storedArgs); + if (!timeout) { + storedContext = null; + storedArgs = []; + } + }; + return function wrapper() { + var args = []; + for (var _i = 0; _i < arguments.length; _i++) { + args[_i] = arguments[_i]; + } + var now = Date.now(); + var remaining = wait - (now - previous); + storedContext = this; + storedArgs = args; + if (remaining <= 0 || remaining > wait) { + if (timeout) { + clearTimeout(timeout); + timeout = null; + } + previous = now; + result = fn.apply(storedContext, storedArgs); + if (!timeout) { + storedContext = null; + storedArgs = []; + } + } + else if (!timeout) { + timeout = window.setTimeout(later, remaining); + } + return result; + }; + } + +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Body.js.html b/docs2/src/Roo_bootstrap_Body.js.html new file mode 100644 index 0000000000..8903bfc5d3 --- /dev/null +++ b/docs2/src/Roo_bootstrap_Body.js.html @@ -0,0 +1,50 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Body.js/* + * - LGPL + * + * Body + * + */ + +/** + * @class Roo.bootstrap.Body + * @extends Roo.bootstrap.Component + * Bootstrap Body class + * + * @constructor + * Create a new body + * @param {Object} config The config object + */ + +Roo.bootstrap.Body = function(config){ + + config = config || {}; + + Roo.bootstrap.Body.superclass.constructor.call(this, config); + this.el = Roo.get(config.el ? config.el : document.body ); + if (this.cls && this.cls.length) { + Roo.get(document.body).addClass(this.cls); + } +}; + +Roo.extend(Roo.bootstrap.Body, Roo.bootstrap.Component, { + + is_body : true,// just to make sure it's constructed? + + autoCreate : { + cls: 'container' + }, + onRender : function(ct, position) + { + /* Roo.log("Roo.bootstrap.Body - onRender"); + if (this.cls && this.cls.length) { + Roo.get(document.body).addClass(this.cls); + } + // style??? xttr??? + */ + } + + + + +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Brick.js.html b/docs2/src/Roo_bootstrap_Brick.js.html new file mode 100644 index 0000000000..ee9969fdaf --- /dev/null +++ b/docs2/src/Roo_bootstrap_Brick.js.html @@ -0,0 +1,204 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Brick.js/* + * - LGPL + * + * element + * + */ + +/** + * @class Roo.bootstrap.Brick + * @extends Roo.bootstrap.Component + * Bootstrap Brick class + * + * @constructor + * Create a new Brick + * @param {Object} config The config object + */ + +Roo.bootstrap.Brick = function(config){ + Roo.bootstrap.Brick.superclass.constructor.call(this, config); + + this.addEvents({ + // raw events + /** + * @event click + * When a Brick is click + * @param {Roo.bootstrap.Brick} this + * @param {Roo.EventObject} e + */ + "click" : true + }); +}; + +Roo.extend(Roo.bootstrap.Brick, Roo.bootstrap.Component, { + + /** + * @cfg {String} title + */ + title : '', + /** + * @cfg {String} html + */ + html : '', + /** + * @cfg {String} bgimage + */ + bgimage : '', + /** + * @cfg {String} cls + */ + cls : '', + /** + * @cfg {String} href + */ + href : '', + /** + * @cfg {String} video + */ + video : '', + /** + * @cfg {Boolean} square + */ + square : true, + + getAutoCreate : function() + { + var cls = 'roo-brick'; + + if(this.href.length){ + cls += ' roo-brick-link'; + } + + if(this.bgimage.length){ + cls += ' roo-brick-image'; + } + + if(!this.html.length && !this.bgimage.length){ + cls += ' roo-brick-center-title'; + } + + if(!this.html.length && this.bgimage.length){ + cls += ' roo-brick-bottom-title'; + } + + if(this.cls){ + cls += ' ' + this.cls; + } + + var cfg = { + tag: (this.href.length) ? 'a' : 'div', + cls: cls, + cn: [ + { + tag: 'div', + cls: 'roo-brick-paragraph', + cn: [] + } + ] + }; + + if(this.href.length){ + cfg.href = this.href; + } + + var cn = cfg.cn[0].cn; + + if(this.title.length){ + cn.push({ + tag: 'h4', + cls: 'roo-brick-title', + html: this.title + }); + } + + if(this.html.length){ + cn.push({ + tag: 'p', + cls: 'roo-brick-text', + html: this.html + }); + } else { + cn.cls += ' hide'; + } + + if(this.bgimage.length){ + cfg.cn.push({ + tag: 'img', + cls: 'roo-brick-image-view', + src: this.bgimage + }); + } + + return cfg; + }, + + initEvents: function() + { + if(this.title.length || this.html.length){ + this.el.on('mouseenter' ,this.enter, this); + this.el.on('mouseleave', this.leave, this); + } + + Roo.EventManager.onWindowResize(this.resize, this); + + if(this.bgimage.length){ + this.imageEl = this.el.select('.roo-brick-image-view', true).first(); + this.imageEl.on('load', this.onImageLoad, this); + return; + } + + this.resize(); + }, + + onImageLoad : function() + { + this.resize(); + }, + + resize : function() + { + var paragraph = this.el.select('.roo-brick-paragraph', true).first(); + + paragraph.setHeight(paragraph.getWidth() + paragraph.getPadding('tb')); + + if(this.bgimage.length){ + var image = this.el.select('.roo-brick-image-view', true).first(); + + image.setWidth(paragraph.getWidth()); + + if(this.square){ + image.setHeight(paragraph.getWidth()); + } + + this.el.setHeight(image.getHeight()); + paragraph.setHeight(image.getHeight()); + + } + + }, + + enter: function(e, el) + { + e.preventDefault(); + + if(this.bgimage.length){ + this.el.select('.roo-brick-paragraph', true).first().setOpacity(0.9, true); + this.el.select('.roo-brick-image-view', true).first().setOpacity(0.1, true); + } + }, + + leave: function(e, el) + { + e.preventDefault(); + + if(this.bgimage.length){ + this.el.select('.roo-brick-paragraph', true).first().setOpacity(0, true); + this.el.select('.roo-brick-image-view', true).first().setOpacity(1, true); + } + } + +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Button.js.html b/docs2/src/Roo_bootstrap_Button.js.html new file mode 100644 index 0000000000..417d8c97c5 --- /dev/null +++ b/docs2/src/Roo_bootstrap_Button.js.html @@ -0,0 +1,426 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Button.js/* + * - LGPL + * + * button + * + */ + +/** + * @class Roo.bootstrap.Button + * @extends Roo.bootstrap.Component + * Bootstrap Button class + * @cfg {String} html The button content + * @cfg {String} weight (default | primary | secondary | success | info | warning | danger | link ) default + * @cfg {String} badge_weight (default | primary | secondary | success | info | warning | danger | link ) default (same as button) + * @cfg {Boolean} outline default false (except for weight=default which emulates old behaveiour with an outline) + * @cfg {String} size ( lg | sm | xs) + * @cfg {String} tag ( a | input | submit) + * @cfg {String} href empty or href + * @cfg {Boolean} disabled default false; + * @cfg {Boolean} isClose default false; + * @cfg {String} glyphicon depricated - use fa + * @cfg {String} fa fontawesome icon - eg. 'comment' - without the fa/fas etc.. + * @cfg {String} badge text for badge + * @cfg {String} theme (default|glow) + * @cfg {Boolean} inverse dark themed version + * @cfg {Boolean} toggle is it a slidy toggle button + * @cfg {Boolean} pressed (true|false) default null - if the button ahs active state + * @cfg {String} ontext text for on slidy toggle state + * @cfg {String} offtext text for off slidy toggle state + * @cfg {Boolean} preventDefault default true (stop click event triggering the URL if it's a link.) + * @cfg {Boolean} removeClass remove the standard class.. + * @cfg {String} target target for a href. (_self|_blank|_parent|_top| other) + * + * @constructor + * Create a new button + * @param {Object} config The config object + */ + + +Roo.bootstrap.Button = function(config){ + Roo.bootstrap.Button.superclass.constructor.call(this, config); + this.weightClass = ["btn-default btn-outline-secondary", + "btn-primary", + "btn-success", + "btn-info", + "btn-warning", + "btn-danger", + "btn-link" + ], + this.addEvents({ + // raw events + /** + * @event click + * When a butotn is pressed + * @param {Roo.bootstrap.Button} btn + * @param {Roo.EventObject} e + */ + "click" : true, + /** + * @event toggle + * After the button has been toggles + * @param {Roo.bootstrap.Button} btn + * @param {Roo.EventObject} e + * @param {boolean} pressed (also available as button.pressed) + */ + "toggle" : true + }); +}; + +Roo.extend(Roo.bootstrap.Button, Roo.bootstrap.Component, { + html: false, + active: false, + weight: '', + badge_weight: '', + outline : false, + size: '', + tag: 'button', + href: '', + disabled: false, + isClose: false, + glyphicon: '', + fa: '', + badge: '', + theme: 'default', + inverse: false, + + toggle: false, + ontext: 'ON', + offtext: 'OFF', + defaulton: true, + preventDefault: true, + removeClass: false, + name: false, + target: false, + + pressed : null, + + + getAutoCreate : function(){ + + var cfg = { + tag : 'button', + cls : 'roo-button', + html: '' + }; + + if (['a', 'button', 'input', 'submit'].indexOf(this.tag) < 0) { + throw "Invalid value for tag: " + this.tag + ". must be a, button, input or submit."; + this.tag = 'button'; + } else { + cfg.tag = this.tag; + } + cfg.html = '<span class="roo-button-text">' + (this.html || cfg.html) + '</span>'; + + if (this.toggle == true) { + cfg={ + tag: 'div', + cls: 'slider-frame roo-button', + cn: [ + { + tag: 'span', + 'data-on-text':'ON', + 'data-off-text':'OFF', + cls: 'slider-button', + html: this.offtext + } + ] + }; + + if (['default', 'secondary' , 'primary', 'success', 'info', 'warning', 'danger', 'link'].indexOf(this.weight) > -1) { + cfg.cls += ' '+this.weight; + } + + return cfg; + } + + if (this.isClose) { + cfg.cls += ' close'; + + cfg["aria-hidden"] = true; + + cfg.html = "&times;"; + + return cfg; + } + + + if (this.theme==='default') { + cfg.cls = 'btn roo-button'; + + //if (this.parentType != 'Navbar') { + this.weight = this.weight.length ? this.weight : 'default'; + //} + if (['default', 'primary', 'secondary', 'success', 'info', 'warning', 'danger', 'link'].indexOf(this.weight) > -1) { + + var outline = this.outline || this.weight == 'default' ? 'outline-' : ''; + var weight = this.weight == 'default' ? 'secondary' : this.weight; + cfg.cls += ' btn-' + outline + weight; + if (this.weight == 'default') { + // BC + cfg.cls += ' btn-' + this.weight; + } + } + } else if (this.theme==='glow') { + + cfg.tag = 'a'; + cfg.cls = 'btn-glow roo-button'; + + if (['default', 'primary', 'success', 'info', 'warning', 'danger', 'link'].indexOf(this.weight) > -1) { + + cfg.cls += ' ' + this.weight; + } + } + + + if (this.inverse) { + this.cls += ' inverse'; + } + + + if (this.active || this.pressed === true) { + cfg.cls += ' active'; + } + + if (this.disabled) { + cfg.disabled = 'disabled'; + } + + if (this.items) { + Roo.log('changing to ul' ); + cfg.tag = 'ul'; + this.glyphicon = 'caret'; + if (Roo.bootstrap.version == 4) { + this.fa = 'caret-down'; + } + + } + + cfg.cls += this.size.length ? (' btn-' + this.size) : ''; + + //gsRoo.log(this.parentType); + if (this.parentType === 'Navbar' && !this.parent().bar) { + Roo.log('changing to li?'); + + cfg.tag = 'li'; + + cfg.cls = ''; + cfg.cn = [{ + tag : 'a', + cls : 'roo-button', + html : this.html, + href : this.href || '#' + }]; + if (this.menu) { + cfg.cn[0].html = this.html + ' <span class="caret"></span>'; + cfg.cls += ' dropdown'; + } + + delete cfg.html; + + } + + cfg.cls += this.parentType === 'Navbar' ? ' navbar-btn' : ''; + + if (this.glyphicon) { + cfg.html = ' ' + cfg.html; + + cfg.cn = [ + { + tag: 'span', + cls: 'glyphicon glyphicon-' + this.glyphicon + } + ]; + } + if (this.fa) { + cfg.html = ' ' + cfg.html; + + cfg.cn = [ + { + tag: 'i', + cls: 'fa fas fa-' + this.fa + } + ]; + } + + if (this.badge) { + cfg.html += ' '; + + cfg.tag = 'a'; + +// cfg.cls='btn roo-button'; + + cfg.href=this.href; + + var value = cfg.html; + + if(this.glyphicon){ + value = { + tag: 'span', + cls: 'glyphicon glyphicon-' + this.glyphicon, + html: this.html + }; + } + if(this.fa){ + value = { + tag: 'i', + cls: 'fa fas fa-' + this.fa, + html: this.html + }; + } + + var bw = this.badge_weight.length ? this.badge_weight : + (this.weight.length ? this.weight : 'secondary'); + bw = bw == 'default' ? 'secondary' : bw; + + cfg.cn = [ + value, + { + tag: 'span', + cls: 'badge badge-' + bw, + html: this.badge + } + ]; + + cfg.html=''; + } + + if (this.menu) { + cfg.cls += ' dropdown'; + cfg.html = typeof(cfg.html) != 'undefined' ? + cfg.html + ' <span class="caret"></span>' : '<span class="caret"></span>'; + } + + if (cfg.tag !== 'a' && this.href !== '') { + throw "Tag must be a to set href."; + } else if (this.href.length > 0) { + cfg.href = this.href; + } + + if(this.removeClass){ + cfg.cls = ''; + } + + if(this.target){ + cfg.target = this.target; + } + + return cfg; + }, + initEvents: function() { + // Roo.log('init events?'); +// Roo.log(this.el.dom); + // add the menu... + + if (typeof (this.menu) != 'undefined') { + this.menu.parentType = this.xtype; + this.menu.triggerEl = this.el; + this.addxtype(Roo.apply({}, this.menu)); + } + + + if (this.el.hasClass('roo-button')) { + this.el.on('click', this.onClick, this); + } else { + this.el.select('.roo-button').on('click', this.onClick, this); + } + + if(this.removeClass){ + this.el.on('click', this.onClick, this); + } + + this.el.enableDisplayMode(); + + }, + onClick : function(e) + { + if (this.disabled) { + return; + } + + Roo.log('button on click '); + if(this.preventDefault){ + e.preventDefault(); + } + + if (this.pressed === true || this.pressed === false) { + this.toggleActive(e); + } + + + this.fireEvent('click', this, e); + }, + + /** + * Enables this button + */ + enable : function() + { + this.disabled = false; + this.el.removeClass('disabled'); + }, + + /** + * Disable this button + */ + disable : function() + { + this.disabled = true; + this.el.addClass('disabled'); + }, + /** + * sets the active state on/off, + * @param {Boolean} state (optional) Force a particular state + */ + setActive : function(v) { + + this.el[v ? 'addClass' : 'removeClass']('active'); + this.pressed = v; + }, + /** + * toggles the current active state + */ + toggleActive : function(e) + { + this.setActive(!this.pressed); + this.fireEvent('toggle', this, e, !this.pressed); + }, + /** + * get the current active state + * @return {boolean} true if it's active + */ + isActive : function() + { + return this.el.hasClass('active'); + }, + /** + * set the text of the first selected button + */ + setText : function(str) + { + this.el.select('.roo-button-text',true).first().dom.innerHTML = str; + }, + /** + * get the text of the first selected button + */ + getText : function() + { + return this.el.select('.roo-button-text',true).first().dom.innerHTML; + }, + + setWeight : function(str) + { + this.el.removeClass(this.weightClass); + this.weight = str; + var outline = this.outline ? 'outline-' : ''; + if (str == 'default') { + this.el.addClass('btn-default btn-outline-secondary'); + return; + } + this.el.addClass('btn-' + outline + str); + } + + +}); + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_ButtonGroup.js.html b/docs2/src/Roo_bootstrap_ButtonGroup.js.html new file mode 100644 index 0000000000..7889d9e511 --- /dev/null +++ b/docs2/src/Roo_bootstrap_ButtonGroup.js.html @@ -0,0 +1,86 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/ButtonGroup.js/* + * - LGPL + * + * button group + * + */ + + +/** + * @class Roo.bootstrap.ButtonGroup + * @extends Roo.bootstrap.Component + * Bootstrap ButtonGroup class + * @cfg {String} size lg | sm | xs (default empty normal) + * @cfg {String} align vertical | justified (default none) + * @cfg {String} direction up | down (default down) + * @cfg {Boolean} toolbar false | true + * @cfg {Boolean} btn true | false + * + * + * @constructor + * Create a new Input + * @param {Object} config The config object + */ + +Roo.bootstrap.ButtonGroup = function(config){ + Roo.bootstrap.ButtonGroup.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.ButtonGroup, Roo.bootstrap.Component, { + + size: '', + align: '', + direction: '', + toolbar: false, + btn: true, + + getAutoCreate : function(){ + var cfg = { + cls: 'btn-group', + html : null + }; + + cfg.html = this.html || cfg.html; + + if (this.toolbar) { + cfg = { + cls: 'btn-toolbar', + html: null + }; + + return cfg; + } + + if (['vertical','justified'].indexOf(this.align)!==-1) { + cfg.cls = 'btn-group-' + this.align; + + if (this.align == 'justified') { + console.log(this.items); + } + } + + if (['lg','sm','xs'].indexOf(this.size)!==-1) { + cfg.cls += ' btn-group-' + this.size; + } + + if (this.direction == 'up') { + cfg.cls += ' dropup' ; + } + + return cfg; + }, + /** + * Add a button to the group (similar to NavItem API.) + */ + addItem : function(cfg) + { + var cn = new Roo.bootstrap.Button(cfg); + //this.register(cn); + cn.parentId = this.id; + cn.onRender(this.el, null); + return cn; + } + +}); + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Calendar.js.html b/docs2/src/Roo_bootstrap_Calendar.js.html new file mode 100644 index 0000000000..be7caa10cc --- /dev/null +++ b/docs2/src/Roo_bootstrap_Calendar.js.html @@ -0,0 +1,907 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Calendar.js/* + * - LGPL + * + * based on jquery fullcalendar + * + */ + +Roo.bootstrap = Roo.bootstrap || {}; +/** + * @class Roo.bootstrap.Calendar + * @extends Roo.bootstrap.Component + * Bootstrap Calendar class + * @cfg {Boolean} loadMask (true|false) default false + * @cfg {Object} header generate the user specific header of the calendar, default false + + * @constructor + * Create a new Container + * @param {Object} config The config object + */ + + + +Roo.bootstrap.Calendar = function(config){ + Roo.bootstrap.Calendar.superclass.constructor.call(this, config); + this.addEvents({ + /** + * @event select + * Fires when a date is selected + * @param {DatePicker} this + * @param {Date} date The selected date + */ + 'select': true, + /** + * @event monthchange + * Fires when the displayed month changes + * @param {DatePicker} this + * @param {Date} date The selected month + */ + 'monthchange': true, + /** + * @event evententer + * Fires when mouse over an event + * @param {Calendar} this + * @param {event} Event + */ + 'evententer': true, + /** + * @event eventleave + * Fires when the mouse leaves an + * @param {Calendar} this + * @param {event} + */ + 'eventleave': true, + /** + * @event eventclick + * Fires when the mouse click an + * @param {Calendar} this + * @param {event} + */ + 'eventclick': true + + }); + +}; + +Roo.extend(Roo.bootstrap.Calendar, Roo.bootstrap.Component, { + + /** + * @cfg {Number} startDay + * Day index at which the week should begin, 0-based (defaults to 0, which is Sunday) + */ + startDay : 0, + + loadMask : false, + + header : false, + + getAutoCreate : function(){ + + + var fc_button = function(name, corner, style, content ) { + return Roo.apply({},{ + tag : 'span', + cls : 'fc-button fc-button-'+name+' fc-state-default ' + + (corner.length ? + 'fc-corner-' + corner.split(' ').join(' fc-corner-') : + '' + ), + html : '<SPAN class="fc-text-'+style+ '">'+content +'</SPAN>', + unselectable: 'on' + }); + }; + + var header = {}; + + if(!this.header){ + header = { + tag : 'table', + cls : 'fc-header', + style : 'width:100%', + cn : [ + { + tag: 'tr', + cn : [ + { + tag : 'td', + cls : 'fc-header-left', + cn : [ + fc_button('prev', 'left', 'arrow', '&#8249;' ), + fc_button('next', 'right', 'arrow', '&#8250;' ), + { tag: 'span', cls: 'fc-header-space' }, + fc_button('today', 'left right', '', 'today' ) // neds state disabled.. + + + ] + }, + + { + tag : 'td', + cls : 'fc-header-center', + cn : [ + { + tag: 'span', + cls: 'fc-header-title', + cn : { + tag: 'H2', + html : 'month / year' + } + } + + ] + }, + { + tag : 'td', + cls : 'fc-header-right', + cn : [ + /* fc_button('month', 'left', '', 'month' ), + fc_button('week', '', '', 'week' ), + fc_button('day', 'right', '', 'day' ) + */ + + ] + } + + ] + } + ] + }; + } + + header = this.header; + + + var cal_heads = function() { + var ret = []; + // fixme - handle this. + + for (var i =0; i < Date.dayNames.length; i++) { + var d = Date.dayNames[i]; + ret.push({ + tag: 'th', + cls : 'fc-day-header fc-' + d.substring(0,3).toLowerCase() + ' fc-widget-header', + html : d.substring(0,3) + }); + + } + ret[0].cls += ' fc-first'; + ret[6].cls += ' fc-last'; + return ret; + }; + var cal_cell = function(n) { + return { + tag: 'td', + cls : 'fc-day fc-'+n + ' fc-widget-content', ///fc-other-month fc-past + cn : [ + { + cn : [ + { + cls: 'fc-day-number', + html: 'D' + }, + { + cls: 'fc-day-content', + + cn : [ + { + style: 'position: relative;' // height: 17px; + } + ] + } + + + ] + } + ] + + } + }; + var cal_rows = function() { + + var ret = []; + for (var r = 0; r < 6; r++) { + var row= { + tag : 'tr', + cls : 'fc-week', + cn : [] + }; + + for (var i =0; i < Date.dayNames.length; i++) { + var d = Date.dayNames[i]; + row.cn.push(cal_cell(d.substring(0,3).toLowerCase())); + + } + row.cn[0].cls+=' fc-first'; + row.cn[0].cn[0].style = 'min-height:90px'; + row.cn[6].cls+=' fc-last'; + ret.push(row); + + } + ret[0].cls += ' fc-first'; + ret[4].cls += ' fc-prev-last'; + ret[5].cls += ' fc-last'; + return ret; + + }; + + var cal_table = { + tag: 'table', + cls: 'fc-border-separate', + style : 'width:100%', + cellspacing : 0, + cn : [ + { + tag: 'thead', + cn : [ + { + tag: 'tr', + cls : 'fc-first fc-last', + cn : cal_heads() + } + ] + }, + { + tag: 'tbody', + cn : cal_rows() + } + + ] + }; + + var cfg = { + cls : 'fc fc-ltr', + cn : [ + header, + { + cls : 'fc-content', + style : "position: relative;", + cn : [ + { + cls : 'fc-view fc-view-month fc-grid', + style : 'position: relative', + unselectable : 'on', + cn : [ + { + cls : 'fc-event-container', + style : 'position:absolute;z-index:8;top:0;left:0;' + }, + cal_table + ] + } + ] + + } + ] + + }; + + + + return cfg; + }, + + + initEvents : function() + { + if(!this.store){ + throw "can not find store for calendar"; + } + + var mark = { + tag: "div", + cls:"x-dlg-mask", + style: "text-align:center", + cn: [ + { + tag: "div", + style: "background-color:white;width:50%;margin:250 auto", + cn: [ + { + tag: "img", + src: Roo.rootURL + '/images/ux/lightbox/loading.gif' + }, + { + tag: "span", + html: "Loading" + } + + ] + } + ] + }; + this.maskEl = Roo.DomHelper.append(this.el.select('.fc-content', true).first(), mark, true); + + var size = this.el.select('.fc-content', true).first().getSize(); + this.maskEl.setSize(size.width, size.height); + this.maskEl.enableDisplayMode("block"); + if(!this.loadMask){ + this.maskEl.hide(); + } + + this.store = Roo.factory(this.store, Roo.data); + this.store.on('load', this.onLoad, this); + this.store.on('beforeload', this.onBeforeLoad, this); + + this.resize(); + + this.cells = this.el.select('.fc-day',true); + //Roo.log(this.cells); + this.textNodes = this.el.query('.fc-day-number'); + this.cells.addClassOnOver('fc-state-hover'); + + this.el.select('.fc-button-prev',true).on('click', this.showPrevMonth, this); + this.el.select('.fc-button-next',true).on('click', this.showNextMonth, this); + this.el.select('.fc-button-today',true).on('click', this.showToday, this); + this.el.select('.fc-button',true).addClassOnOver('fc-state-hover'); + + this.on('monthchange', this.onMonthChange, this); + + this.update(new Date().clearTime()); + }, + + resize : function() { + var sz = this.el.getSize(); + + this.el.select('.fc-day-header',true).setWidth(sz.width / 7); + this.el.select('.fc-day-content div',true).setHeight(34); + }, + + + // private + showPrevMonth : function(e){ + this.update(this.activeDate.add("mo", -1)); + }, + showToday : function(e){ + this.update(new Date().clearTime()); + }, + // private + showNextMonth : function(e){ + this.update(this.activeDate.add("mo", 1)); + }, + + // private + showPrevYear : function(){ + this.update(this.activeDate.add("y", -1)); + }, + + // private + showNextYear : function(){ + this.update(this.activeDate.add("y", 1)); + }, + + + // private + update : function(date) + { + var vd = this.activeDate; + this.activeDate = date; +// if(vd && this.el){ +// var t = date.getTime(); +// if(vd.getMonth() == date.getMonth() && vd.getFullYear() == date.getFullYear()){ +// Roo.log('using add remove'); +// +// this.fireEvent('monthchange', this, date); +// +// this.cells.removeClass("fc-state-highlight"); +// this.cells.each(function(c){ +// if(c.dateValue == t){ +// c.addClass("fc-state-highlight"); +// setTimeout(function(){ +// try{c.dom.firstChild.focus();}catch(e){} +// }, 50); +// return false; +// } +// return true; +// }); +// return; +// } +// } + + var days = date.getDaysInMonth(); + + var firstOfMonth = date.getFirstDateOfMonth(); + var startingPos = firstOfMonth.getDay()-this.startDay; + + if(startingPos < this.startDay){ + startingPos += 7; + } + + var pm = date.add(Date.MONTH, -1); + var prevStart = pm.getDaysInMonth()-startingPos; +// + this.cells = this.el.select('.fc-day',true); + this.textNodes = this.el.query('.fc-day-number'); + this.cells.addClassOnOver('fc-state-hover'); + + var cells = this.cells.elements; + var textEls = this.textNodes; + + Roo.each(cells, function(cell){ + cell.removeClass([ 'fc-past', 'fc-other-month', 'fc-future', 'fc-state-highlight', 'fc-state-disabled']); + }); + + days += startingPos; + + // convert everything to numbers so it's fast + var day = 86400000; + var d = (new Date(pm.getFullYear(), pm.getMonth(), prevStart)).clearTime(); + //Roo.log(d); + //Roo.log(pm); + //Roo.log(prevStart); + + var today = new Date().clearTime().getTime(); + var sel = date.clearTime().getTime(); + var min = this.minDate ? this.minDate.clearTime() : Number.NEGATIVE_INFINITY; + var max = this.maxDate ? this.maxDate.clearTime() : Number.POSITIVE_INFINITY; + var ddMatch = this.disabledDatesRE; + var ddText = this.disabledDatesText; + var ddays = this.disabledDays ? this.disabledDays.join("") : false; + var ddaysText = this.disabledDaysText; + var format = this.format; + + var setCellClass = function(cal, cell){ + cell.row = 0; + cell.events = []; + cell.more = []; + //Roo.log('set Cell Class'); + cell.title = ""; + var t = d.getTime(); + + //Roo.log(d); + + cell.dateValue = t; + if(t == today){ + cell.className += " fc-today"; + cell.className += " fc-state-highlight"; + cell.title = cal.todayText; + } + if(t == sel){ + // disable highlight in other month.. + //cell.className += " fc-state-highlight"; + + } + // disabling + if(t < min) { + cell.className = " fc-state-disabled"; + cell.title = cal.minText; + return; + } + if(t > max) { + cell.className = " fc-state-disabled"; + cell.title = cal.maxText; + return; + } + if(ddays){ + if(ddays.indexOf(d.getDay()) != -1){ + cell.title = ddaysText; + cell.className = " fc-state-disabled"; + } + } + if(ddMatch && format){ + var fvalue = d.dateFormat(format); + if(ddMatch.test(fvalue)){ + cell.title = ddText.replace("%0", fvalue); + cell.className = " fc-state-disabled"; + } + } + + if (!cell.initialClassName) { + cell.initialClassName = cell.dom.className; + } + + cell.dom.className = cell.initialClassName + ' ' + cell.className; + }; + + var i = 0; + + for(; i < startingPos; i++) { + textEls[i].innerHTML = (++prevStart); + d.setDate(d.getDate()+1); + + cells[i].className = "fc-past fc-other-month"; + setCellClass(this, cells[i]); + } + + var intDay = 0; + + for(; i < days; i++){ + intDay = i - startingPos + 1; + textEls[i].innerHTML = (intDay); + d.setDate(d.getDate()+1); + + cells[i].className = ''; // "x-date-active"; + setCellClass(this, cells[i]); + } + var extraDays = 0; + + for(; i < 42; i++) { + textEls[i].innerHTML = (++extraDays); + d.setDate(d.getDate()+1); + + cells[i].className = "fc-future fc-other-month"; + setCellClass(this, cells[i]); + } + + this.el.select('.fc-header-title h2',true).update(Date.monthNames[date.getMonth()] + " " + date.getFullYear()); + + var totalRows = Math.ceil((date.getDaysInMonth() + date.getFirstDateOfMonth().getDay()) / 7); + + this.el.select('tr.fc-week.fc-prev-last',true).removeClass('fc-last'); + this.el.select('tr.fc-week.fc-next-last',true).addClass('fc-last').show(); + + if(totalRows != 6){ + this.el.select('tr.fc-week.fc-last',true).removeClass('fc-last').addClass('fc-next-last').hide(); + this.el.select('tr.fc-week.fc-prev-last',true).addClass('fc-last'); + } + + this.fireEvent('monthchange', this, date); + + + /* + if(!this.internalRender){ + var main = this.el.dom.firstChild; + var w = main.offsetWidth; + this.el.setWidth(w + this.el.getBorderWidth("lr")); + Roo.fly(main).setWidth(w); + this.internalRender = true; + // opera does not respect the auto grow header center column + // then, after it gets a width opera refuses to recalculate + // without a second pass + if(Roo.isOpera && !this.secondPass){ + main.rows[0].cells[1].style.width = (w - (main.rows[0].cells[0].offsetWidth+main.rows[0].cells[2].offsetWidth)) + "px"; + this.secondPass = true; + this.update.defer(10, this, [date]); + } + } + */ + + }, + + findCell : function(dt) { + dt = dt.clearTime().getTime(); + var ret = false; + this.cells.each(function(c){ + //Roo.log("check " +c.dateValue + '?=' + dt); + if(c.dateValue == dt){ + ret = c; + return false; + } + return true; + }); + + return ret; + }, + + findCells : function(ev) { + var s = ev.start.clone().clearTime().getTime(); + // Roo.log(s); + var e= ev.end.clone().clearTime().getTime(); + // Roo.log(e); + var ret = []; + this.cells.each(function(c){ + ////Roo.log("check " +c.dateValue + '<' + e + ' > ' + s); + + if(c.dateValue > e){ + return ; + } + if(c.dateValue < s){ + return ; + } + ret.push(c); + }); + + return ret; + }, + +// findBestRow: function(cells) +// { +// var ret = 0; +// +// for (var i =0 ; i < cells.length;i++) { +// ret = Math.max(cells[i].rows || 0,ret); +// } +// return ret; +// +// }, + + + addItem : function(ev) + { + // look for vertical location slot in + var cells = this.findCells(ev); + +// ev.row = this.findBestRow(cells); + + // work out the location. + + var crow = false; + var rows = []; + for(var i =0; i < cells.length; i++) { + + cells[i].row = cells[0].row; + + if(i == 0){ + cells[i].row = cells[i].row + 1; + } + + if (!crow) { + crow = { + start : cells[i], + end : cells[i] + }; + continue; + } + if (crow.start.getY() == cells[i].getY()) { + // on same row. + crow.end = cells[i]; + continue; + } + // different row. + rows.push(crow); + crow = { + start: cells[i], + end : cells[i] + }; + + } + + rows.push(crow); + ev.els = []; + ev.rows = rows; + ev.cells = cells; + + cells[0].events.push(ev); + + this.calevents.push(ev); + }, + + clearEvents: function() { + + if(!this.calevents){ + return; + } + + Roo.each(this.cells.elements, function(c){ + c.row = 0; + c.events = []; + c.more = []; + }); + + Roo.each(this.calevents, function(e) { + Roo.each(e.els, function(el) { + el.un('mouseenter' ,this.onEventEnter, this); + el.un('mouseleave' ,this.onEventLeave, this); + el.remove(); + },this); + },this); + + Roo.each(Roo.select('.fc-more-event', true).elements, function(e){ + e.remove(); + }); + + }, + + renderEvents: function() + { + var _this = this; + + this.cells.each(function(c) { + + if(c.row < 5){ + return; + } + + var ev = c.events; + + var r = 4; + if(c.row != c.events.length){ + r = 4 - (4 - (c.row - c.events.length)); + } + + c.events = ev.slice(0, r); + c.more = ev.slice(r); + + if(c.more.length && c.more.length == 1){ + c.events.push(c.more.pop()); + } + + c.row = (c.row - ev.length) + c.events.length + ((c.more.length) ? 1 : 0); + + }); + + this.cells.each(function(c) { + + c.select('.fc-day-content div',true).first().setHeight(Math.max(34, c.row * 20)); + + + for (var e = 0; e < c.events.length; e++){ + var ev = c.events[e]; + var rows = ev.rows; + + for(var i = 0; i < rows.length; i++) { + + // how many rows should it span.. + + var cfg = { + cls : 'roo-dynamic fc-event fc-event-hori fc-event-draggable ui-draggable', + style : 'position: absolute', // left: 387px; width: 121px; top: 359px; + + unselectable : "on", + cn : [ + { + cls: 'fc-event-inner', + cn : [ + // { + // tag:'span', + // cls: 'fc-event-time', + // html : cells.length > 1 ? '' : ev.time + // }, + { + tag:'span', + cls: 'fc-event-title', + html : String.format('{0}', ev.title) + } + + + ] + }, + { + cls: 'ui-resizable-handle ui-resizable-e', + html : '&nbsp;&nbsp;&nbsp' + } + + ] + }; + + if (i == 0) { + cfg.cls += ' fc-event-start'; + } + if ((i+1) == rows.length) { + cfg.cls += ' fc-event-end'; + } + + var ctr = _this.el.select('.fc-event-container',true).first(); + var cg = ctr.createChild(cfg); + + var sbox = rows[i].start.select('.fc-day-content',true).first().getBox(); + var ebox = rows[i].end.select('.fc-day-content',true).first().getBox(); + + var r = (c.more.length) ? 1 : 0; + cg.setXY([sbox.x +2, sbox.y + ((c.row - c.events.length - r + e) * 20)]); + cg.setWidth(ebox.right - sbox.x -2); + + cg.on('mouseenter' ,_this.onEventEnter, _this, ev); + cg.on('mouseleave' ,_this.onEventLeave, _this, ev); + cg.on('click', _this.onEventClick, _this, ev); + + ev.els.push(cg); + + } + + } + + + if(c.more.length){ + var cfg = { + cls : 'fc-more-event roo-dynamic fc-event fc-event-hori fc-event-draggable ui-draggable fc-event-start fc-event-end', + style : 'position: absolute', + unselectable : "on", + cn : [ + { + cls: 'fc-event-inner', + cn : [ + { + tag:'span', + cls: 'fc-event-title', + html : 'More' + } + + + ] + }, + { + cls: 'ui-resizable-handle ui-resizable-e', + html : '&nbsp;&nbsp;&nbsp' + } + + ] + }; + + var ctr = _this.el.select('.fc-event-container',true).first(); + var cg = ctr.createChild(cfg); + + var sbox = c.select('.fc-day-content',true).first().getBox(); + var ebox = c.select('.fc-day-content',true).first().getBox(); + //Roo.log(cg); + cg.setXY([sbox.x +2, sbox.y +((c.row - 1) * 20)]); + cg.setWidth(ebox.right - sbox.x -2); + + cg.on('click', _this.onMoreEventClick, _this, c.more); + + } + + }); + + + + }, + + onEventEnter: function (e, el,event,d) { + this.fireEvent('evententer', this, el, event); + }, + + onEventLeave: function (e, el,event,d) { + this.fireEvent('eventleave', this, el, event); + }, + + onEventClick: function (e, el,event,d) { + this.fireEvent('eventclick', this, el, event); + }, + + onMonthChange: function () { + this.store.load(); + }, + + onMoreEventClick: function(e, el, more) + { + var _this = this; + + this.calpopover.placement = 'right'; + this.calpopover.setTitle('More'); + + this.calpopover.setContent(''); + + var ctr = this.calpopover.el.select('.popover-content', true).first(); + + Roo.each(more, function(m){ + var cfg = { + cls : 'fc-event-hori fc-event-draggable', + html : m.title + }; + var cg = ctr.createChild(cfg); + + cg.on('click', _this.onEventClick, _this, m); + }); + + this.calpopover.show(el); + + + }, + + onLoad: function () + { + this.calevents = []; + var cal = this; + + if(this.store.getCount() > 0){ + this.store.data.each(function(d){ + cal.addItem({ + id : d.data.id, + start: (typeof(d.data.start_dt) === 'string') ? new Date.parseDate(d.data.start_dt, 'Y-m-d H:i:s') : d.data.start_dt, + end : (typeof(d.data.end_dt) === 'string') ? new Date.parseDate(d.data.end_dt, 'Y-m-d H:i:s') : d.data.end_dt, + time : d.data.start_time, + title : d.data.title, + description : d.data.description, + venue : d.data.venue + }); + }); + } + + this.renderEvents(); + + if(this.calevents.length && this.loadMask){ + this.maskEl.hide(); + } + }, + + onBeforeLoad: function() + { + this.clearEvents(); + if(this.loadMask){ + this.maskEl.show(); + } + } +}); + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_CheckBox.js.html b/docs2/src/Roo_bootstrap_CheckBox.js.html new file mode 100644 index 0000000000..6ae46d11d2 --- /dev/null +++ b/docs2/src/Roo_bootstrap_CheckBox.js.html @@ -0,0 +1,711 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/CheckBox.js/* + * - LGPL + * + * CheckBox + * + */ + +/** + * @class Roo.bootstrap.CheckBox + * @extends Roo.bootstrap.Input + * Bootstrap CheckBox class + * + * @cfg {String} valueOff The value that should go into the generated input element's value when unchecked. + * @cfg {String} inputValue The value that should go into the generated input element's value when checked. + * @cfg {String} boxLabel The text that appears beside the checkbox + * @cfg {String} weight (primary|warning|info|danger|success) The text that appears beside the checkbox + * @cfg {Boolean} checked initnal the element + * @cfg {Boolean} inline inline the element (default false) + * @cfg {String} groupId the checkbox group id // normal just use for checkbox + * @cfg {String} tooltip label tooltip + * + * @constructor + * Create a new CheckBox + * @param {Object} config The config object + */ + +Roo.bootstrap.CheckBox = function(config){ + Roo.bootstrap.CheckBox.superclass.constructor.call(this, config); + + this.addEvents({ + /** + * @event check + * Fires when the element is checked or unchecked. + * @param {Roo.bootstrap.CheckBox} this This input + * @param {Boolean} checked The new checked value + */ + check : true, + /** + * @event click + * Fires when the element is click. + * @param {Roo.bootstrap.CheckBox} this This input + */ + click : true + }); + +}; + +Roo.extend(Roo.bootstrap.CheckBox, Roo.bootstrap.Input, { + + inputType: 'checkbox', + inputValue: 1, + valueOff: 0, + boxLabel: false, + checked: false, + weight : false, + inline: false, + tooltip : '', + + getAutoCreate : function() + { + var align = (!this.labelAlign) ? this.parentLabelAlign() : this.labelAlign; + + var id = Roo.id(); + + var cfg = {}; + + cfg.cls = 'form-group ' + this.inputType; //input-group + + if(this.inline){ + cfg.cls += ' ' + this.inputType + '-inline'; + } + + var input = { + tag: 'input', + id : id, + type : this.inputType, + value : this.inputValue, + cls : 'roo-' + this.inputType, //'form-box', + placeholder : this.placeholder || '' + + }; + + if(this.inputType != 'radio'){ + var hidden = { + tag: 'input', + type : 'hidden', + cls : 'roo-hidden-value', + value : this.checked ? this.inputValue : this.valueOff + }; + } + + + if (this.weight) { // Validity check? + cfg.cls += " " + this.inputType + "-" + this.weight; + } + + if (this.disabled) { + input.disabled=true; + } + + if(this.checked){ + input.checked = this.checked; + } + + if (this.name) { + + input.name = this.name; + + if(this.inputType != 'radio'){ + hidden.name = this.name; + input.name = '_hidden_' + this.name; + } + } + + if (this.size) { + input.cls += ' input-' + this.size; + } + + var settings=this; + + ['xs','sm','md','lg'].map(function(size){ + if (settings[size]) { + cfg.cls += ' col-' + size + '-' + settings[size]; + } + }); + + var inputblock = input; + + if (this.before || this.after) { + + inputblock = { + cls : 'input-group', + cn : [] + }; + + if (this.before) { + inputblock.cn.push({ + tag :'span', + cls : 'input-group-addon', + html : this.before + }); + } + + inputblock.cn.push(input); + + if(this.inputType != 'radio'){ + inputblock.cn.push(hidden); + } + + if (this.after) { + inputblock.cn.push({ + tag :'span', + cls : 'input-group-addon', + html : this.after + }); + } + + } + + if (align ==='left' && this.fieldLabel.length) { +// Roo.log("left and has label"); + cfg.cn = [ + { + tag: 'label', + 'for' : id, + cls : 'control-label', + html : this.fieldLabel + }, + { + cls : "", + cn: [ + inputblock + ] + } + ]; + + if(this.labelWidth > 12){ + cfg.cn[0].style = "width: " + this.labelWidth + 'px'; + } + + if(this.labelWidth < 13 && this.labelmd == 0){ + this.labelmd = this.labelWidth; + } + + if(this.labellg > 0){ + cfg.cn[0].cls += ' col-lg-' + this.labellg; + cfg.cn[1].cls += ' col-lg-' + (12 - this.labellg); + } + + if(this.labelmd > 0){ + cfg.cn[0].cls += ' col-md-' + this.labelmd; + cfg.cn[1].cls += ' col-md-' + (12 - this.labelmd); + } + + if(this.labelsm > 0){ + cfg.cn[0].cls += ' col-sm-' + this.labelsm; + cfg.cn[1].cls += ' col-sm-' + (12 - this.labelsm); + } + + if(this.labelxs > 0){ + cfg.cn[0].cls += ' col-xs-' + this.labelxs; + cfg.cn[1].cls += ' col-xs-' + (12 - this.labelxs); + } + + } else if ( this.fieldLabel.length) { +// Roo.log(" label"); + cfg.cn = [ + + { + tag: this.boxLabel ? 'span' : 'label', + 'for': id, + cls: 'control-label box-input-label', + //cls : 'input-group-addon', + html : this.fieldLabel + }, + + inputblock + + ]; + + } else { + +// Roo.log(" no label && no align"); + cfg.cn = [ inputblock ] ; + + + } + + if(this.boxLabel){ + var boxLabelCfg = { + tag: 'label', + //'for': id, // box label is handled by onclick - so no for... + cls: 'box-label', + html: this.boxLabel + }; + + if(this.tooltip){ + boxLabelCfg.tooltip = this.tooltip; + } + + cfg.cn.push(boxLabelCfg); + } + + if(this.inputType != 'radio'){ + cfg.cn.push(hidden); + } + + return cfg; + + }, + + /** + * return the real input element. + */ + inputEl: function () + { + return this.el.select('input.roo-' + this.inputType,true).first(); + }, + hiddenEl: function () + { + return this.el.select('input.roo-hidden-value',true).first(); + }, + + labelEl: function() + { + return this.el.select('label.control-label',true).first(); + }, + /* depricated... */ + + label: function() + { + return this.labelEl(); + }, + + boxLabelEl: function() + { + return this.el.select('label.box-label',true).first(); + }, + + initEvents : function() + { +// Roo.bootstrap.CheckBox.superclass.initEvents.call(this); + + this.inputEl().on('click', this.onClick, this); + + if (this.boxLabel) { + this.el.select('label.box-label',true).first().on('click', this.onClick, this); + } + + this.startValue = this.getValue(); + + if(this.groupId){ + Roo.bootstrap.CheckBox.register(this); + } + }, + + onClick : function(e) + { + if(this.fireEvent('click', this, e) !== false){ + this.setChecked(!this.checked); + } + + }, + + setChecked : function(state,suppressEvent) + { + this.startValue = this.getValue(); + + if(this.inputType == 'radio'){ + + Roo.each(this.el.up('form').select('input[name='+this.name+']', true).elements, function(e){ + e.dom.checked = false; + }); + + this.inputEl().dom.checked = true; + + this.inputEl().dom.value = this.inputValue; + + if(suppressEvent !== true){ + this.fireEvent('check', this, true); + } + + this.validate(); + + return; + } + + this.checked = state; + + this.inputEl().dom.checked = state; + + + this.hiddenEl().dom.value = state ? this.inputValue : this.valueOff; + + if(suppressEvent !== true){ + this.fireEvent('check', this, state); + } + + this.validate(); + }, + + getValue : function() + { + if(this.inputType == 'radio'){ + return this.getGroupValue(); + } + + return this.hiddenEl().dom.value; + + }, + + getGroupValue : function() + { + if(typeof(this.el.up('form').child('input[name='+this.name+']:checked', true)) == 'undefined'){ + return ''; + } + + return this.el.up('form').child('input[name='+this.name+']:checked', true).value; + }, + + setValue : function(v,suppressEvent) + { + if(this.inputType == 'radio'){ + this.setGroupValue(v, suppressEvent); + return; + } + + this.setChecked(((typeof(v) == 'undefined') ? this.checked : (String(v) === String(this.inputValue))), suppressEvent); + + this.validate(); + }, + + setGroupValue : function(v, suppressEvent) + { + this.startValue = this.getValue(); + + Roo.each(this.el.up('form').select('input[name='+this.name+']', true).elements, function(e){ + e.dom.checked = false; + + if(e.dom.value == v){ + e.dom.checked = true; + } + }); + + if(suppressEvent !== true){ + this.fireEvent('check', this, true); + } + + this.validate(); + + return; + }, + + validate : function() + { + if(this.getVisibilityEl().hasClass('hidden')){ + return true; + } + + if( + this.disabled || + (this.inputType == 'radio' && this.validateRadio()) || + (this.inputType == 'checkbox' && this.validateCheckbox()) + ){ + this.markValid(); + return true; + } + + this.markInvalid(); + return false; + }, + + validateRadio : function() + { + if(this.getVisibilityEl().hasClass('hidden')){ + return true; + } + + if(this.allowBlank){ + return true; + } + + var valid = false; + + Roo.each(this.el.up('form').select('input[name='+this.name+']', true).elements, function(e){ + if(!e.dom.checked){ + return; + } + + valid = true; + + return false; + }); + + return valid; + }, + + validateCheckbox : function() + { + if(!this.groupId){ + return (this.getValue() == this.inputValue || this.allowBlank) ? true : false; + //return (this.getValue() == this.inputValue) ? true : false; + } + + var group = Roo.bootstrap.CheckBox.get(this.groupId); + + if(!group){ + return false; + } + + var r = false; + + for(var i in group){ + if(group[i].el.isVisible(true)){ + r = false; + break; + } + + r = true; + } + + for(var i in group){ + if(r){ + break; + } + + r = (group[i].getValue() == group[i].inputValue) ? true : false; + } + + return r; + }, + + /** + * Mark this field as valid + */ + markValid : function() + { + var _this = this; + + this.fireEvent('valid', this); + + var label = Roo.bootstrap.FieldLabel.get(this.name + '-group'); + + if(this.groupId){ + label = Roo.bootstrap.FieldLabel.get(this.groupId + '-group'); + } + + if(label){ + label.markValid(); + } + + if(this.inputType == 'radio'){ + Roo.each(this.el.up('form').select('input[name='+this.name+']', true).elements, function(e){ + var fg = e.findParent('.form-group', false, true); + if (Roo.bootstrap.version == 3) { + fg.removeClass([_this.invalidClass, _this.validClass]); + fg.addClass(_this.validClass); + } else { + fg.removeClass(['is-valid', 'is-invalid']); + fg.addClass('is-valid'); + } + }); + + return; + } + + if(!this.groupId){ + var fg = this.el.findParent('.form-group', false, true); + if (Roo.bootstrap.version == 3) { + fg.removeClass([this.invalidClass, this.validClass]); + fg.addClass(this.validClass); + } else { + fg.removeClass(['is-valid', 'is-invalid']); + fg.addClass('is-valid'); + } + return; + } + + var group = Roo.bootstrap.CheckBox.get(this.groupId); + + if(!group){ + return; + } + + for(var i in group){ + var fg = group[i].el.findParent('.form-group', false, true); + if (Roo.bootstrap.version == 3) { + fg.removeClass([this.invalidClass, this.validClass]); + fg.addClass(this.validClass); + } else { + fg.removeClass(['is-valid', 'is-invalid']); + fg.addClass('is-valid'); + } + } + }, + + /** + * Mark this field as invalid + * @param {String} msg The validation message + */ + markInvalid : function(msg) + { + if(this.allowBlank){ + return; + } + + var _this = this; + + this.fireEvent('invalid', this, msg); + + var label = Roo.bootstrap.FieldLabel.get(this.name + '-group'); + + if(this.groupId){ + label = Roo.bootstrap.FieldLabel.get(this.groupId + '-group'); + } + + if(label){ + label.markInvalid(); + } + + if(this.inputType == 'radio'){ + + Roo.each(this.el.up('form').select('input[name='+this.name+']', true).elements, function(e){ + var fg = e.findParent('.form-group', false, true); + if (Roo.bootstrap.version == 3) { + fg.removeClass([_this.invalidClass, _this.validClass]); + fg.addClass(_this.invalidClass); + } else { + fg.removeClass(['is-invalid', 'is-valid']); + fg.addClass('is-invalid'); + } + }); + + return; + } + + if(!this.groupId){ + var fg = this.el.findParent('.form-group', false, true); + if (Roo.bootstrap.version == 3) { + fg.removeClass([_this.invalidClass, _this.validClass]); + fg.addClass(_this.invalidClass); + } else { + fg.removeClass(['is-invalid', 'is-valid']); + fg.addClass('is-invalid'); + } + return; + } + + var group = Roo.bootstrap.CheckBox.get(this.groupId); + + if(!group){ + return; + } + + for(var i in group){ + var fg = group[i].el.findParent('.form-group', false, true); + if (Roo.bootstrap.version == 3) { + fg.removeClass([_this.invalidClass, _this.validClass]); + fg.addClass(_this.invalidClass); + } else { + fg.removeClass(['is-invalid', 'is-valid']); + fg.addClass('is-invalid'); + } + } + + }, + + clearInvalid : function() + { + Roo.bootstrap.Input.prototype.clearInvalid.call(this); + + // this.el.findParent('.form-group', false, true).removeClass([this.invalidClass, this.validClass]); + + var label = Roo.bootstrap.FieldLabel.get(this.name + '-group'); + + if (label && label.iconEl) { + label.iconEl.removeClass([ label.validClass, label.invalidClass ]); + label.iconEl.removeClass(['is-invalid', 'is-valid']); + } + }, + + disable : function() + { + if(this.inputType != 'radio'){ + Roo.bootstrap.CheckBox.superclass.disable.call(this); + return; + } + + var _this = this; + + if(this.rendered){ + Roo.each(this.el.up('form').select('input[name='+this.name+']', true).elements, function(e){ + _this.getActionEl().addClass(this.disabledClass); + e.dom.disabled = true; + }); + } + + this.disabled = true; + this.fireEvent("disable", this); + return this; + }, + + enable : function() + { + if(this.inputType != 'radio'){ + Roo.bootstrap.CheckBox.superclass.enable.call(this); + return; + } + + var _this = this; + + if(this.rendered){ + Roo.each(this.el.up('form').select('input[name='+this.name+']', true).elements, function(e){ + _this.getActionEl().removeClass(this.disabledClass); + e.dom.disabled = false; + }); + } + + this.disabled = false; + this.fireEvent("enable", this); + return this; + }, + + setBoxLabel : function(v) + { + this.boxLabel = v; + + if(this.rendered){ + this.el.select('label.box-label',true).first().dom.innerHTML = (v === null || v === undefined ? '' : v); + } + } + +}); + +Roo.apply(Roo.bootstrap.CheckBox, { + + groups: {}, + + /** + * register a CheckBox Group + * @param {Roo.bootstrap.CheckBox} the CheckBox to add + */ + register : function(checkbox) + { + if(typeof(this.groups[checkbox.groupId]) == 'undefined'){ + this.groups[checkbox.groupId] = {}; + } + + if(this.groups[checkbox.groupId].hasOwnProperty(checkbox.name)){ + return; + } + + this.groups[checkbox.groupId][checkbox.name] = checkbox; + + }, + /** + * fetch a CheckBox Group based on the group ID + * @param {string} the group ID + * @returns {Roo.bootstrap.CheckBox} the CheckBox group + */ + get: function(groupId) { + if (typeof(this.groups[groupId]) == 'undefined') { + return false; + } + + return this.groups[groupId] ; + } + + +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Column.js.html b/docs2/src/Roo_bootstrap_Column.js.html new file mode 100644 index 0000000000..e51388bda0 --- /dev/null +++ b/docs2/src/Roo_bootstrap_Column.js.html @@ -0,0 +1,118 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Column.js/* + * - LGPL + * + * column + * + */ + +/** + * @class Roo.bootstrap.Column + * @extends Roo.bootstrap.Component + * Bootstrap Column class + * @cfg {Number} xs colspan out of 12 for mobile-sized screens or 0 for hidden + * @cfg {Number} sm colspan out of 12 for tablet-sized screens or 0 for hidden + * @cfg {Number} md colspan out of 12 for computer-sized screens or 0 for hidden + * @cfg {Number} lg colspan out of 12 for large computer-sized screens or 0 for hidden + * @cfg {Number} xsoff colspan offset out of 12 for mobile-sized screens or 0 for hidden + * @cfg {Number} smoff colspan offset out of 12 for tablet-sized screens or 0 for hidden + * @cfg {Number} mdoff colspan offset out of 12 for computer-sized screens or 0 for hidden + * @cfg {Number} lgoff colspan offset out of 12 for large computer-sized screens or 0 for hidden + * + * + * @cfg {Boolean} hidden (true|false) hide the element + * @cfg {String} alert (success|info|warning|danger) type alert (changes background / border...) + * @cfg {String} fa (ban|check|...) font awesome icon + * @cfg {Number} fasize (1|2|....) font awsome size + + * @cfg {String} icon (info-sign|check|...) glyphicon name + + * @cfg {String} html content of column. + * + * @constructor + * Create a new Column + * @param {Object} config The config object + */ + +Roo.bootstrap.Column = function(config){ + Roo.bootstrap.Column.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.Column, Roo.bootstrap.Component, { + + xs: false, + sm: false, + md: false, + lg: false, + xsoff: false, + smoff: false, + mdoff: false, + lgoff: false, + html: '', + offset: 0, + alert: false, + fa: false, + icon : false, + hidden : false, + fasize : 1, + + getAutoCreate : function(){ + var cfg = Roo.apply({}, Roo.bootstrap.Column.superclass.getAutoCreate.call(this)); + + cfg = { + tag: 'div', + cls: 'column' + }; + + var settings=this; + ['xs','sm','md','lg'].map(function(size){ + //Roo.log( size + ':' + settings[size]); + + if (settings[size+'off'] !== false) { + cfg.cls += ' col-' + size + '-offset-' + settings[size+'off'] ; + } + + if (settings[size] === false) { + return; + } + + if (!settings[size]) { // 0 = hidden + cfg.cls += ' hidden-' + size; + return; + } + cfg.cls += ' col-' + size + '-' + settings[size]; + + }); + + if (this.hidden) { + cfg.cls += ' hidden'; + } + + if (this.alert && ["success","info","warning", "danger"].indexOf(this.alert) > -1) { + cfg.cls +=' alert alert-' + this.alert; + } + + + if (this.html.length) { + cfg.html = this.html; + } + if (this.fa) { + var fasize = ''; + if (this.fasize > 1) { + fasize = ' fa-' + this.fasize + 'x'; + } + cfg.html = '<i class="fa fa-'+this.fa + fasize + '"></i>' + (cfg.html || ''); + + + } + if (this.icon) { + cfg.html = '<i class="glyphicon glyphicon-'+this.icon + '"></i>' + (cfg.html || ''); + } + + return cfg; + } + +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_ComboBox.js.html b/docs2/src/Roo_bootstrap_ComboBox.js.html new file mode 100644 index 0000000000..141987bf06 --- /dev/null +++ b/docs2/src/Roo_bootstrap_ComboBox.js.html @@ -0,0 +1,3099 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/ComboBox.js/* + * - LGPL + * * + */ + +/** + * @class Roo.bootstrap.ComboBox + * @extends Roo.bootstrap.TriggerField + * A combobox control with support for autocomplete, remote-loading, paging and many other features. + * @cfg {Boolean} append (true|false) default false + * @cfg {Boolean} autoFocus (true|false) auto focus the first item, default true + * @cfg {Boolean} tickable ComboBox with tickable selections (true|false), default false + * @cfg {Boolean} triggerList trigger show the list or not (true|false) default true + * @cfg {Boolean} showToggleBtn show toggle button or not (true|false) default true + * @cfg {String} btnPosition set the position of the trigger button (left | right) default right + * @cfg {Boolean} animate default true + * @cfg {Boolean} emptyResultText only for touch device + * @cfg {String} triggerText multiple combobox trigger button text default 'Select' + * @cfg {String} emptyTitle default '' + * @constructor + * Create a new ComboBox. + * @param {Object} config Configuration options + */ +Roo.bootstrap.ComboBox = function(config){ + Roo.bootstrap.ComboBox.superclass.constructor.call(this, config); + this.addEvents({ + /** + * @event expand + * Fires when the dropdown list is expanded + * @param {Roo.bootstrap.ComboBox} combo This combo box + */ + 'expand' : true, + /** + * @event collapse + * Fires when the dropdown list is collapsed + * @param {Roo.bootstrap.ComboBox} combo This combo box + */ + 'collapse' : true, + /** + * @event beforeselect + * Fires before a list item is selected. Return false to cancel the selection. + * @param {Roo.bootstrap.ComboBox} combo This combo box + * @param {Roo.data.Record} record The data record returned from the underlying store + * @param {Number} index The index of the selected item in the dropdown list + */ + 'beforeselect' : true, + /** + * @event select + * Fires when a list item is selected + * @param {Roo.bootstrap.ComboBox} combo This combo box + * @param {Roo.data.Record} record The data record returned from the underlying store (or false on clear) + * @param {Number} index The index of the selected item in the dropdown list + */ + 'select' : true, + /** + * @event beforequery + * Fires before all queries are processed. Return false to cancel the query or set cancel to true. + * The event object passed has these properties: + * @param {Roo.bootstrap.ComboBox} combo This combo box + * @param {String} query The query + * @param {Boolean} forceAll true to force "all" query + * @param {Boolean} cancel true to cancel the query + * @param {Object} e The query event object + */ + 'beforequery': true, + /** + * @event add + * Fires when the 'add' icon is pressed (add a listener to enable add button) + * @param {Roo.bootstrap.ComboBox} combo This combo box + */ + 'add' : true, + /** + * @event edit + * Fires when the 'edit' icon is pressed (add a listener to enable add button) + * @param {Roo.bootstrap.ComboBox} combo This combo box + * @param {Roo.data.Record|false} record The data record returned from the underlying store (or false on nothing selected) + */ + 'edit' : true, + /** + * @event remove + * Fires when the remove value from the combobox array + * @param {Roo.bootstrap.ComboBox} combo This combo box + */ + 'remove' : true, + /** + * @event afterremove + * Fires when the remove value from the combobox array + * @param {Roo.bootstrap.ComboBox} combo This combo box + */ + 'afterremove' : true, + /** + * @event specialfilter + * Fires when specialfilter + * @param {Roo.bootstrap.ComboBox} combo This combo box + */ + 'specialfilter' : true, + /** + * @event tick + * Fires when tick the element + * @param {Roo.bootstrap.ComboBox} combo This combo box + */ + 'tick' : true, + /** + * @event touchviewdisplay + * Fires when touch view require special display (default is using displayField) + * @param {Roo.bootstrap.ComboBox} combo This combo box + * @param {Object} cfg set html . + */ + 'touchviewdisplay' : true + + }); + + this.item = []; + this.tickItems = []; + + this.selectedIndex = -1; + if(this.mode == 'local'){ + if(config.queryDelay === undefined){ + this.queryDelay = 10; + } + if(config.minChars === undefined){ + this.minChars = 0; + } + } +}; + +Roo.extend(Roo.bootstrap.ComboBox, Roo.bootstrap.TriggerField, { + + /** + * @cfg {Boolean} lazyRender True to prevent the ComboBox from rendering until requested (should always be used when + * rendering into an Roo.Editor, defaults to false) + */ + /** + * @cfg {Boolean/Object} autoCreate A DomHelper element spec, or true for a default element spec (defaults to: + * {tag: "input", type: "text", size: "24", autocomplete: "off"}) + */ + /** + * @cfg {Roo.data.Store} store The data store to which this combo is bound (defaults to undefined) + */ + /** + * @cfg {String} title If supplied, a header element is created containing this text and added into the top of + * the dropdown list (defaults to undefined, with no header element) + */ + + /** + * @cfg {String/Roo.Template} tpl The template to use to render the output + */ + + /** + * @cfg {Number} listWidth The width in pixels of the dropdown list (defaults to the width of the ComboBox field) + */ + listWidth: undefined, + /** + * @cfg {String} displayField The underlying data field name to bind to this CombBox (defaults to undefined if + * mode = 'remote' or 'text' if mode = 'local') + */ + displayField: undefined, + + /** + * @cfg {String} valueField The underlying data value name to bind to this CombBox (defaults to undefined if + * mode = 'remote' or 'value' if mode = 'local'). + * Note: use of a valueField requires the user make a selection + * in order for a value to be mapped. + */ + valueField: undefined, + /** + * @cfg {String} modalTitle The title of the dialog that pops up on mobile views. + */ + modalTitle : '', + + /** + * @cfg {String} hiddenName If specified, a hidden form field with this name is dynamically generated to store the + * field's data value (defaults to the underlying DOM element's name) + */ + hiddenName: undefined, + /** + * @cfg {String} listClass CSS class to apply to the dropdown list element (defaults to '') + */ + listClass: '', + /** + * @cfg {String} selectedClass CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected') + */ + selectedClass: 'active', + + /** + * @cfg {Boolean/String} shadow True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right + */ + shadow:'sides', + /** + * @cfg {String} listAlign A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported + * anchor positions (defaults to 'tl-bl') + */ + listAlign: 'tl-bl?', + /** + * @cfg {Number} maxHeight The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300) + */ + maxHeight: 300, + /** + * @cfg {String} triggerAction The action to execute when the trigger field is activated. Use 'all' to run the + * query specified by the allQuery config option (defaults to 'query') + */ + triggerAction: 'query', + /** + * @cfg {Number} minChars The minimum number of characters the user must type before autocomplete and typeahead activate + * (defaults to 4, does not apply if editable = false) + */ + minChars : 4, + /** + * @cfg {Boolean} typeAhead True to populate and autoselect the remainder of the text being typed after a configurable + * delay (typeAheadDelay) if it matches a known value (defaults to false) + */ + typeAhead: false, + /** + * @cfg {Number} queryDelay The length of time in milliseconds to delay between the start of typing and sending the + * query to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local') + */ + queryDelay: 500, + /** + * @cfg {Number} pageSize If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the + * filter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0) + */ + pageSize: 0, + /** + * @cfg {Boolean} selectOnFocus True to select any existing text in the field immediately on focus. Only applies + * when editable = true (defaults to false) + */ + selectOnFocus:false, + /** + * @cfg {String} queryParam Name of the query as it will be passed on the querystring (defaults to 'query') + */ + queryParam: 'query', + /** + * @cfg {String} loadingText The text to display in the dropdown list while data is loading. Only applies + * when mode = 'remote' (defaults to 'Loading...') + */ + loadingText: 'Loading...', + /** + * @cfg {Boolean} resizable True to add a resize handle to the bottom of the dropdown list (defaults to false) + */ + resizable: false, + /** + * @cfg {Number} handleHeight The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8) + */ + handleHeight : 8, + /** + * @cfg {Boolean} editable False to prevent the user from typing text directly into the field, just like a + * traditional select (defaults to true) + */ + editable: true, + /** + * @cfg {String} allQuery The text query to send to the server to return all records for the list with no filtering (defaults to '') + */ + allQuery: '', + /** + * @cfg {String} mode Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server) + */ + mode: 'remote', + /** + * @cfg {Number} minListWidth The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if + * listWidth has a higher value) + */ + minListWidth : 70, + /** + * @cfg {Boolean} forceSelection True to restrict the selected value to one of the values in the list, false to + * allow the user to set arbitrary text into the field (defaults to false) + */ + forceSelection:false, + /** + * @cfg {Number} typeAheadDelay The length of time in milliseconds to wait until the typeahead text is displayed + * if typeAhead = true (defaults to 250) + */ + typeAheadDelay : 250, + /** + * @cfg {String} valueNotFoundText When using a name/value combo, if the value passed to setValue is not found in + * the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined) + */ + valueNotFoundText : undefined, + /** + * @cfg {Boolean} blockFocus Prevents all focus calls, so it can work with things like HTML edtor bar + */ + blockFocus : false, + + /** + * @cfg {Boolean} disableClear Disable showing of clear button. + */ + disableClear : false, + /** + * @cfg {Boolean} alwaysQuery Disable caching of results, and always send query + */ + alwaysQuery : false, + + /** + * @cfg {Boolean} multiple (true|false) ComboBobArray, default false + */ + multiple : false, + + /** + * @cfg {String} invalidClass DEPRICATED - uses BS4 is-valid now + */ + invalidClass : "has-warning", + + /** + * @cfg {String} validClass DEPRICATED - uses BS4 is-valid now + */ + validClass : "has-success", + + /** + * @cfg {Boolean} specialFilter (true|false) special filter default false + */ + specialFilter : false, + + /** + * @cfg {Boolean} mobileTouchView (true|false) show mobile touch view when using a mobile default true + */ + mobileTouchView : true, + + /** + * @cfg {Boolean} useNativeIOS (true|false) render it as classic select for ios, not support dynamic load data (default false) + */ + useNativeIOS : false, + + /** + * @cfg {Boolean} mobile_restrict_height (true|false) restrict height for touch view + */ + mobile_restrict_height : false, + + ios_options : false, + + //private + addicon : false, + editicon: false, + + page: 0, + hasQuery: false, + append: false, + loadNext: false, + autoFocus : true, + tickable : false, + btnPosition : 'right', + triggerList : true, + showToggleBtn : true, + animate : true, + emptyResultText: 'Empty', + triggerText : 'Select', + emptyTitle : '', + + // element that contains real text value.. (when hidden is used..) + + getAutoCreate : function() + { + var cfg = false; + //render + /* + * Render classic select for iso + */ + + if(Roo.isIOS && this.useNativeIOS){ + cfg = this.getAutoCreateNativeIOS(); + return cfg; + } + + /* + * Touch Devices + */ + + if(Roo.isTouch && this.mobileTouchView){ + cfg = this.getAutoCreateTouchView(); + return cfg;; + } + + /* + * Normal ComboBox + */ + if(!this.tickable){ + cfg = Roo.bootstrap.ComboBox.superclass.getAutoCreate.call(this); + return cfg; + } + + /* + * ComboBox with tickable selections + */ + + var align = this.labelAlign || this.parentLabelAlign(); + + cfg = { + cls : 'form-group roo-combobox-tickable' //input-group + }; + + var btn_text_select = ''; + var btn_text_done = ''; + var btn_text_cancel = ''; + + if (this.btn_text_show) { + btn_text_select = 'Select'; + btn_text_done = 'Done'; + btn_text_cancel = 'Cancel'; + } + + var buttons = { + tag : 'div', + cls : 'tickable-buttons', + cn : [ + { + tag : 'button', + type : 'button', + cls : 'btn btn-link btn-edit pull-' + this.btnPosition, + //html : this.triggerText + html: btn_text_select + }, + { + tag : 'button', + type : 'button', + name : 'ok', + cls : 'btn btn-link btn-ok pull-' + this.btnPosition, + //html : 'Done' + html: btn_text_done + }, + { + tag : 'button', + type : 'button', + name : 'cancel', + cls : 'btn btn-link btn-cancel pull-' + this.btnPosition, + //html : 'Cancel' + html: btn_text_cancel + } + ] + }; + + if(this.editable){ + buttons.cn.unshift({ + tag: 'input', + cls: 'roo-select2-search-field-input' + }); + } + + var _this = this; + + Roo.each(buttons.cn, function(c){ + if (_this.size) { + c.cls += ' btn-' + _this.size; + } + + if (_this.disabled) { + c.disabled = true; + } + }); + + var box = { + tag: 'div', + style : 'display: contents', + cn: [ + { + tag: 'input', + type : 'hidden', + cls: 'form-hidden-field' + }, + { + tag: 'ul', + cls: 'roo-select2-choices', + cn:[ + { + tag: 'li', + cls: 'roo-select2-search-field', + cn: [ + buttons + ] + } + ] + } + ] + }; + + var combobox = { + cls: 'roo-select2-container input-group roo-select2-container-multi', + cn: [ + + box +// { +// tag: 'ul', +// cls: 'typeahead typeahead-long dropdown-menu', +// style: 'display:none; max-height:' + this.maxHeight + 'px;' +// } + ] + }; + + if(this.hasFeedback && !this.allowBlank){ + + var feedback = { + tag: 'span', + cls: 'glyphicon form-control-feedback' + }; + + combobox.cn.push(feedback); + } + + var indicator = { + tag : 'i', + cls : 'roo-required-indicator ' + (this.indicatorpos == 'right' ? 'right' : 'left') +'-indicator text-danger fa fa-lg fa-star', + tooltip : 'This field is required' + }; + if (Roo.bootstrap.version == 4) { + indicator = { + tag : 'i', + style : 'display:none' + }; + } + if (align ==='left' && this.fieldLabel.length) { + + cfg.cls += ' roo-form-group-label-left' + (Roo.bootstrap.version == 4 ? ' row' : ''); + + cfg.cn = [ + indicator, + { + tag: 'label', + 'for' : id, + cls : 'control-label col-form-label', + html : this.fieldLabel + + }, + { + cls : "", + cn: [ + combobox + ] + } + + ]; + + var labelCfg = cfg.cn[1]; + var contentCfg = cfg.cn[2]; + + + if(this.indicatorpos == 'right'){ + + cfg.cn = [ + { + tag: 'label', + 'for' : id, + cls : 'control-label col-form-label', + cn : [ + { + tag : 'span', + html : this.fieldLabel + }, + indicator + ] + }, + { + cls : "", + cn: [ + combobox + ] + } + + ]; + + + + labelCfg = cfg.cn[0]; + contentCfg = cfg.cn[1]; + + } + + if(this.labelWidth > 12){ + labelCfg.style = "width: " + this.labelWidth + 'px'; + } + + if(this.labelWidth < 13 && this.labelmd == 0){ + this.labelmd = this.labelWidth; + } + + if(this.labellg > 0){ + labelCfg.cls += ' col-lg-' + this.labellg; + contentCfg.cls += ' col-lg-' + (12 - this.labellg); + } + + if(this.labelmd > 0){ + labelCfg.cls += ' col-md-' + this.labelmd; + contentCfg.cls += ' col-md-' + (12 - this.labelmd); + } + + if(this.labelsm > 0){ + labelCfg.cls += ' col-sm-' + this.labelsm; + contentCfg.cls += ' col-sm-' + (12 - this.labelsm); + } + + if(this.labelxs > 0){ + labelCfg.cls += ' col-xs-' + this.labelxs; + contentCfg.cls += ' col-xs-' + (12 - this.labelxs); + } + + + } else if ( this.fieldLabel.length) { +// Roo.log(" label"); + cfg.cn = [ + indicator, + { + tag: 'label', + //cls : 'input-group-addon', + html : this.fieldLabel + }, + combobox + ]; + + if(this.indicatorpos == 'right'){ + cfg.cn = [ + { + tag: 'label', + //cls : 'input-group-addon', + html : this.fieldLabel + }, + indicator, + combobox + ]; + + } + + } else { + +// Roo.log(" no label && no align"); + cfg = combobox + + + } + + var settings=this; + ['xs','sm','md','lg'].map(function(size){ + if (settings[size]) { + cfg.cls += ' col-' + size + '-' + settings[size]; + } + }); + + return cfg; + + }, + + _initEventsCalled : false, + + // private + initEvents: function() + { + if (this._initEventsCalled) { // as we call render... prevent looping... + return; + } + this._initEventsCalled = true; + + if (!this.store) { + throw "can not find store for combo"; + } + + this.indicator = this.indicatorEl(); + + this.store = Roo.factory(this.store, Roo.data); + this.store.parent = this; + + // if we are building from html. then this element is so complex, that we can not really + // use the rendered HTML. + // so we have to trash and replace the previous code. + if (Roo.XComponent.build_from_html) { + // remove this element.... + var e = this.el.dom, k=0; + while (e ) { e = e.previousSibling; ++k;} + + this.el.remove(); + + this.el=false; + this.rendered = false; + + this.render(this.parent().getChildContainer(true), k); + } + + if(Roo.isIOS && this.useNativeIOS){ + this.initIOSView(); + return; + } + + /* + * Touch Devices + */ + + if(Roo.isTouch && this.mobileTouchView){ + this.initTouchView(); + return; + } + + if(this.tickable){ + this.initTickableEvents(); + return; + } + + Roo.bootstrap.ComboBox.superclass.initEvents.call(this); + + if(this.hiddenName){ + + this.hiddenField = this.el.select('input.form-hidden-field',true).first(); + + this.hiddenField.dom.value = + this.hiddenValue !== undefined ? this.hiddenValue : + this.value !== undefined ? this.value : ''; + + // prevent input submission + this.el.dom.removeAttribute('name'); + this.hiddenField.dom.setAttribute('name', this.hiddenName); + + + } + //if(Roo.isGecko){ + // this.el.dom.setAttribute('autocomplete', 'off'); + //} + + var cls = 'x-combo-list'; + + //this.list = new Roo.Layer({ + // shadow: this.shadow, cls: [cls, this.listClass].join(' '), constrain:false + //}); + + var _this = this; + + (function(){ + var lw = _this.listWidth || Math.max(_this.inputEl().getWidth(), _this.minListWidth); + _this.list.setWidth(lw); + }).defer(100); + + this.list.on('mouseover', this.onViewOver, this); + this.list.on('mousemove', this.onViewMove, this); + this.list.on('scroll', this.onViewScroll, this); + + /* + this.list.swallowEvent('mousewheel'); + this.assetHeight = 0; + + if(this.title){ + this.header = this.list.createChild({cls:cls+'-hd', html: this.title}); + this.assetHeight += this.header.getHeight(); + } + + this.innerList = this.list.createChild({cls:cls+'-inner'}); + this.innerList.on('mouseover', this.onViewOver, this); + this.innerList.on('mousemove', this.onViewMove, this); + this.innerList.setWidth(lw - this.list.getFrameWidth('lr')); + + if(this.allowBlank && !this.pageSize && !this.disableClear){ + this.footer = this.list.createChild({cls:cls+'-ft'}); + this.pageTb = new Roo.Toolbar(this.footer); + + } + if(this.pageSize){ + this.footer = this.list.createChild({cls:cls+'-ft'}); + this.pageTb = new Roo.PagingToolbar(this.footer, this.store, + {pageSize: this.pageSize}); + + } + + if (this.pageTb && this.allowBlank && !this.disableClear) { + var _this = this; + this.pageTb.add(new Roo.Toolbar.Fill(), { + cls: 'x-btn-icon x-btn-clear', + text: '&#160;', + handler: function() + { + _this.collapse(); + _this.clearValue(); + _this.onSelect(false, -1); + } + }); + } + if (this.footer) { + this.assetHeight += this.footer.getHeight(); + } + */ + + if(!this.tpl){ + this.tpl = Roo.bootstrap.version == 4 ? + '<a class="dropdown-item" href="#">{' + this.displayField + '}</a>' : // 4 does not need <li> and it get's really confisued. + '<li><a class="dropdown-item" href="#">{' + this.displayField + '}</a></li>'; + } + + this.view = new Roo.View(this.list, this.tpl, { + singleSelect:true, store: this.store, selectedClass: this.selectedClass + }); + //this.view.wrapEl.setDisplayed(false); + this.view.on('click', this.onViewClick, this); + + + this.store.on('beforeload', this.onBeforeLoad, this); + this.store.on('load', this.onLoad, this); + this.store.on('loadexception', this.onLoadException, this); + /* + if(this.resizable){ + this.resizer = new Roo.Resizable(this.list, { + pinned:true, handles:'se' + }); + this.resizer.on('resize', function(r, w, h){ + this.maxHeight = h-this.handleHeight-this.list.getFrameWidth('tb')-this.assetHeight; + this.listWidth = w; + this.innerList.setWidth(w - this.list.getFrameWidth('lr')); + this.restrictHeight(); + }, this); + this[this.pageSize?'footer':'innerList'].setStyle('margin-bottom', this.handleHeight+'px'); + } + */ + if(!this.editable){ + this.editable = true; + this.setEditable(false); + } + + /* + + if (typeof(this.events.add.listeners) != 'undefined') { + + this.addicon = this.wrap.createChild( + {tag: 'img', src: Roo.BLANK_IMAGE_URL, cls: 'x-form-combo-add' }); + + this.addicon.on('click', function(e) { + this.fireEvent('add', this); + }, this); + } + if (typeof(this.events.edit.listeners) != 'undefined') { + + this.editicon = this.wrap.createChild( + {tag: 'img', src: Roo.BLANK_IMAGE_URL, cls: 'x-form-combo-edit' }); + if (this.addicon) { + this.editicon.setStyle('margin-left', '40px'); + } + this.editicon.on('click', function(e) { + + // we fire even if inothing is selected.. + this.fireEvent('edit', this, this.lastData ); + + }, this); + } + */ + + this.keyNav = new Roo.KeyNav(this.inputEl(), { + "up" : function(e){ + this.inKeyMode = true; + this.selectPrev(); + }, + + "down" : function(e){ + if(!this.isExpanded()){ + this.onTriggerClick(); + }else{ + this.inKeyMode = true; + this.selectNext(); + } + }, + + "enter" : function(e){ +// this.onViewClick(); + //return true; + this.collapse(); + + if(this.fireEvent("specialkey", this, e)){ + this.onViewClick(false); + } + + return true; + }, + + "esc" : function(e){ + this.collapse(); + }, + + "tab" : function(e){ + this.collapse(); + + if(this.fireEvent("specialkey", this, e)){ + this.onViewClick(false); + } + + return true; + }, + + scope : this, + + doRelay : function(foo, bar, hname){ + if(hname == 'down' || this.scope.isExpanded()){ + return Roo.KeyNav.prototype.doRelay.apply(this, arguments); + } + return true; + }, + + forceKeyDown: true + }); + + + this.queryDelay = Math.max(this.queryDelay || 10, + this.mode == 'local' ? 10 : 250); + + + this.dqTask = new Roo.util.DelayedTask(this.initQuery, this); + + if(this.typeAhead){ + this.taTask = new Roo.util.DelayedTask(this.onTypeAhead, this); + } + if(this.editable !== false){ + this.inputEl().on("keyup", this.onKeyUp, this); + } + if(this.forceSelection){ + this.inputEl().on('blur', this.doForce, this); + } + + if(this.multiple){ + this.choices = this.el.select('ul.roo-select2-choices', true).first(); + this.searchField = this.el.select('ul li.roo-select2-search-field', true).first(); + } + }, + + initTickableEvents: function() + { + this.createList(); + + if(this.hiddenName){ + + this.hiddenField = this.el.select('input.form-hidden-field',true).first(); + + this.hiddenField.dom.value = + this.hiddenValue !== undefined ? this.hiddenValue : + this.value !== undefined ? this.value : ''; + + // prevent input submission + this.el.dom.removeAttribute('name'); + this.hiddenField.dom.setAttribute('name', this.hiddenName); + + + } + +// this.list = this.el.select('ul.dropdown-menu',true).first(); + + this.choices = this.el.select('ul.roo-select2-choices', true).first(); + this.searchField = this.el.select('ul li.roo-select2-search-field', true).first(); + if(this.triggerList){ + this.searchField.on("click", this.onSearchFieldClick, this, {preventDefault:true}); + } + + this.trigger = this.el.select('.tickable-buttons > .btn-edit', true).first(); + this.trigger.on("click", this.onTickableTriggerClick, this, {preventDefault:true}); + + this.okBtn = this.el.select('.tickable-buttons > .btn-ok', true).first(); + this.cancelBtn = this.el.select('.tickable-buttons > .btn-cancel', true).first(); + + this.okBtn.on('click', this.onTickableFooterButtonClick, this, this.okBtn); + this.cancelBtn.on('click', this.onTickableFooterButtonClick, this, this.cancelBtn); + + this.trigger.setVisibilityMode(Roo.Element.DISPLAY); + this.okBtn.setVisibilityMode(Roo.Element.DISPLAY); + this.cancelBtn.setVisibilityMode(Roo.Element.DISPLAY); + + this.okBtn.hide(); + this.cancelBtn.hide(); + + var _this = this; + + (function(){ + var lw = _this.listWidth || Math.max(_this.inputEl().getWidth(), _this.minListWidth); + _this.list.setWidth(lw); + }).defer(100); + + this.list.on('mouseover', this.onViewOver, this); + this.list.on('mousemove', this.onViewMove, this); + + this.list.on('scroll', this.onViewScroll, this); + + if(!this.tpl){ + this.tpl = '<li class="roo-select2-result"><div class="checkbox"><input id="{roo-id}"' + + 'type="checkbox" {roo-data-checked}><label for="{roo-id}"><b>{' + this.displayField + '}</b></label></div></li>'; + } + + this.view = new Roo.View(this.list, this.tpl, { + singleSelect:true, + tickable:true, + parent:this, + store: this.store, + selectedClass: this.selectedClass + }); + + //this.view.wrapEl.setDisplayed(false); + this.view.on('click', this.onViewClick, this); + + + + this.store.on('beforeload', this.onBeforeLoad, this); + this.store.on('load', this.onLoad, this); + this.store.on('loadexception', this.onLoadException, this); + + if(this.editable){ + this.keyNav = new Roo.KeyNav(this.tickableInputEl(), { + "up" : function(e){ + this.inKeyMode = true; + this.selectPrev(); + }, + + "down" : function(e){ + this.inKeyMode = true; + this.selectNext(); + }, + + "enter" : function(e){ + if(this.fireEvent("specialkey", this, e)){ + this.onViewClick(false); + } + + return true; + }, + + "esc" : function(e){ + this.onTickableFooterButtonClick(e, false, false); + }, + + "tab" : function(e){ + this.fireEvent("specialkey", this, e); + + this.onTickableFooterButtonClick(e, false, false); + + return true; + }, + + scope : this, + + doRelay : function(e, fn, key){ + if(this.scope.isExpanded()){ + return Roo.KeyNav.prototype.doRelay.apply(this, arguments); + } + return true; + }, + + forceKeyDown: true + }); + } + + this.queryDelay = Math.max(this.queryDelay || 10, + this.mode == 'local' ? 10 : 250); + + + this.dqTask = new Roo.util.DelayedTask(this.initQuery, this); + + if(this.typeAhead){ + this.taTask = new Roo.util.DelayedTask(this.onTypeAhead, this); + } + + if(this.editable !== false){ + this.tickableInputEl().on("keyup", this.onKeyUp, this); + } + + this.indicator = this.indicatorEl(); + + if(this.indicator){ + this.indicator.setVisibilityMode(Roo.Element.DISPLAY); + this.indicator.hide(); + } + + }, + + onDestroy : function(){ + if(this.view){ + this.view.setStore(null); + this.view.el.removeAllListeners(); + this.view.el.remove(); + this.view.purgeListeners(); + } + if(this.list){ + this.list.dom.innerHTML = ''; + } + + if(this.store){ + this.store.un('beforeload', this.onBeforeLoad, this); + this.store.un('load', this.onLoad, this); + this.store.un('loadexception', this.onLoadException, this); + } + Roo.bootstrap.ComboBox.superclass.onDestroy.call(this); + }, + + // private + fireKey : function(e){ + if(e.isNavKeyPress() && !this.list.isVisible()){ + this.fireEvent("specialkey", this, e); + } + }, + + // private + onResize: function(w, h){ +// Roo.bootstrap.ComboBox.superclass.onResize.apply(this, arguments); +// +// if(typeof w != 'number'){ +// // we do not handle it!?!? +// return; +// } +// var tw = this.trigger.getWidth(); +// // tw += this.addicon ? this.addicon.getWidth() : 0; +// // tw += this.editicon ? this.editicon.getWidth() : 0; +// var x = w - tw; +// this.inputEl().setWidth( this.adjustWidth('input', x)); +// +// //this.trigger.setStyle('left', x+'px'); +// +// if(this.list && this.listWidth === undefined){ +// var lw = Math.max(x + this.trigger.getWidth(), this.minListWidth); +// this.list.setWidth(lw); +// this.innerList.setWidth(lw - this.list.getFrameWidth('lr')); +// } + + + + }, + + /** + * Allow or prevent the user from directly editing the field text. If false is passed, + * the user will only be able to select from the items defined in the dropdown list. This method + * is the runtime equivalent of setting the 'editable' config option at config time. + * @param {Boolean} value True to allow the user to directly edit the field text + */ + setEditable : function(value){ + if(value == this.editable){ + return; + } + this.editable = value; + if(!value){ + this.inputEl().dom.setAttribute('readOnly', true); + this.inputEl().on('mousedown', this.onTriggerClick, this); + this.inputEl().addClass('x-combo-noedit'); + }else{ + this.inputEl().dom.setAttribute('readOnly', false); + this.inputEl().un('mousedown', this.onTriggerClick, this); + this.inputEl().removeClass('x-combo-noedit'); + } + }, + + // private + + onBeforeLoad : function(combo,opts){ + if(!this.hasFocus){ + return; + } + if (!opts.add) { + this.list.dom.innerHTML = '<li class="loading-indicator">'+(this.loadingText||'loading')+'</li>' ; + } + this.restrictHeight(); + this.selectedIndex = -1; + }, + + // private + onLoad : function(){ + + this.hasQuery = false; + + if(!this.hasFocus){ + return; + } + + if(typeof(this.loading) !== 'undefined' && this.loading !== null){ + this.loading.hide(); + } + + if(this.store.getCount() > 0){ + + this.expand(); + this.restrictHeight(); + if(this.lastQuery == this.allQuery){ + if(this.editable && !this.tickable){ + this.inputEl().dom.select(); + } + + if( + !this.selectByValue(this.value, true) && + this.autoFocus && + ( + !this.store.lastOptions || + typeof(this.store.lastOptions.add) == 'undefined' || + this.store.lastOptions.add != true + ) + ){ + this.select(0, true); + } + }else{ + if(this.autoFocus){ + this.selectNext(); + } + if(this.typeAhead && this.lastKey != Roo.EventObject.BACKSPACE && this.lastKey != Roo.EventObject.DELETE){ + this.taTask.delay(this.typeAheadDelay); + } + } + }else{ + this.onEmptyResults(); + } + + //this.el.focus(); + }, + // private + onLoadException : function() + { + this.hasQuery = false; + + if(typeof(this.loading) !== 'undefined' && this.loading !== null){ + this.loading.hide(); + } + + if(this.tickable && this.editable){ + return; + } + + this.collapse(); + // only causes errors at present + //Roo.log(this.store.reader.jsonData); + //if (this.store && typeof(this.store.reader.jsonData.errorMsg) != 'undefined') { + // fixme + //Roo.MessageBox.alert("Error loading",this.store.reader.jsonData.errorMsg); + //} + + + }, + // private + onTypeAhead : function(){ + if(this.store.getCount() > 0){ + var r = this.store.getAt(0); + var newValue = r.data[this.displayField]; + var len = newValue.length; + var selStart = this.getRawValue().length; + + if(selStart != len){ + this.setRawValue(newValue); + this.selectText(selStart, newValue.length); + } + } + }, + + // private + onSelect : function(record, index){ + + if(this.fireEvent('beforeselect', this, record, index) !== false){ + + this.setFromData(index > -1 ? record.data : false); + + this.collapse(); + this.fireEvent('select', this, record, index); + } + }, + + /** + * Returns the currently selected field value or empty string if no value is set. + * @return {String} value The selected value + */ + getValue : function() + { + if(Roo.isIOS && this.useNativeIOS){ + return this.ios_options[this.inputEl().dom.selectedIndex].data[this.valueField]; + } + + if(this.multiple){ + return (this.hiddenField) ? this.hiddenField.dom.value : this.value; + } + + if(this.valueField){ + return typeof this.value != 'undefined' ? this.value : ''; + }else{ + return Roo.bootstrap.ComboBox.superclass.getValue.call(this); + } + }, + + getRawValue : function() + { + if(Roo.isIOS && this.useNativeIOS){ + return this.ios_options[this.inputEl().dom.selectedIndex].data[this.displayField]; + } + + var v = this.inputEl().getValue(); + + return v; + }, + + /** + * Clears any text/value currently set in the field + */ + clearValue : function(){ + + if(this.hiddenField){ + this.hiddenField.dom.value = ''; + } + this.value = ''; + this.setRawValue(''); + this.lastSelectionText = ''; + this.lastData = false; + + var close = this.closeTriggerEl(); + + if(close){ + close.hide(); + } + + this.validate(); + + }, + + /** + * Sets the specified value into the field. If the value finds a match, the corresponding record text + * will be displayed in the field. If the value does not match the data value of an existing item, + * and the valueNotFoundText config option is defined, it will be displayed as the default field text. + * Otherwise the field will be blank (although the value will still be set). + * @param {String} value The value to match + */ + setValue : function(v) + { + if(Roo.isIOS && this.useNativeIOS){ + this.setIOSValue(v); + return; + } + + if(this.multiple){ + this.syncValue(); + return; + } + + var text = v; + if(this.valueField){ + var r = this.findRecord(this.valueField, v); + if(r){ + text = r.data[this.displayField]; + }else if(this.valueNotFoundText !== undefined){ + text = this.valueNotFoundText; + } + } + this.lastSelectionText = text; + if(this.hiddenField){ + this.hiddenField.dom.value = v; + } + Roo.bootstrap.ComboBox.superclass.setValue.call(this, text); + this.value = v; + + var close = this.closeTriggerEl(); + + if(close){ + (v && (v.length || v * 1 > 0)) ? close.show() : close.hide(); + } + + this.validate(); + }, + /** + * @property {Object} the last set data for the element + */ + + lastData : false, + /** + * Sets the value of the field based on a object which is related to the record format for the store. + * @param {Object} value the value to set as. or false on reset? + */ + setFromData : function(o){ + + if(this.multiple){ + this.addItem(o); + return; + } + + var dv = ''; // display value + var vv = ''; // value value.. + this.lastData = o; + if (this.displayField) { + dv = !o || typeof(o[this.displayField]) == 'undefined' ? '' : o[this.displayField]; + } else { + // this is an error condition!!! + Roo.log('no displayField value set for '+ (this.name ? this.name : this.id)); + } + + if(this.valueField){ + vv = !o || typeof(o[this.valueField]) == 'undefined' ? dv : o[this.valueField]; + } + + var close = this.closeTriggerEl(); + + if(close){ + if(dv.length || vv * 1 > 0){ + close.show() ; + this.blockFocus=true; + } else { + close.hide(); + } + } + + if(this.hiddenField){ + this.hiddenField.dom.value = vv; + + this.lastSelectionText = dv; + Roo.bootstrap.ComboBox.superclass.setValue.call(this, dv); + this.value = vv; + return; + } + // no hidden field.. - we store the value in 'value', but still display + // display field!!!! + this.lastSelectionText = dv; + Roo.bootstrap.ComboBox.superclass.setValue.call(this, dv); + this.value = vv; + + + + }, + // private + reset : function(){ + // overridden so that last data is reset.. + + if(this.multiple){ + this.clearItem(); + return; + } + + this.setValue(this.originalValue); + //this.clearInvalid(); + this.lastData = false; + if (this.view) { + this.view.clearSelections(); + } + + this.validate(); + }, + // private + findRecord : function(prop, value){ + var record; + if(this.store.getCount() > 0){ + this.store.each(function(r){ + if(r.data[prop] == value){ + record = r; + return false; + } + return true; + }); + } + return record; + }, + + getName: function() + { + // returns hidden if it's set.. + if (!this.rendered) {return ''}; + return !this.hiddenName && this.inputEl().dom.name ? this.inputEl().dom.name : (this.hiddenName || ''); + + }, + // private + onViewMove : function(e, t){ + this.inKeyMode = false; + }, + + // private + onViewOver : function(e, t){ + if(this.inKeyMode){ // prevent key nav and mouse over conflicts + return; + } + var item = this.view.findItemFromChild(t); + + if(item){ + var index = this.view.indexOf(item); + this.select(index, false); + } + }, + + // private + onViewClick : function(view, doFocus, el, e) + { + var index = this.view.getSelectedIndexes()[0]; + + var r = this.store.getAt(index); + + if(this.tickable){ + + if(typeof(e) != 'undefined' && e.getTarget().nodeName.toLowerCase() != 'input'){ + return; + } + + var rm = false; + var _this = this; + + Roo.each(this.tickItems, function(v,k){ + + if(typeof(v) != 'undefined' && v[_this.valueField] == r.data[_this.valueField]){ + Roo.log(v); + _this.tickItems.splice(k, 1); + + if(typeof(e) == 'undefined' && view == false){ + Roo.get(_this.view.getNodes(index, index)[0]).select('input', true).first().dom.checked = false; + } + + rm = true; + return; + } + }); + + if(rm){ + return; + } + + if(this.fireEvent('tick', this, r, index, Roo.get(_this.view.getNodes(index, index)[0]).select('input', true).first().dom.checked) !== false){ + this.tickItems.push(r.data); + } + + if(typeof(e) == 'undefined' && view == false){ + Roo.get(_this.view.getNodes(index, index)[0]).select('input', true).first().dom.checked = true; + } + + return; + } + + if(r){ + this.onSelect(r, index); + } + if(doFocus !== false && !this.blockFocus){ + this.inputEl().focus(); + } + }, + + // private + restrictHeight : function(){ + //this.innerList.dom.style.height = ''; + //var inner = this.innerList.dom; + //var h = Math.max(inner.clientHeight, inner.offsetHeight, inner.scrollHeight); + //this.innerList.setHeight(h < this.maxHeight ? 'auto' : this.maxHeight); + //this.list.beginUpdate(); + //this.list.setHeight(this.innerList.getHeight()+this.list.getFrameWidth('tb')+(this.resizable?this.handleHeight:0)+this.assetHeight); + this.list.alignTo(this.inputEl(), this.listAlign); + this.list.alignTo(this.inputEl(), this.listAlign); + //this.list.endUpdate(); + }, + + // private + onEmptyResults : function(){ + + if(this.tickable && this.editable){ + this.hasFocus = false; + this.restrictHeight(); + return; + } + + this.collapse(); + }, + + /** + * Returns true if the dropdown list is expanded, else false. + */ + isExpanded : function(){ + return this.list.isVisible(); + }, + + /** + * Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire. + * The store must be loaded and the list expanded for this function to work, otherwise use setValue. + * @param {String} value The data value of the item to select + * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the + * selected item if it is not currently in view (defaults to true) + * @return {Boolean} True if the value matched an item in the list, else false + */ + selectByValue : function(v, scrollIntoView){ + if(v !== undefined && v !== null){ + var r = this.findRecord(this.valueField || this.displayField, v); + if(r){ + this.select(this.store.indexOf(r), scrollIntoView); + return true; + } + } + return false; + }, + + /** + * Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire. + * The store must be loaded and the list expanded for this function to work, otherwise use setValue. + * @param {Number} index The zero-based index of the list item to select + * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the + * selected item if it is not currently in view (defaults to true) + */ + select : function(index, scrollIntoView){ + this.selectedIndex = index; + this.view.select(index); + if(scrollIntoView !== false){ + var el = this.view.getNode(index); + /* + * el && !this.multiple && !this.tickable // not sure why we disable multiple before.. + */ + if(el){ + this.list.scrollChildIntoView(el, false); + } + } + }, + + // private + selectNext : function(){ + var ct = this.store.getCount(); + if(ct > 0){ + if(this.selectedIndex == -1){ + this.select(0); + }else if(this.selectedIndex < ct-1){ + this.select(this.selectedIndex+1); + } + } + }, + + // private + selectPrev : function(){ + var ct = this.store.getCount(); + if(ct > 0){ + if(this.selectedIndex == -1){ + this.select(0); + }else if(this.selectedIndex != 0){ + this.select(this.selectedIndex-1); + } + } + }, + + // private + onKeyUp : function(e){ + if(this.editable !== false && !e.isSpecialKey()){ + this.lastKey = e.getKey(); + this.dqTask.delay(this.queryDelay); + } + }, + + // private + validateBlur : function(){ + return !this.list || !this.list.isVisible(); + }, + + // private + initQuery : function(){ + + var v = this.getRawValue(); + + if(this.tickable && this.editable){ + v = this.tickableInputEl().getValue(); + } + + this.doQuery(v); + }, + + // private + doForce : function(){ + if(this.inputEl().dom.value.length > 0){ + this.inputEl().dom.value = + this.lastSelectionText === undefined ? '' : this.lastSelectionText; + + } + }, + + /** + * Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the + * query allowing the query action to be canceled if needed. + * @param {String} query The SQL query to execute + * @param {Boolean} forceAll True to force the query to execute even if there are currently fewer characters + * in the field than the minimum specified by the minChars config option. It also clears any filter previously + * saved in the current store (defaults to false) + */ + doQuery : function(q, forceAll){ + + if(q === undefined || q === null){ + q = ''; + } + var qe = { + query: q, + forceAll: forceAll, + combo: this, + cancel:false + }; + if(this.fireEvent('beforequery', qe)===false || qe.cancel){ + return false; + } + q = qe.query; + + forceAll = qe.forceAll; + if(forceAll === true || (q.length >= this.minChars)){ + + this.hasQuery = true; + + if(this.lastQuery != q || this.alwaysQuery){ + this.lastQuery = q; + if(this.mode == 'local'){ + this.selectedIndex = -1; + if(forceAll){ + this.store.clearFilter(); + }else{ + + if(this.specialFilter){ + this.fireEvent('specialfilter', this); + this.onLoad(); + return; + } + + this.store.filter(this.displayField, q); + } + + this.store.fireEvent("datachanged", this.store); + + this.onLoad(); + + + }else{ + + this.store.baseParams[this.queryParam] = q; + + var options = {params : this.getParams(q)}; + + if(this.loadNext){ + options.add = true; + options.params.start = this.page * this.pageSize; + } + + this.store.load(options); + + /* + * this code will make the page width larger, at the beginning, the list not align correctly, + * we should expand the list on onLoad + * so command out it + */ +// this.expand(); + } + }else{ + this.selectedIndex = -1; + this.onLoad(); + } + } + + this.loadNext = false; + }, + + // private + getParams : function(q){ + var p = {}; + //p[this.queryParam] = q; + + if(this.pageSize){ + p.start = 0; + p.limit = this.pageSize; + } + return p; + }, + + /** + * Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion. + */ + collapse : function(){ + if(!this.isExpanded()){ + return; + } + + this.list.hide(); + + this.hasFocus = false; + + if(this.tickable){ + this.okBtn.hide(); + this.cancelBtn.hide(); + this.trigger.show(); + + if(this.editable){ + this.tickableInputEl().dom.value = ''; + this.tickableInputEl().blur(); + } + + } + + Roo.get(document).un('mousedown', this.collapseIf, this); + Roo.get(document).un('mousewheel', this.collapseIf, this); + if (!this.editable) { + Roo.get(document).un('keydown', this.listKeyPress, this); + } + this.fireEvent('collapse', this); + + this.validate(); + }, + + // private + collapseIf : function(e){ + var in_combo = e.within(this.el); + var in_list = e.within(this.list); + var is_list = (Roo.get(e.getTarget()).id == this.list.id) ? true : false; + + if (in_combo || in_list || is_list) { + //e.stopPropagation(); + return; + } + + if(this.tickable){ + this.onTickableFooterButtonClick(e, false, false); + } + + this.collapse(); + + }, + + /** + * Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion. + */ + expand : function(){ + + if(this.isExpanded() || !this.hasFocus){ + return; + } + + var lw = this.listWidth || Math.max(this.inputEl().getWidth(), this.minListWidth); + this.list.setWidth(lw); + + Roo.log('expand'); + + this.list.show(); + + this.restrictHeight(); + + if(this.tickable){ + + this.tickItems = Roo.apply([], this.item); + + this.okBtn.show(); + this.cancelBtn.show(); + this.trigger.hide(); + + if(this.editable){ + this.tickableInputEl().focus(); + } + + } + + Roo.get(document).on('mousedown', this.collapseIf, this); + Roo.get(document).on('mousewheel', this.collapseIf, this); + if (!this.editable) { + Roo.get(document).on('keydown', this.listKeyPress, this); + } + + this.fireEvent('expand', this); + }, + + // private + // Implements the default empty TriggerField.onTriggerClick function + onTriggerClick : function(e) + { + Roo.log('trigger click'); + + if(this.disabled || !this.triggerList){ + return; + } + + this.page = 0; + this.loadNext = false; + + if(this.isExpanded()){ + this.collapse(); + if (!this.blockFocus) { + this.inputEl().focus(); + } + + }else { + this.hasFocus = true; + if(this.triggerAction == 'all') { + this.doQuery(this.allQuery, true); + } else { + this.doQuery(this.getRawValue()); + } + if (!this.blockFocus) { + this.inputEl().focus(); + } + } + }, + + onTickableTriggerClick : function(e) + { + if(this.disabled){ + return; + } + + this.page = 0; + this.loadNext = false; + this.hasFocus = true; + + if(this.triggerAction == 'all') { + this.doQuery(this.allQuery, true); + } else { + this.doQuery(this.getRawValue()); + } + }, + + onSearchFieldClick : function(e) + { + if(this.hasFocus && !this.disabled && e.getTarget().nodeName.toLowerCase() != 'button'){ + this.onTickableFooterButtonClick(e, false, false); + return; + } + + if(this.hasFocus || this.disabled || e.getTarget().nodeName.toLowerCase() == 'button'){ + return; + } + + this.page = 0; + this.loadNext = false; + this.hasFocus = true; + + if(this.triggerAction == 'all') { + this.doQuery(this.allQuery, true); + } else { + this.doQuery(this.getRawValue()); + } + }, + + listKeyPress : function(e) + { + //Roo.log('listkeypress'); + // scroll to first matching element based on key pres.. + if (e.isSpecialKey()) { + return false; + } + var k = String.fromCharCode(e.getKey()).toUpperCase(); + //Roo.log(k); + var match = false; + var csel = this.view.getSelectedNodes(); + var cselitem = false; + if (csel.length) { + var ix = this.view.indexOf(csel[0]); + cselitem = this.store.getAt(ix); + if (!cselitem.get(this.displayField) || cselitem.get(this.displayField).substring(0,1).toUpperCase() != k) { + cselitem = false; + } + + } + + this.store.each(function(v) { + if (cselitem) { + // start at existing selection. + if (cselitem.id == v.id) { + cselitem = false; + } + return true; + } + + if (v.get(this.displayField) && v.get(this.displayField).substring(0,1).toUpperCase() == k) { + match = this.store.indexOf(v); + return false; + } + return true; + }, this); + + if (match === false) { + return true; // no more action? + } + // scroll to? + this.view.select(match); + var sn = Roo.get(this.view.getSelectedNodes()[0]); + sn.scrollIntoView(sn.dom.parentNode, false); + }, + + onViewScroll : function(e, t){ + + if(this.view.el.getScroll().top == 0 ||this.view.el.getScroll().top < this.view.el.dom.scrollHeight - this.view.el.dom.clientHeight || !this.hasFocus || !this.append || this.hasQuery){ + return; + } + + this.hasQuery = true; + + this.loading = this.list.select('.loading', true).first(); + + if(this.loading === null){ + this.list.createChild({ + tag: 'div', + cls: 'loading roo-select2-more-results roo-select2-active', + html: 'Loading more results...' + }); + + this.loading = this.list.select('.loading', true).first(); + + this.loading.setVisibilityMode(Roo.Element.DISPLAY); + + this.loading.hide(); + } + + this.loading.show(); + + var _combo = this; + + this.page++; + this.loadNext = true; + + (function() { _combo.doQuery(_combo.allQuery, true); }).defer(500); + + return; + }, + + addItem : function(o) + { + var dv = ''; // display value + + if (this.displayField) { + dv = !o || typeof(o[this.displayField]) == 'undefined' ? '' : o[this.displayField]; + } else { + // this is an error condition!!! + Roo.log('no displayField value set for '+ (this.name ? this.name : this.id)); + } + + if(!dv.length){ + return; + } + + var choice = this.choices.createChild({ + tag: 'li', + cls: 'roo-select2-search-choice', + cn: [ + { + tag: 'div', + html: dv + }, + { + tag: 'a', + href: '#', + cls: 'roo-select2-search-choice-close fa fa-times', + tabindex: '-1' + } + ] + + }, this.searchField); + + var close = choice.select('a.roo-select2-search-choice-close', true).first(); + + close.on('click', this.onRemoveItem, this, { item : choice, data : o} ); + + this.item.push(o); + + this.lastData = o; + + this.syncValue(); + + this.inputEl().dom.value = ''; + + this.validate(); + }, + + onRemoveItem : function(e, _self, o) + { + e.preventDefault(); + + this.lastItem = Roo.apply([], this.item); + + var index = this.item.indexOf(o.data) * 1; + + if( index < 0){ + Roo.log('not this item?!'); + return; + } + + this.item.splice(index, 1); + o.item.remove(); + + this.syncValue(); + + this.fireEvent('remove', this, e); + + this.validate(); + + }, + + syncValue : function() + { + if(!this.item.length){ + this.clearValue(); + return; + } + + var value = []; + var _this = this; + Roo.each(this.item, function(i){ + if(_this.valueField){ + value.push(i[_this.valueField]); + return; + } + + value.push(i); + }); + + this.value = value.join(','); + + if(this.hiddenField){ + this.hiddenField.dom.value = this.value; + } + + this.store.fireEvent("datachanged", this.store); + + this.validate(); + }, + + clearItem : function() + { + if(!this.multiple){ + return; + } + + this.item = []; + + Roo.each(this.choices.select('>li.roo-select2-search-choice', true).elements, function(c){ + c.remove(); + }); + + this.syncValue(); + + this.validate(); + + if(this.tickable && !Roo.isTouch){ + this.view.refresh(); + } + }, + + inputEl: function () + { + if(Roo.isIOS && this.useNativeIOS){ + return this.el.select('select.roo-ios-select', true).first(); + } + + if(Roo.isTouch && this.mobileTouchView){ + return this.el.select('input.form-control',true).first(); + } + + if(this.tickable){ + return this.searchField; + } + + return this.el.select('input.form-control',true).first(); + }, + + onTickableFooterButtonClick : function(e, btn, el) + { + e.preventDefault(); + + this.lastItem = Roo.apply([], this.item); + + if(btn && btn.name == 'cancel'){ + this.tickItems = Roo.apply([], this.item); + this.collapse(); + return; + } + + this.clearItem(); + + var _this = this; + + Roo.each(this.tickItems, function(o){ + _this.addItem(o); + }); + + this.collapse(); + + }, + + validate : function() + { + if(this.getVisibilityEl().hasClass('hidden')){ + return true; + } + + var v = this.getRawValue(); + + if(this.multiple){ + v = this.getValue(); + } + + if(this.disabled || this.allowBlank || v.length){ + this.markValid(); + return true; + } + + this.markInvalid(); + return false; + }, + + tickableInputEl : function() + { + if(!this.tickable || !this.editable){ + return this.inputEl(); + } + + return this.inputEl().select('.roo-select2-search-field-input', true).first(); + }, + + + getAutoCreateTouchView : function() + { + var id = Roo.id(); + + var cfg = { + cls: 'form-group' //input-group + }; + + var input = { + tag: 'input', + id : id, + type : this.inputType, + cls : 'form-control x-combo-noedit', + autocomplete: 'new-password', + placeholder : this.placeholder || '', + readonly : true + }; + + if (this.name) { + input.name = this.name; + } + + if (this.size) { + input.cls += ' input-' + this.size; + } + + if (this.disabled) { + input.disabled = true; + } + + var inputblock = { + cls : '', + cn : [ + input + ] + }; + + if(this.before){ + inputblock.cls += ' input-group'; + + inputblock.cn.unshift({ + tag :'span', + cls : 'input-group-addon input-group-prepend input-group-text', + html : this.before + }); + } + + if(this.removable && !this.multiple){ + inputblock.cls += ' roo-removable'; + + inputblock.cn.push({ + tag: 'button', + html : 'x', + cls : 'roo-combo-removable-btn close' + }); + } + + if(this.hasFeedback && !this.allowBlank){ + + inputblock.cls += ' has-feedback'; + + inputblock.cn.push({ + tag: 'span', + cls: 'glyphicon form-control-feedback' + }); + + } + + if (this.after) { + + inputblock.cls += (this.before) ? '' : ' input-group'; + + inputblock.cn.push({ + tag :'span', + cls : 'input-group-addon input-group-append input-group-text', + html : this.after + }); + } + + + var ibwrap = inputblock; + + if(this.multiple){ + ibwrap = { + tag: 'ul', + cls: 'roo-select2-choices', + cn:[ + { + tag: 'li', + cls: 'roo-select2-search-field', + cn: [ + + inputblock + ] + } + ] + }; + + + } + + var combobox = { + cls: 'roo-select2-container input-group roo-touchview-combobox ', + cn: [ + { + tag: 'input', + type : 'hidden', + cls: 'form-hidden-field' + }, + ibwrap + ] + }; + + if(!this.multiple && this.showToggleBtn){ + + var caret = { + tag: 'span', + cls: 'caret' + }; + + if (this.caret != false) { + caret = { + tag: 'i', + cls: 'fa fa-' + this.caret + }; + + } + + combobox.cn.push({ + tag :'span', + cls : 'input-group-addon input-group-append input-group-text btn dropdown-toggle', + cn : [ + caret, + { + tag: 'span', + cls: 'combobox-clear', + cn : [ + { + tag : 'i', + cls: 'icon-remove' + } + ] + } + ] + + }) + } + + if(this.multiple){ + combobox.cls += ' roo-select2-container-multi'; + } + + var align = this.labelAlign || this.parentLabelAlign(); + + if (align ==='left' && this.fieldLabel.length) { + + cfg.cn = [ + { + tag : 'i', + cls : 'roo-required-indicator left-indicator text-danger fa fa-lg fa-star', + tooltip : 'This field is required' + }, + { + tag: 'label', + cls : 'control-label col-form-label', + html : this.fieldLabel + + }, + { + cls : '', + cn: [ + combobox + ] + } + ]; + + var labelCfg = cfg.cn[1]; + var contentCfg = cfg.cn[2]; + + + if(this.indicatorpos == 'right'){ + cfg.cn = [ + { + tag: 'label', + 'for' : id, + cls : 'control-label col-form-label', + cn : [ + { + tag : 'span', + html : this.fieldLabel + }, + { + tag : 'i', + cls : 'roo-required-indicator right-indicator text-danger fa fa-lg fa-star', + tooltip : 'This field is required' + } + ] + }, + { + cls : "", + cn: [ + combobox + ] + } + + ]; + + labelCfg = cfg.cn[0]; + contentCfg = cfg.cn[1]; + } + + + + if(this.labelWidth > 12){ + labelCfg.style = "width: " + this.labelWidth + 'px'; + } + + if(this.labelWidth < 13 && this.labelmd == 0){ + this.labelmd = this.labelWidth; + } + + if(this.labellg > 0){ + labelCfg.cls += ' col-lg-' + this.labellg; + contentCfg.cls += ' col-lg-' + (12 - this.labellg); + } + + if(this.labelmd > 0){ + labelCfg.cls += ' col-md-' + this.labelmd; + contentCfg.cls += ' col-md-' + (12 - this.labelmd); + } + + if(this.labelsm > 0){ + labelCfg.cls += ' col-sm-' + this.labelsm; + contentCfg.cls += ' col-sm-' + (12 - this.labelsm); + } + + if(this.labelxs > 0){ + labelCfg.cls += ' col-xs-' + this.labelxs; + contentCfg.cls += ' col-xs-' + (12 - this.labelxs); + } + + + } else if ( this.fieldLabel.length) { + cfg.cn = [ + { + tag : 'i', + cls : 'roo-required-indicator left-indicator text-danger fa fa-lg fa-star', + tooltip : 'This field is required' + }, + { + tag: 'label', + cls : 'control-label', + html : this.fieldLabel + + }, + { + cls : '', + cn: [ + combobox + ] + } + ]; + + if(this.indicatorpos == 'right'){ + cfg.cn = [ + { + tag: 'label', + cls : 'control-label', + html : this.fieldLabel, + cn : [ + { + tag : 'i', + cls : 'roo-required-indicator right-indicator text-danger fa fa-lg fa-star', + tooltip : 'This field is required' + } + ] + }, + { + cls : '', + cn: [ + combobox + ] + } + ]; + } + } else { + cfg.cn = combobox; + } + + + var settings = this; + + ['xs','sm','md','lg'].map(function(size){ + if (settings[size]) { + cfg.cls += ' col-' + size + '-' + settings[size]; + } + }); + + return cfg; + }, + + initTouchView : function() + { + this.renderTouchView(); + + this.touchViewEl.on('scroll', function(){ + this.el.dom.scrollTop = 0; + }, this); + + this.originalValue = this.getValue(); + + this.triggerEl = this.el.select('span.dropdown-toggle',true).first(); + + this.inputEl().on("click", this.showTouchView, this); + if (this.triggerEl) { + this.triggerEl.on("click", this.showTouchView, this); + } + + + this.touchViewFooterEl.select('.roo-touch-view-cancel', true).first().on('click', this.hideTouchView, this); + this.touchViewFooterEl.select('.roo-touch-view-ok', true).first().on('click', this.setTouchViewValue, this); + + this.maskEl = new Roo.LoadMask(this.touchViewEl, { store : this.store, msgCls: 'roo-el-mask-msg' }); + + this.store.on('beforeload', this.onTouchViewBeforeLoad, this); + this.store.on('load', this.onTouchViewLoad, this); + this.store.on('loadexception', this.onTouchViewLoadException, this); + + if(this.hiddenName){ + + this.hiddenField = this.el.select('input.form-hidden-field',true).first(); + + this.hiddenField.dom.value = + this.hiddenValue !== undefined ? this.hiddenValue : + this.value !== undefined ? this.value : ''; + + this.el.dom.removeAttribute('name'); + this.hiddenField.dom.setAttribute('name', this.hiddenName); + } + + if(this.multiple){ + this.choices = this.el.select('ul.roo-select2-choices', true).first(); + this.searchField = this.el.select('ul li.roo-select2-search-field', true).first(); + } + + if(this.removable && !this.multiple){ + var close = this.closeTriggerEl(); + if(close){ + close.setVisibilityMode(Roo.Element.DISPLAY).hide(); + close.on('click', this.removeBtnClick, this, close); + } + } + /* + * fix the bug in Safari iOS8 + */ + this.inputEl().on("focus", function(e){ + document.activeElement.blur(); + }, this); + + this._touchViewMask = Roo.DomHelper.append(document.body, {tag: "div", cls:"x-dlg-mask"}, true); + + return; + + + }, + + renderTouchView : function() + { + this.touchViewEl = Roo.get(document.body).createChild(Roo.bootstrap.ComboBox.touchViewTemplate); + this.touchViewEl.setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + + this.touchViewHeaderEl = this.touchViewEl.select('.modal-header', true).first(); + this.touchViewHeaderEl.setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + + this.touchViewBodyEl = this.touchViewEl.select('.modal-body', true).first(); + this.touchViewBodyEl.setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + this.touchViewBodyEl.setStyle('overflow', 'auto'); + + this.touchViewListGroup = this.touchViewBodyEl.select('.list-group', true).first(); + this.touchViewListGroup.setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + + this.touchViewFooterEl = this.touchViewEl.select('.modal-footer', true).first(); + this.touchViewFooterEl.setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + + }, + + showTouchView : function() + { + if(this.disabled){ + return; + } + + this.touchViewHeaderEl.hide(); + + if(this.modalTitle.length){ + this.touchViewHeaderEl.dom.innerHTML = this.modalTitle; + this.touchViewHeaderEl.show(); + } + + this.touchViewEl.setStyle('z-index', Roo.bootstrap.Modal.zIndex++); + this.touchViewEl.show(); + + this.touchViewEl.select('.modal-dialog', true).first().setStyle({ margin : '0px', width : '100%'}); + + //this.touchViewEl.select('.modal-dialog > .modal-content', true).first().setSize( + // Roo.lib.Dom.getViewWidth(true), Roo.lib.Dom.getViewHeight(true)); + + var bodyHeight = Roo.lib.Dom.getViewHeight() - this.touchViewFooterEl.getHeight() + this.touchViewBodyEl.getPadding('tb'); + + if(this.modalTitle.length){ + bodyHeight = bodyHeight - this.touchViewHeaderEl.getHeight(); + } + + this.touchViewBodyEl.setHeight(bodyHeight); + + if(this.animate){ + var _this = this; + (function(){ _this.touchViewEl.addClass('in'); }).defer(50); + }else{ + this.touchViewEl.addClass('in'); + } + + if(this._touchViewMask){ + Roo.get(document.body).addClass("x-body-masked"); + this._touchViewMask.setSize(Roo.lib.Dom.getViewWidth(true), Roo.lib.Dom.getViewHeight(true)); + this._touchViewMask.setStyle('z-index', 10000); + this._touchViewMask.addClass('show'); + } + + this.doTouchViewQuery(); + + }, + + hideTouchView : function() + { + this.touchViewEl.removeClass('in'); + + if(this.animate){ + var _this = this; + (function(){ _this.touchViewEl.setStyle('display', 'none'); }).defer(150); + }else{ + this.touchViewEl.setStyle('display', 'none'); + } + + if(this._touchViewMask){ + this._touchViewMask.removeClass('show'); + Roo.get(document.body).removeClass("x-body-masked"); + } + }, + + setTouchViewValue : function() + { + if(this.multiple){ + this.clearItem(); + + var _this = this; + + Roo.each(this.tickItems, function(o){ + this.addItem(o); + }, this); + } + + this.hideTouchView(); + }, + + doTouchViewQuery : function() + { + var qe = { + query: '', + forceAll: true, + combo: this, + cancel:false + }; + + if(this.fireEvent('beforequery', qe) ===false || qe.cancel){ + return false; + } + + if(!this.alwaysQuery || this.mode == 'local'){ + this.onTouchViewLoad(); + return; + } + + this.store.load(); + }, + + onTouchViewBeforeLoad : function(combo,opts) + { + return; + }, + + // private + onTouchViewLoad : function() + { + if(this.store.getCount() < 1){ + this.onTouchViewEmptyResults(); + return; + } + + this.clearTouchView(); + + var rawValue = this.getRawValue(); + + var template = (this.multiple) ? Roo.bootstrap.ComboBox.listItemCheckbox : Roo.bootstrap.ComboBox.listItemRadio; + + this.tickItems = []; + + this.store.data.each(function(d, rowIndex){ + var row = this.touchViewListGroup.createChild(template); + + if(typeof(d.data.cls) != 'undefined' && d.data.cls.length){ + row.addClass(d.data.cls); + } + + if(this.displayField && typeof(d.data[this.displayField]) != 'undefined'){ + var cfg = { + data : d.data, + html : d.data[this.displayField] + }; + + if(this.fireEvent('touchviewdisplay', this, cfg) !== false){ + row.select('.roo-combobox-list-group-item-value', true).first().dom.innerHTML = cfg.html; + } + } + row.removeClass('selected'); + if(!this.multiple && this.valueField && + typeof(d.data[this.valueField]) != 'undefined' && d.data[this.valueField] == this.getValue()) + { + // radio buttons.. + row.select('.roo-combobox-list-group-item-box > input', true).first().attr('checked', true); + row.addClass('selected'); + } + + if(this.multiple && this.valueField && + typeof(d.data[this.valueField]) != 'undefined' && this.getValue().indexOf(d.data[this.valueField]) != -1) + { + + // checkboxes... + row.select('.roo-combobox-list-group-item-box > input', true).first().attr('checked', true); + this.tickItems.push(d.data); + } + + row.on('click', this.onTouchViewClick, this, {row : row, rowIndex : rowIndex}); + + }, this); + + var firstChecked = this.touchViewListGroup.select('.list-group-item > .roo-combobox-list-group-item-box > input:checked', true).first(); + + var bodyHeight = Roo.lib.Dom.getViewHeight() - this.touchViewFooterEl.getHeight() + this.touchViewBodyEl.getPadding('tb'); + + if(this.modalTitle.length){ + bodyHeight = bodyHeight - this.touchViewHeaderEl.getHeight(); + } + + var listHeight = this.touchViewListGroup.getHeight() + this.touchViewBodyEl.getPadding('tb') * 2; + + if(this.mobile_restrict_height && listHeight < bodyHeight){ + this.touchViewBodyEl.setHeight(listHeight); + } + + var _this = this; + + if(firstChecked && listHeight > bodyHeight){ + (function() { firstChecked.findParent('li').scrollIntoView(_this.touchViewListGroup.dom); }).defer(500); + } + + }, + + onTouchViewLoadException : function() + { + this.hideTouchView(); + }, + + onTouchViewEmptyResults : function() + { + this.clearTouchView(); + + this.touchViewListGroup.createChild(Roo.bootstrap.ComboBox.emptyResult); + + this.touchViewListGroup.select('.roo-combobox-touch-view-empty-result', true).first().dom.innerHTML = this.emptyResultText; + + }, + + clearTouchView : function() + { + this.touchViewListGroup.dom.innerHTML = ''; + }, + + onTouchViewClick : function(e, el, o) + { + e.preventDefault(); + + var row = o.row; + var rowIndex = o.rowIndex; + + var r = this.store.getAt(rowIndex); + + if(this.fireEvent('beforeselect', this, r, rowIndex) !== false){ + + if(!this.multiple){ + Roo.each(this.touchViewListGroup.select('.list-group-item > .roo-combobox-list-group-item-box > input:checked', true).elements, function(c){ + c.dom.removeAttribute('checked'); + }, this); + + row.select('.roo-combobox-list-group-item-box > input', true).first().attr('checked', true); + + this.setFromData(r.data); + + var close = this.closeTriggerEl(); + + if(close){ + close.show(); + } + + this.hideTouchView(); + + this.fireEvent('select', this, r, rowIndex); + + return; + } + + if(this.valueField && typeof(r.data[this.valueField]) != 'undefined' && this.getValue().indexOf(r.data[this.valueField]) != -1){ + row.select('.roo-combobox-list-group-item-box > input', true).first().dom.removeAttribute('checked'); + this.tickItems.splice(this.tickItems.indexOf(r.data), 1); + return; + } + + row.select('.roo-combobox-list-group-item-box > input', true).first().attr('checked', true); + this.addItem(r.data); + this.tickItems.push(r.data); + } + }, + + getAutoCreateNativeIOS : function() + { + var cfg = { + cls: 'form-group' //input-group, + }; + + var combobox = { + tag: 'select', + cls : 'roo-ios-select' + }; + + if (this.name) { + combobox.name = this.name; + } + + if (this.disabled) { + combobox.disabled = true; + } + + var settings = this; + + ['xs','sm','md','lg'].map(function(size){ + if (settings[size]) { + cfg.cls += ' col-' + size + '-' + settings[size]; + } + }); + + cfg.cn = combobox; + + return cfg; + + }, + + initIOSView : function() + { + this.store.on('load', this.onIOSViewLoad, this); + + return; + }, + + onIOSViewLoad : function() + { + if(this.store.getCount() < 1){ + return; + } + + this.clearIOSView(); + + if(this.allowBlank) { + + var default_text = '-- SELECT --'; + + if(this.placeholder.length){ + default_text = this.placeholder; + } + + if(this.emptyTitle.length){ + default_text += ' - ' + this.emptyTitle + ' -'; + } + + var opt = this.inputEl().createChild({ + tag: 'option', + value : 0, + html : default_text + }); + + var o = {}; + o[this.valueField] = 0; + o[this.displayField] = default_text; + + this.ios_options.push({ + data : o, + el : opt + }); + + } + + this.store.data.each(function(d, rowIndex){ + + var html = ''; + + if(this.displayField && typeof(d.data[this.displayField]) != 'undefined'){ + html = d.data[this.displayField]; + } + + var value = ''; + + if(this.valueField && typeof(d.data[this.valueField]) != 'undefined'){ + value = d.data[this.valueField]; + } + + var option = { + tag: 'option', + value : value, + html : html + }; + + if(this.value == d.data[this.valueField]){ + option['selected'] = true; + } + + var opt = this.inputEl().createChild(option); + + this.ios_options.push({ + data : d.data, + el : opt + }); + + }, this); + + this.inputEl().on('change', function(){ + this.fireEvent('select', this); + }, this); + + }, + + clearIOSView: function() + { + this.inputEl().dom.innerHTML = ''; + + this.ios_options = []; + }, + + setIOSValue: function(v) + { + this.value = v; + + if(!this.ios_options){ + return; + } + + Roo.each(this.ios_options, function(opts){ + + opts.el.dom.removeAttribute('selected'); + + if(opts.data[this.valueField] != v){ + return; + } + + opts.el.dom.setAttribute('selected', true); + + }, this); + } + + /** + * @cfg {Boolean} grow + * @hide + */ + /** + * @cfg {Number} growMin + * @hide + */ + /** + * @cfg {Number} growMax + * @hide + */ + /** + * @hide + * @method autoSize + */ +}); + +Roo.apply(Roo.bootstrap.ComboBox, { + + header : { + tag: 'div', + cls: 'modal-header', + cn: [ + { + tag: 'h4', + cls: 'modal-title' + } + ] + }, + + body : { + tag: 'div', + cls: 'modal-body', + cn: [ + { + tag: 'ul', + cls: 'list-group' + } + ] + }, + + listItemRadio : { + tag: 'li', + cls: 'list-group-item', + cn: [ + { + tag: 'span', + cls: 'roo-combobox-list-group-item-value' + }, + { + tag: 'div', + cls: 'roo-combobox-list-group-item-box pull-xs-right radio-inline radio radio-info', + cn: [ + { + tag: 'input', + type: 'radio' + }, + { + tag: 'label' + } + ] + } + ] + }, + + listItemCheckbox : { + tag: 'li', + cls: 'list-group-item', + cn: [ + { + tag: 'span', + cls: 'roo-combobox-list-group-item-value' + }, + { + tag: 'div', + cls: 'roo-combobox-list-group-item-box pull-xs-right checkbox-inline checkbox checkbox-info', + cn: [ + { + tag: 'input', + type: 'checkbox' + }, + { + tag: 'label' + } + ] + } + ] + }, + + emptyResult : { + tag: 'div', + cls: 'alert alert-danger roo-combobox-touch-view-empty-result' + }, + + footer : { + tag: 'div', + cls: 'modal-footer', + cn: [ + { + tag: 'div', + cls: 'row', + cn: [ + { + tag: 'div', + cls: 'col-xs-6 text-left', + cn: { + tag: 'button', + cls: 'btn btn-danger roo-touch-view-cancel', + html: 'Cancel' + } + }, + { + tag: 'div', + cls: 'col-xs-6 text-right', + cn: { + tag: 'button', + cls: 'btn btn-success roo-touch-view-ok', + html: 'OK' + } + } + ] + } + ] + + } +}); + +Roo.apply(Roo.bootstrap.ComboBox, { + + touchViewTemplate : { + tag: 'div', + cls: 'modal fade roo-combobox-touch-view', + cn: [ + { + tag: 'div', + cls: 'modal-dialog', + style : 'position:fixed', // we have to fix position.... + cn: [ + { + tag: 'div', + cls: 'modal-content', + cn: [ + Roo.bootstrap.ComboBox.header, + Roo.bootstrap.ComboBox.body, + Roo.bootstrap.ComboBox.footer + ] + } + ] + } + ] + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Component.js.html b/docs2/src/Roo_bootstrap_Component.js.html new file mode 100644 index 0000000000..ec616f8d85 --- /dev/null +++ b/docs2/src/Roo_bootstrap_Component.js.html @@ -0,0 +1,424 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Component.js/* + * - LGPL + * + * base class for bootstrap elements. + * + */ + +Roo.bootstrap = Roo.bootstrap || {}; +/** + * @class Roo.bootstrap.Component + * @extends Roo.Component + * Bootstrap Component base class + * @cfg {String} cls css class + * @cfg {String} style any extra css + * @cfg {Object} xattr extra attributes to add to 'element' (used by builder to store stuff.) + * @cfg {Boolean} can_build_overlaid True if element can be rebuild from a HTML page + * @cfg {string} dataId cutomer id + * @cfg {string} name Specifies name attribute + * @cfg {string} tooltip Text for the tooltip + * @cfg {string} container_method method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer) + * @cfg {string|object} visibilityEl (el|parent) What element to use for visibility (@see getVisibilityEl()) + + * @constructor + * Do not use directly - it does not do anything.. + * @param {Object} config The config object + */ + + + +Roo.bootstrap.Component = function(config){ + Roo.bootstrap.Component.superclass.constructor.call(this, config); + + this.addEvents({ + /** + * @event childrenrendered + * Fires when the children have been rendered.. + * @param {Roo.bootstrap.Component} this + */ + "childrenrendered" : true + + + + }); + + +}; + +Roo.extend(Roo.bootstrap.Component, Roo.BoxComponent, { + + + allowDomMove : false, // to stop relocations in parent onRender... + + cls : false, + + style : false, + + autoCreate : false, + + tooltip : null, + /** + * Initialize Events for the element + */ + initEvents : function() { }, + + xattr : false, + + parentId : false, + + can_build_overlaid : true, + + container_method : false, + + dataId : false, + + name : false, + + parent: function() { + // returns the parent component.. + return Roo.ComponentMgr.get(this.parentId) + + + }, + + // private + onRender : function(ct, position) + { + // Roo.log("Call onRender: " + this.xtype); + + Roo.bootstrap.Component.superclass.onRender.call(this, ct, position); + + if(this.el){ + if (this.el.attr('xtype')) { + this.el.attr('xtypex', this.el.attr('xtype')); + this.el.dom.removeAttribute('xtype'); + + this.initEvents(); + } + + return; + } + + + + var cfg = Roo.apply({}, this.getAutoCreate()); + + cfg.id = this.id || Roo.id(); + + // fill in the extra attributes + if (this.xattr && typeof(this.xattr) =='object') { + for (var i in this.xattr) { + cfg[i] = this.xattr[i]; + } + } + + if(this.dataId){ + cfg.dataId = this.dataId; + } + + if (this.cls) { + cfg.cls = (typeof(cfg.cls) == 'undefined') ? this.cls : cfg.cls + ' ' + this.cls; + } + + if (this.style) { // fixme needs to support more complex style data. + cfg.style = this.style; + } + + if(this.name){ + cfg.name = this.name; + } + + this.el = ct.createChild(cfg, position); + + if (this.tooltip) { + this.tooltipEl().attr('tooltip', this.tooltip); + } + + if(this.tabIndex !== undefined){ + this.el.dom.setAttribute('tabIndex', this.tabIndex); + } + + this.initEvents(); + + }, + /** + * Fetch the element to add children to + * @return {Roo.Element} defaults to this.el + */ + getChildContainer : function() + { + return this.el; + }, + /** + * Fetch the element to display the tooltip on. + * @return {Roo.Element} defaults to this.el + */ + tooltipEl : function() + { + return this.el; + }, + + addxtype : function(tree,cntr) + { + var cn = this; + + cn = Roo.factory(tree); + //Roo.log(['addxtype', cn]); + + cn.parentType = this.xtype; //?? + cn.parentId = this.id; + + cntr = (typeof(cntr) == 'undefined' ) ? 'getChildContainer' : cntr; + if (typeof(cn.container_method) == 'string') { + cntr = cn.container_method; + } + + + var has_flexy_each = (typeof(tree['flexy:foreach']) != 'undefined'); + + var has_flexy_if = (typeof(tree['flexy:if']) != 'undefined'); + + var build_from_html = Roo.XComponent.build_from_html; + + var is_body = (tree.xtype == 'Body') ; + + var page_has_body = (Roo.get(document.body).attr('xtype') == 'Roo.bootstrap.Body'); + + var self_cntr_el = Roo.get(this[cntr](false)); + + // do not try and build conditional elements + if ((has_flexy_each || has_flexy_if || this.can_build_overlaid == false ) && build_from_html) { + return false; + } + + if (!has_flexy_each || !build_from_html || is_body || !page_has_body) { + if(!has_flexy_if || typeof(tree.name) == 'undefined' || !build_from_html || is_body || !page_has_body){ + return this.addxtypeChild(tree,cntr, is_body); + } + + var echild =self_cntr_el ? self_cntr_el.child('>*[name=' + tree.name + ']') : false; + + if(echild){ + return this.addxtypeChild(Roo.apply({}, tree),cntr); + } + + Roo.log('skipping render'); + return cn; + + } + + var ret = false; + if (!build_from_html) { + return false; + } + + // this i think handles overlaying multiple children of the same type + // with the sam eelement.. - which might be buggy.. + while (true) { + var echild =self_cntr_el ? self_cntr_el.child('>*[xtype]') : false; + + if (!echild) { + break; + } + + if (echild && echild.attr('xtype').split('.').pop() != cn.xtype) { + break; + } + + ret = this.addxtypeChild(Roo.apply({}, tree),cntr); + } + + return ret; + }, + + + addxtypeChild : function (tree, cntr, is_body) + { + Roo.debug && Roo.log('addxtypeChild:' + cntr); + var cn = this; + cntr = (typeof(cntr) == 'undefined' ) ? 'getChildContainer' : cntr; + + + var has_flexy = (typeof(tree['flexy:if']) != 'undefined') || + (typeof(tree['flexy:foreach']) != 'undefined'); + + + + skip_children = false; + // render the element if it's not BODY. + if (!is_body) { + + // if parent was disabled, then do not try and create the children.. + if(!this[cntr](true)){ + tree.items = []; + return tree; + } + + cn = Roo.factory(tree); + + cn.parentType = this.xtype; //?? + cn.parentId = this.id; + + var build_from_html = Roo.XComponent.build_from_html; + + + // does the container contain child eleemnts with 'xtype' attributes. + // that match this xtype.. + // note - when we render we create these as well.. + // so we should check to see if body has xtype set. + if (build_from_html && Roo.get(document.body).attr('xtype') == 'Roo.bootstrap.Body') { + + var self_cntr_el = Roo.get(this[cntr](false)); + var echild =self_cntr_el ? self_cntr_el.child('>*[xtype]') : false; + if (echild) { + //Roo.log(Roo.XComponent.build_from_html); + //Roo.log("got echild:"); + //Roo.log(echild); + } + // there is a scenario where some of the child elements are flexy:if (and all of the same type) + // and are not displayed -this causes this to use up the wrong element when matching. + // at present the only work around for this is to nest flexy:if elements in another element that is always rendered. + + + if (echild && echild.attr('xtype').split('.').pop() == cn.xtype) { + // Roo.log("found child for " + this.xtype +": " + echild.attr('xtype') ); + + + + cn.el = echild; + // Roo.log("GOT"); + //echild.dom.removeAttribute('xtype'); + } else { + Roo.debug && Roo.log("MISSING " + cn.xtype + " on child of " + (this.el ? this.el.attr('xbuilderid') : 'no parent')); + Roo.debug && Roo.log(self_cntr_el); + Roo.debug && Roo.log(echild); + Roo.debug && Roo.log(cn); + } + } + + + + // if object has flexy:if - then it may or may not be rendered. + if (build_from_html && has_flexy && !cn.el && cn.can_build_overlaid) { + // skip a flexy if element. + Roo.debug && Roo.log('skipping render'); + Roo.debug && Roo.log(tree); + if (!cn.el) { + Roo.debug && Roo.log('skipping all children'); + skip_children = true; + } + + } else { + + // actually if flexy:foreach is found, we really want to create + // multiple copies here... + //Roo.log('render'); + //Roo.log(this[cntr]()); + // some elements do not have render methods.. like the layouts... + /* + if(this[cntr](true) === false){ + cn.items = []; + return cn; + } + */ + cn.render && cn.render(this[cntr](true)); + + } + // then add the element.. + } + + // handle the kids.. + + var nitems = []; + /* + if (typeof (tree.menu) != 'undefined') { + tree.menu.parentType = cn.xtype; + tree.menu.triggerEl = cn.el; + nitems.push(cn.addxtype(Roo.apply({}, tree.menu))); + + } + */ + if (!tree.items || !tree.items.length) { + cn.items = nitems; + //Roo.log(["no children", this]); + + return cn; + } + + var items = tree.items; + delete tree.items; + + //Roo.log(items.length); + // add the items.. + if (!skip_children) { + for(var i =0;i < items.length;i++) { + // Roo.log(['add child', items[i]]); + nitems.push(cn.addxtype(Roo.apply({}, items[i]))); + } + } + + cn.items = nitems; + + //Roo.log("fire childrenrendered"); + + cn.fireEvent('childrenrendered', this); + + return cn; + }, + + /** + * Set the element that will be used to show or hide + */ + setVisibilityEl : function(el) + { + this.visibilityEl = el; + }, + + /** + * Get the element that will be used to show or hide + */ + getVisibilityEl : function() + { + if (typeof(this.visibilityEl) == 'object') { + return this.visibilityEl; + } + + if (typeof(this.visibilityEl) == 'string') { + return this.visibilityEl == 'parent' ? this.parent().getEl() : this.getEl(); + } + + return this.getEl(); + }, + + /** + * Show a component - removes 'hidden' class + */ + show : function() + { + if(!this.getVisibilityEl()){ + return; + } + + this.getVisibilityEl().removeClass(['hidden','d-none']); + + this.fireEvent('show', this); + + + }, + /** + * Hide a component - adds 'hidden' class + */ + hide: function() + { + if(!this.getVisibilityEl()){ + return; + } + + this.getVisibilityEl().addClass(['hidden','d-none']); + + this.fireEvent('hide', this); + + } +}); + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Container.js.html b/docs2/src/Roo_bootstrap_Container.js.html new file mode 100644 index 0000000000..4d4512141e --- /dev/null +++ b/docs2/src/Roo_bootstrap_Container.js.html @@ -0,0 +1,375 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Container.js/* + * - LGPL + * + * page container. + * + */ + + +/** + * @class Roo.bootstrap.Container + * @extends Roo.bootstrap.Component + * Bootstrap Container class + * @cfg {Boolean} jumbotron is it a jumbotron element + * @cfg {String} html content of element + * @cfg {String} well (lg|sm|md) a well, large, small or medium. + * @cfg {String} panel (default|primary|success|info|warning|danger) render as panel - type - primary/success..... + * @cfg {String} header content of header (for panel) + * @cfg {String} footer content of footer (for panel) + * @cfg {String} sticky (footer|wrap|push) block to use as footer or body- needs css-bootstrap/sticky-footer.css + * @cfg {String} tag (header|aside|section) type of HTML tag. + * @cfg {String} alert (success|info|warning|danger) type alert (changes background / border...) + * @cfg {String} fa font awesome icon + * @cfg {String} icon (info-sign|check|...) glyphicon name + * @cfg {Boolean} hidden (true|false) hide the element + * @cfg {Boolean} expandable (true|false) default false + * @cfg {Boolean} expanded (true|false) default true + * @cfg {String} rheader contet on the right of header + * @cfg {Boolean} clickable (true|false) default false + + * + * @constructor + * Create a new Container + * @param {Object} config The config object + */ + +Roo.bootstrap.Container = function(config){ + Roo.bootstrap.Container.superclass.constructor.call(this, config); + + this.addEvents({ + // raw events + /** + * @event expand + * After the panel has been expand + * + * @param {Roo.bootstrap.Container} this + */ + "expand" : true, + /** + * @event collapse + * After the panel has been collapsed + * + * @param {Roo.bootstrap.Container} this + */ + "collapse" : true, + /** + * @event click + * When a element is chick + * @param {Roo.bootstrap.Container} this + * @param {Roo.EventObject} e + */ + "click" : true + }); +}; + +Roo.extend(Roo.bootstrap.Container, Roo.bootstrap.Component, { + + jumbotron : false, + well: '', + panel : '', + header: '', + footer : '', + sticky: '', + tag : false, + alert : false, + fa: false, + icon : false, + expandable : false, + rheader : '', + expanded : true, + clickable: false, + + + getChildContainer : function() { + + if(!this.el){ + return false; + } + + if (this.panel.length) { + return this.el.select('.panel-body',true).first(); + } + + return this.el; + }, + + + getAutoCreate : function(){ + + var cfg = { + tag : this.tag || 'div', + html : '', + cls : '' + }; + if (this.jumbotron) { + cfg.cls = 'jumbotron'; + } + + + + // - this is applied by the parent.. + //if (this.cls) { + // cfg.cls = this.cls + ''; + //} + + if (this.sticky.length) { + + var bd = Roo.get(document.body); + if (!bd.hasClass('bootstrap-sticky')) { + bd.addClass('bootstrap-sticky'); + Roo.select('html',true).setStyle('height', '100%'); + } + + cfg.cls += 'bootstrap-sticky-' + this.sticky; + } + + + if (this.well.length) { + switch (this.well) { + case 'lg': + case 'sm': + cfg.cls +=' well well-' +this.well; + break; + default: + cfg.cls +=' well'; + break; + } + } + + if (this.hidden) { + cfg.cls += ' hidden'; + } + + + if (this.alert && ["success","info","warning", "danger"].indexOf(this.alert) > -1) { + cfg.cls +=' alert alert-' + this.alert; + } + + var body = cfg; + + if (this.panel.length) { + cfg.cls += ' panel panel-' + this.panel; + cfg.cn = []; + if (this.header.length) { + + var h = []; + + if(this.expandable){ + + cfg.cls = cfg.cls + ' expandable'; + + h.push({ + tag: 'i', + cls: (this.expanded ? 'fa fa-minus' : 'fa fa-plus') + }); + + } + + h.push( + { + tag: 'span', + cls : 'panel-title', + html : (this.expandable ? '&nbsp;' : '') + this.header + }, + { + tag: 'span', + cls: 'panel-header-right', + html: this.rheader + } + ); + + cfg.cn.push({ + cls : 'panel-heading', + style : this.expandable ? 'cursor: pointer' : '', + cn : h + }); + + } + + body = false; + cfg.cn.push({ + cls : 'panel-body' + (this.expanded ? '' : ' hide'), + html : this.html + }); + + + if (this.footer.length) { + cfg.cn.push({ + cls : 'panel-footer', + html : this.footer + + }); + } + + } + + if (body) { + body.html = this.html || cfg.html; + // prefix with the icons.. + if (this.fa) { + body.html = '<i class="fa fa-'+this.fa + '"></i>' + body.html ; + } + if (this.icon) { + body.html = '<i class="glyphicon glyphicon-'+this.icon + '"></i>' + body.html ; + } + + + } + if ((!this.cls || !this.cls.length) && (!cfg.cls || !cfg.cls.length)) { + cfg.cls = 'container'; + } + + return cfg; + }, + + initEvents: function() + { + if(this.expandable){ + var headerEl = this.headerEl(); + + if(headerEl){ + headerEl.on('click', this.onToggleClick, this); + } + } + + if(this.clickable){ + this.el.on('click', this.onClick, this); + } + + }, + + onToggleClick : function() + { + var headerEl = this.headerEl(); + + if(!headerEl){ + return; + } + + if(this.expanded){ + this.collapse(); + return; + } + + this.expand(); + }, + + expand : function() + { + if(this.fireEvent('expand', this)) { + + this.expanded = true; + + //this.el.select('.panel-body',true).first().setVisibilityMode(Roo.Element.DISPLAY).show(); + + this.el.select('.panel-body',true).first().removeClass('hide'); + + var toggleEl = this.toggleEl(); + + if(!toggleEl){ + return; + } + + toggleEl.removeClass(['fa-minus', 'fa-plus']).addClass(['fa-minus']); + } + + }, + + collapse : function() + { + if(this.fireEvent('collapse', this)) { + + this.expanded = false; + + //this.el.select('.panel-body',true).first().setVisibilityMode(Roo.Element.DISPLAY).hide(); + this.el.select('.panel-body',true).first().addClass('hide'); + + var toggleEl = this.toggleEl(); + + if(!toggleEl){ + return; + } + + toggleEl.removeClass(['fa-minus', 'fa-plus']).addClass(['fa-plus']); + } + }, + + toggleEl : function() + { + if(!this.el || !this.panel.length || !this.header.length || !this.expandable){ + return; + } + + return this.el.select('.panel-heading .fa',true).first(); + }, + + headerEl : function() + { + if(!this.el || !this.panel.length || !this.header.length){ + return; + } + + return this.el.select('.panel-heading',true).first() + }, + + bodyEl : function() + { + if(!this.el || !this.panel.length){ + return; + } + + return this.el.select('.panel-body',true).first() + }, + + titleEl : function() + { + if(!this.el || !this.panel.length || !this.header.length){ + return; + } + + return this.el.select('.panel-title',true).first(); + }, + + setTitle : function(v) + { + var titleEl = this.titleEl(); + + if(!titleEl){ + return; + } + + titleEl.dom.innerHTML = v; + }, + + getTitle : function() + { + + var titleEl = this.titleEl(); + + if(!titleEl){ + return ''; + } + + return titleEl.dom.innerHTML; + }, + + setRightTitle : function(v) + { + var t = this.el.select('.panel-header-right',true).first(); + + if(!t){ + return; + } + + t.dom.innerHTML = v; + }, + + onClick : function(e) + { + e.preventDefault(); + + this.fireEvent('click', this, e); + } +}); + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_DateField.js.html b/docs2/src/Roo_bootstrap_DateField.js.html new file mode 100644 index 0000000000..c18b4d4f14 --- /dev/null +++ b/docs2/src/Roo_bootstrap_DateField.js.html @@ -0,0 +1,1141 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/DateField.js/* + * - LGPL + * + * DateField + * + */ + +/** + * @class Roo.bootstrap.DateField + * @extends Roo.bootstrap.Input + * Bootstrap DateField class + * @cfg {Number} weekStart default 0 + * @cfg {String} viewMode default empty, (months|years) + * @cfg {String} minViewMode default empty, (months|years) + * @cfg {Number} startDate default -Infinity + * @cfg {Number} endDate default Infinity + * @cfg {Boolean} todayHighlight default false + * @cfg {Boolean} todayBtn default false + * @cfg {Boolean} calendarWeeks default false + * @cfg {Object} daysOfWeekDisabled default empty + * @cfg {Boolean} singleMode default false (true | false) + * + * @cfg {Boolean} keyboardNavigation default true + * @cfg {String} language default en + * + * @constructor + * Create a new DateField + * @param {Object} config The config object + */ + +Roo.bootstrap.DateField = function(config){ + Roo.bootstrap.DateField.superclass.constructor.call(this, config); + this.addEvents({ + /** + * @event show + * Fires when this field show. + * @param {Roo.bootstrap.DateField} this + * @param {Mixed} date The date value + */ + show : true, + /** + * @event show + * Fires when this field hide. + * @param {Roo.bootstrap.DateField} this + * @param {Mixed} date The date value + */ + hide : true, + /** + * @event select + * Fires when select a date. + * @param {Roo.bootstrap.DateField} this + * @param {Mixed} date The date value + */ + select : true, + /** + * @event beforeselect + * Fires when before select a date. + * @param {Roo.bootstrap.DateField} this + * @param {Mixed} date The date value + */ + beforeselect : true + }); +}; + +Roo.extend(Roo.bootstrap.DateField, Roo.bootstrap.Input, { + + /** + * @cfg {String} format + * The default date format string which can be overriden for localization support. The format must be + * valid according to {@link Date#parseDate} (defaults to 'm/d/y'). + */ + format : "m/d/y", + /** + * @cfg {String} altFormats + * Multiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined + * format (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d'). + */ + altFormats : "m/d/Y|m-d-y|m-d-Y|m/d|m-d|md|mdy|mdY|d", + + weekStart : 0, + + viewMode : '', + + minViewMode : '', + + todayHighlight : false, + + todayBtn: false, + + language: 'en', + + keyboardNavigation: true, + + calendarWeeks: false, + + startDate: -Infinity, + + endDate: Infinity, + + daysOfWeekDisabled: [], + + _events: [], + + singleMode : false, + + UTCDate: function() + { + return new Date(Date.UTC.apply(Date, arguments)); + }, + + UTCToday: function() + { + var today = new Date(); + return this.UTCDate(today.getUTCFullYear(), today.getUTCMonth(), today.getUTCDate()); + }, + + getDate: function() { + var d = this.getUTCDate(); + return new Date(d.getTime() + (d.getTimezoneOffset()*60000)); + }, + + getUTCDate: function() { + return this.date; + }, + + setDate: function(d) { + this.setUTCDate(new Date(d.getTime() - (d.getTimezoneOffset()*60000))); + }, + + setUTCDate: function(d) { + this.date = d; + this.setValue(this.formatDate(this.date)); + }, + + onRender: function(ct, position) + { + + Roo.bootstrap.DateField.superclass.onRender.call(this, ct, position); + + this.language = this.language || 'en'; + this.language = this.language in Roo.bootstrap.DateField.dates ? this.language : this.language.split('-')[0]; + this.language = this.language in Roo.bootstrap.DateField.dates ? this.language : "en"; + + this.isRTL = Roo.bootstrap.DateField.dates[this.language].rtl || false; + this.format = this.format || 'm/d/y'; + this.isInline = false; + this.isInput = true; + this.component = this.el.select('.add-on', true).first() || false; + this.component = (this.component && this.component.length === 0) ? false : this.component; + this.hasInput = this.component && this.inputEl().length; + + if (typeof(this.minViewMode === 'string')) { + switch (this.minViewMode) { + case 'months': + this.minViewMode = 1; + break; + case 'years': + this.minViewMode = 2; + break; + default: + this.minViewMode = 0; + break; + } + } + + if (typeof(this.viewMode === 'string')) { + switch (this.viewMode) { + case 'months': + this.viewMode = 1; + break; + case 'years': + this.viewMode = 2; + break; + default: + this.viewMode = 0; + break; + } + } + + this.pickerEl = Roo.get(document.body).createChild(Roo.bootstrap.DateField.template); + +// this.el.select('>.input-group', true).first().createChild(Roo.bootstrap.DateField.template); + + this.picker().setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + + this.picker().on('mousedown', this.onMousedown, this); + this.picker().on('click', this.onClick, this); + + this.picker().addClass('datepicker-dropdown'); + + this.startViewMode = this.viewMode; + + if(this.singleMode){ + Roo.each(this.picker().select('thead > tr > th', true).elements, function(v){ + v.setVisibilityMode(Roo.Element.DISPLAY); + v.hide(); + }); + + Roo.each(this.picker().select('tbody > tr > td', true).elements, function(v){ + v.setStyle('width', '189px'); + }); + } + + Roo.each(this.picker().select('tfoot th.today', true).elements, function(v){ + if(!this.calendarWeeks){ + v.remove(); + return; + } + + v.dom.innerHTML = Roo.bootstrap.DateField.dates[this.language].today; + v.attr('colspan', function(i, val){ + return parseInt(val) + 1; + }); + }); + + + this.weekEnd = this.weekStart === 0 ? 6 : this.weekStart - 1; + + this.setStartDate(this.startDate); + this.setEndDate(this.endDate); + + this.setDaysOfWeekDisabled(this.daysOfWeekDisabled); + + this.fillDow(); + this.fillMonths(); + this.update(); + this.showMode(); + + if(this.isInline) { + this.showPopup(); + } + }, + + picker : function() + { + return this.pickerEl; +// return this.el.select('.datepicker', true).first(); + }, + + fillDow: function() + { + var dowCnt = this.weekStart; + + var dow = { + tag: 'tr', + cn: [ + + ] + }; + + if(this.calendarWeeks){ + dow.cn.push({ + tag: 'th', + cls: 'cw', + html: '&nbsp;' + }) + } + + while (dowCnt < this.weekStart + 7) { + dow.cn.push({ + tag: 'th', + cls: 'dow', + html: Roo.bootstrap.DateField.dates[this.language].daysMin[(dowCnt++)%7] + }); + } + + this.picker().select('>.datepicker-days thead', true).first().createChild(dow); + }, + + fillMonths: function() + { + var i = 0; + var months = this.picker().select('>.datepicker-months td', true).first(); + + months.dom.innerHTML = ''; + + while (i < 12) { + var month = { + tag: 'span', + cls: 'month', + html: Roo.bootstrap.DateField.dates[this.language].monthsShort[i++] + }; + + months.createChild(month); + } + + }, + + update: function() + { + this.date = (typeof(this.date) === 'undefined' || ((typeof(this.date) === 'string') && !this.date.length)) ? this.UTCToday() : (typeof(this.date) === 'string') ? this.parseDate(this.date) : this.date; + + if (this.date < this.startDate) { + this.viewDate = new Date(this.startDate); + } else if (this.date > this.endDate) { + this.viewDate = new Date(this.endDate); + } else { + this.viewDate = new Date(this.date); + } + + this.fill(); + }, + + fill: function() + { + var d = new Date(this.viewDate), + year = d.getUTCFullYear(), + month = d.getUTCMonth(), + startYear = this.startDate !== -Infinity ? this.startDate.getUTCFullYear() : -Infinity, + startMonth = this.startDate !== -Infinity ? this.startDate.getUTCMonth() : -Infinity, + endYear = this.endDate !== Infinity ? this.endDate.getUTCFullYear() : Infinity, + endMonth = this.endDate !== Infinity ? this.endDate.getUTCMonth() : Infinity, + currentDate = this.date && this.date.valueOf(), + today = this.UTCToday(); + + this.picker().select('>.datepicker-days thead th.switch', true).first().dom.innerHTML = Roo.bootstrap.DateField.dates[this.language].months[month]+' '+year; + +// this.picker().select('>tfoot th.today', true).first().dom.innerHTML = Roo.bootstrap.DateField.dates[this.language].today; + +// this.picker.select('>tfoot th.today'). +// .text(dates[this.language].today) +// .toggle(this.todayBtn !== false); + + this.updateNavArrows(); + this.fillMonths(); + + var prevMonth = this.UTCDate(year, month-1, 28,0,0,0,0), + + day = prevMonth.getDaysInMonth(prevMonth.getUTCFullYear(), prevMonth.getUTCMonth()); + + prevMonth.setUTCDate(day); + + prevMonth.setUTCDate(day - (prevMonth.getUTCDay() - this.weekStart + 7)%7); + + var nextMonth = new Date(prevMonth); + + nextMonth.setUTCDate(nextMonth.getUTCDate() + 42); + + nextMonth = nextMonth.valueOf(); + + var fillMonths = false; + + this.picker().select('>.datepicker-days tbody',true).first().dom.innerHTML = ''; + + while(prevMonth.valueOf() <= nextMonth) { + var clsName = ''; + + if (prevMonth.getUTCDay() === this.weekStart) { + if(fillMonths){ + this.picker().select('>.datepicker-days tbody',true).first().createChild(fillMonths); + } + + fillMonths = { + tag: 'tr', + cn: [] + }; + + if(this.calendarWeeks){ + // ISO 8601: First week contains first thursday. + // ISO also states week starts on Monday, but we can be more abstract here. + var + // Start of current week: based on weekstart/current date + ws = new Date(+prevMonth + (this.weekStart - prevMonth.getUTCDay() - 7) % 7 * 864e5), + // Thursday of this week + th = new Date(+ws + (7 + 4 - ws.getUTCDay()) % 7 * 864e5), + // First Thursday of year, year from thursday + yth = new Date(+(yth = this.UTCDate(th.getUTCFullYear(), 0, 1)) + (7 + 4 - yth.getUTCDay())%7*864e5), + // Calendar week: ms between thursdays, div ms per day, div 7 days + calWeek = (th - yth) / 864e5 / 7 + 1; + + fillMonths.cn.push({ + tag: 'td', + cls: 'cw', + html: calWeek + }); + } + } + + if (prevMonth.getUTCFullYear() < year || (prevMonth.getUTCFullYear() == year && prevMonth.getUTCMonth() < month)) { + clsName += ' old'; + } else if (prevMonth.getUTCFullYear() > year || (prevMonth.getUTCFullYear() == year && prevMonth.getUTCMonth() > month)) { + clsName += ' new'; + } + if (this.todayHighlight && + prevMonth.getUTCFullYear() == today.getFullYear() && + prevMonth.getUTCMonth() == today.getMonth() && + prevMonth.getUTCDate() == today.getDate()) { + clsName += ' today'; + } + + if (currentDate && prevMonth.valueOf() === currentDate) { + clsName += ' active'; + } + + if (prevMonth.valueOf() < this.startDate || prevMonth.valueOf() > this.endDate || + this.daysOfWeekDisabled.indexOf(prevMonth.getUTCDay()) !== -1) { + clsName += ' disabled'; + } + + fillMonths.cn.push({ + tag: 'td', + cls: 'day ' + clsName, + html: prevMonth.getDate() + }); + + prevMonth.setDate(prevMonth.getDate()+1); + } + + var currentYear = this.date && this.date.getUTCFullYear(); + var currentMonth = this.date && this.date.getUTCMonth(); + + this.picker().select('>.datepicker-months th.switch',true).first().dom.innerHTML = year; + + Roo.each(this.picker().select('>.datepicker-months tbody span',true).elements, function(v,k){ + v.removeClass('active'); + + if(currentYear === year && k === currentMonth){ + v.addClass('active'); + } + + if (year < startYear || year > endYear || (year == startYear && k < startMonth) || (year == endYear && k > endMonth)) { + v.addClass('disabled'); + } + + }); + + + year = parseInt(year/10, 10) * 10; + + this.picker().select('>.datepicker-years th.switch', true).first().dom.innerHTML = year + '-' + (year + 9); + + this.picker().select('>.datepicker-years tbody td',true).first().dom.innerHTML = ''; + + year -= 1; + for (var i = -1; i < 11; i++) { + this.picker().select('>.datepicker-years tbody td',true).first().createChild({ + tag: 'span', + cls: 'year' + (i === -1 || i === 10 ? ' old' : '') + (currentYear === year ? ' active' : '') + (year < startYear || year > endYear ? ' disabled' : ''), + html: year + }); + + year += 1; + } + }, + + showMode: function(dir) + { + if (dir) { + this.viewMode = Math.max(this.minViewMode, Math.min(2, this.viewMode + dir)); + } + + Roo.each(this.picker().select('>div',true).elements, function(v){ + v.setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + v.hide(); + }); + this.picker().select('>.datepicker-'+Roo.bootstrap.DateField.modes[this.viewMode].clsName, true).first().show(); + }, + + place: function() + { + if(this.isInline) { + return; + } + + this.picker().removeClass(['bottom', 'top']); + + if((Roo.lib.Dom.getViewHeight() + Roo.get(document.body).getScroll().top) - (this.inputEl().getBottom() + this.picker().getHeight()) < 0){ + /* + * place to the top of element! + * + */ + + this.picker().addClass('top'); + this.picker().setTop(this.inputEl().getTop() - this.picker().getHeight()).setLeft(this.inputEl().getLeft()); + + return; + } + + this.picker().addClass('bottom'); + + this.picker().setTop(this.inputEl().getBottom()).setLeft(this.inputEl().getLeft()); + }, + + parseDate : function(value) + { + if(!value || value instanceof Date){ + return value; + } + var v = Date.parseDate(value, this.format); + if (!v && (this.useIso || value.match(/^(\d{4})-0?(\d+)-0?(\d+)/))) { + v = Date.parseDate(value, 'Y-m-d'); + } + if(!v && this.altFormats){ + if(!this.altFormatsArray){ + this.altFormatsArray = this.altFormats.split("|"); + } + for(var i = 0, len = this.altFormatsArray.length; i < len && !v; i++){ + v = Date.parseDate(value, this.altFormatsArray[i]); + } + } + return v; + }, + + formatDate : function(date, fmt) + { + return (!date || !(date instanceof Date)) ? + date : date.dateFormat(fmt || this.format); + }, + + onFocus : function() + { + Roo.bootstrap.DateField.superclass.onFocus.call(this); + this.showPopup(); + }, + + onBlur : function() + { + Roo.bootstrap.DateField.superclass.onBlur.call(this); + + var d = this.inputEl().getValue(); + + this.setValue(d); + + this.hidePopup(); + }, + + showPopup : function() + { + this.picker().show(); + this.update(); + this.place(); + + this.fireEvent('showpopup', this, this.date); + }, + + hidePopup : function() + { + if(this.isInline) { + return; + } + this.picker().hide(); + this.viewMode = this.startViewMode; + this.showMode(); + + this.fireEvent('hidepopup', this, this.date); + + }, + + onMousedown: function(e) + { + e.stopPropagation(); + e.preventDefault(); + }, + + keyup: function(e) + { + Roo.bootstrap.DateField.superclass.keyup.call(this); + this.update(); + }, + + setValue: function(v) + { + if(this.fireEvent('beforeselect', this, v) !== false){ + var d = new Date(this.parseDate(v) ).clearTime(); + + if(isNaN(d.getTime())){ + this.date = this.viewDate = ''; + Roo.bootstrap.DateField.superclass.setValue.call(this, ''); + return; + } + + v = this.formatDate(d); + + Roo.bootstrap.DateField.superclass.setValue.call(this, v); + + this.date = new Date(d.getTime() - d.getTimezoneOffset()*60000); + + this.update(); + + this.fireEvent('select', this, this.date); + } + }, + + getValue: function() + { + return this.formatDate(this.date); + }, + + fireKey: function(e) + { + if (!this.picker().isVisible()){ + if (e.keyCode == 27) { // allow escape to hide and re-show picker + this.showPopup(); + } + return; + } + + var dateChanged = false, + dir, day, month, + newDate, newViewDate; + + switch(e.keyCode){ + case 27: // escape + this.hidePopup(); + e.preventDefault(); + break; + case 37: // left + case 39: // right + if (!this.keyboardNavigation) { + break; + } + dir = e.keyCode == 37 ? -1 : 1; + + if (e.ctrlKey){ + newDate = this.moveYear(this.date, dir); + newViewDate = this.moveYear(this.viewDate, dir); + } else if (e.shiftKey){ + newDate = this.moveMonth(this.date, dir); + newViewDate = this.moveMonth(this.viewDate, dir); + } else { + newDate = new Date(this.date); + newDate.setUTCDate(this.date.getUTCDate() + dir); + newViewDate = new Date(this.viewDate); + newViewDate.setUTCDate(this.viewDate.getUTCDate() + dir); + } + if (this.dateWithinRange(newDate)){ + this.date = newDate; + this.viewDate = newViewDate; + this.setValue(this.formatDate(this.date)); +// this.update(); + e.preventDefault(); + dateChanged = true; + } + break; + case 38: // up + case 40: // down + if (!this.keyboardNavigation) { + break; + } + dir = e.keyCode == 38 ? -1 : 1; + if (e.ctrlKey){ + newDate = this.moveYear(this.date, dir); + newViewDate = this.moveYear(this.viewDate, dir); + } else if (e.shiftKey){ + newDate = this.moveMonth(this.date, dir); + newViewDate = this.moveMonth(this.viewDate, dir); + } else { + newDate = new Date(this.date); + newDate.setUTCDate(this.date.getUTCDate() + dir * 7); + newViewDate = new Date(this.viewDate); + newViewDate.setUTCDate(this.viewDate.getUTCDate() + dir * 7); + } + if (this.dateWithinRange(newDate)){ + this.date = newDate; + this.viewDate = newViewDate; + this.setValue(this.formatDate(this.date)); +// this.update(); + e.preventDefault(); + dateChanged = true; + } + break; + case 13: // enter + this.setValue(this.formatDate(this.date)); + this.hidePopup(); + e.preventDefault(); + break; + case 9: // tab + this.setValue(this.formatDate(this.date)); + this.hidePopup(); + break; + case 16: // shift + case 17: // ctrl + case 18: // alt + break; + default : + this.hidePopup(); + + } + }, + + + onClick: function(e) + { + e.stopPropagation(); + e.preventDefault(); + + var target = e.getTarget(); + + if(target.nodeName.toLowerCase() === 'i'){ + target = Roo.get(target).dom.parentNode; + } + + var nodeName = target.nodeName; + var className = target.className; + var html = target.innerHTML; + //Roo.log(nodeName); + + switch(nodeName.toLowerCase()) { + case 'th': + switch(className) { + case 'switch': + this.showMode(1); + break; + case 'prev': + case 'next': + var dir = Roo.bootstrap.DateField.modes[this.viewMode].navStep * (className == 'prev' ? -1 : 1); + switch(this.viewMode){ + case 0: + this.viewDate = this.moveMonth(this.viewDate, dir); + break; + case 1: + case 2: + this.viewDate = this.moveYear(this.viewDate, dir); + break; + } + this.fill(); + break; + case 'today': + var date = new Date(); + this.date = this.UTCDate(date.getFullYear(), date.getMonth(), date.getDate(), 0, 0, 0); +// this.fill() + this.setValue(this.formatDate(this.date)); + + this.hidePopup(); + break; + } + break; + case 'span': + if (className.indexOf('disabled') < 0) { + this.viewDate.setUTCDate(1); + if (className.indexOf('month') > -1) { + this.viewDate.setUTCMonth(Roo.bootstrap.DateField.dates[this.language].monthsShort.indexOf(html)); + } else { + var year = parseInt(html, 10) || 0; + this.viewDate.setUTCFullYear(year); + + } + + if(this.singleMode){ + this.setValue(this.formatDate(this.viewDate)); + this.hidePopup(); + return; + } + + this.showMode(-1); + this.fill(); + } + break; + + case 'td': + //Roo.log(className); + if (className.indexOf('day') > -1 && className.indexOf('disabled') < 0 ){ + var day = parseInt(html, 10) || 1; + var year = this.viewDate.getUTCFullYear(), + month = this.viewDate.getUTCMonth(); + + if (className.indexOf('old') > -1) { + if(month === 0 ){ + month = 11; + year -= 1; + }else{ + month -= 1; + } + } else if (className.indexOf('new') > -1) { + if (month == 11) { + month = 0; + year += 1; + } else { + month += 1; + } + } + //Roo.log([year,month,day]); + this.date = this.UTCDate(year, month, day,0,0,0,0); + this.viewDate = this.UTCDate(year, month, Math.min(28, day),0,0,0,0); +// this.fill(); + //Roo.log(this.formatDate(this.date)); + this.setValue(this.formatDate(this.date)); + this.hidePopup(); + } + break; + } + }, + + setStartDate: function(startDate) + { + this.startDate = startDate || -Infinity; + if (this.startDate !== -Infinity) { + this.startDate = this.parseDate(this.startDate); + } + this.update(); + this.updateNavArrows(); + }, + + setEndDate: function(endDate) + { + this.endDate = endDate || Infinity; + if (this.endDate !== Infinity) { + this.endDate = this.parseDate(this.endDate); + } + this.update(); + this.updateNavArrows(); + }, + + setDaysOfWeekDisabled: function(daysOfWeekDisabled) + { + this.daysOfWeekDisabled = daysOfWeekDisabled || []; + if (typeof(this.daysOfWeekDisabled) !== 'object') { + this.daysOfWeekDisabled = this.daysOfWeekDisabled.split(/,\s*/); + } + this.daysOfWeekDisabled = this.daysOfWeekDisabled.map(function (d) { + return parseInt(d, 10); + }); + this.update(); + this.updateNavArrows(); + }, + + updateNavArrows: function() + { + if(this.singleMode){ + return; + } + + var d = new Date(this.viewDate), + year = d.getUTCFullYear(), + month = d.getUTCMonth(); + + Roo.each(this.picker().select('.prev', true).elements, function(v){ + v.show(); + switch (this.viewMode) { + case 0: + + if (this.startDate !== -Infinity && year <= this.startDate.getUTCFullYear() && month <= this.startDate.getUTCMonth()) { + v.hide(); + } + break; + case 1: + case 2: + if (this.startDate !== -Infinity && year <= this.startDate.getUTCFullYear()) { + v.hide(); + } + break; + } + }); + + Roo.each(this.picker().select('.next', true).elements, function(v){ + v.show(); + switch (this.viewMode) { + case 0: + + if (this.endDate !== Infinity && year >= this.endDate.getUTCFullYear() && month >= this.endDate.getUTCMonth()) { + v.hide(); + } + break; + case 1: + case 2: + if (this.endDate !== Infinity && year >= this.endDate.getUTCFullYear()) { + v.hide(); + } + break; + } + }) + }, + + moveMonth: function(date, dir) + { + if (!dir) { + return date; + } + var new_date = new Date(date.valueOf()), + day = new_date.getUTCDate(), + month = new_date.getUTCMonth(), + mag = Math.abs(dir), + new_month, test; + dir = dir > 0 ? 1 : -1; + if (mag == 1){ + test = dir == -1 + // If going back one month, make sure month is not current month + // (eg, Mar 31 -> Feb 31 == Feb 28, not Mar 02) + ? function(){ + return new_date.getUTCMonth() == month; + } + // If going forward one month, make sure month is as expected + // (eg, Jan 31 -> Feb 31 == Feb 28, not Mar 02) + : function(){ + return new_date.getUTCMonth() != new_month; + }; + new_month = month + dir; + new_date.setUTCMonth(new_month); + // Dec -> Jan (12) or Jan -> Dec (-1) -- limit expected date to 0-11 + if (new_month < 0 || new_month > 11) { + new_month = (new_month + 12) % 12; + } + } else { + // For magnitudes >1, move one month at a time... + for (var i=0; i<mag; i++) { + // ...which might decrease the day (eg, Jan 31 to Feb 28, etc)... + new_date = this.moveMonth(new_date, dir); + } + // ...then reset the day, keeping it in the new month + new_month = new_date.getUTCMonth(); + new_date.setUTCDate(day); + test = function(){ + return new_month != new_date.getUTCMonth(); + }; + } + // Common date-resetting loop -- if date is beyond end of month, make it + // end of month + while (test()){ + new_date.setUTCDate(--day); + new_date.setUTCMonth(new_month); + } + return new_date; + }, + + moveYear: function(date, dir) + { + return this.moveMonth(date, dir*12); + }, + + dateWithinRange: function(date) + { + return date >= this.startDate && date <= this.endDate; + }, + + + remove: function() + { + this.picker().remove(); + }, + + validateValue : function(value) + { + if(this.getVisibilityEl().hasClass('hidden')){ + return true; + } + + if(value.length < 1) { + if(this.allowBlank){ + return true; + } + return false; + } + + if(value.length < this.minLength){ + return false; + } + if(value.length > this.maxLength){ + return false; + } + if(this.vtype){ + var vt = Roo.form.VTypes; + if(!vt[this.vtype](value, this)){ + return false; + } + } + if(typeof this.validator == "function"){ + var msg = this.validator(value); + if(msg !== true){ + return false; + } + } + + if(this.regex && !this.regex.test(value)){ + return false; + } + + if(typeof(this.parseDate(value)) == 'undefined'){ + return false; + } + + if (this.endDate !== Infinity && this.parseDate(value).getTime() > this.endDate.getTime()) { + return false; + } + + if (this.startDate !== -Infinity && this.parseDate(value).getTime() < this.startDate.getTime()) { + return false; + } + + + return true; + }, + + reset : function() + { + this.date = this.viewDate = ''; + + Roo.bootstrap.DateField.superclass.setValue.call(this, ''); + } + +}); + +Roo.apply(Roo.bootstrap.DateField, { + + head : { + tag: 'thead', + cn: [ + { + tag: 'tr', + cn: [ + { + tag: 'th', + cls: 'prev', + html: '<i class="fa fa-arrow-left"/>' + }, + { + tag: 'th', + cls: 'switch', + colspan: '5' + }, + { + tag: 'th', + cls: 'next', + html: '<i class="fa fa-arrow-right"/>' + } + + ] + } + ] + }, + + content : { + tag: 'tbody', + cn: [ + { + tag: 'tr', + cn: [ + { + tag: 'td', + colspan: '7' + } + ] + } + ] + }, + + footer : { + tag: 'tfoot', + cn: [ + { + tag: 'tr', + cn: [ + { + tag: 'th', + colspan: '7', + cls: 'today' + } + + ] + } + ] + }, + + dates:{ + en: { + days: ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"], + daysShort: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"], + daysMin: ["Su", "Mo", "Tu", "We", "Th", "Fr", "Sa", "Su"], + months: ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"], + monthsShort: ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"], + today: "Today" + } + }, + + modes: [ + { + clsName: 'days', + navFnc: 'Month', + navStep: 1 + }, + { + clsName: 'months', + navFnc: 'FullYear', + navStep: 1 + }, + { + clsName: 'years', + navFnc: 'FullYear', + navStep: 10 + }] +}); + +Roo.apply(Roo.bootstrap.DateField, { + + template : { + tag: 'div', + cls: 'datepicker dropdown-menu roo-dynamic', + cn: [ + { + tag: 'div', + cls: 'datepicker-days', + cn: [ + { + tag: 'table', + cls: 'table-condensed', + cn:[ + Roo.bootstrap.DateField.head, + { + tag: 'tbody' + }, + Roo.bootstrap.DateField.footer + ] + } + ] + }, + { + tag: 'div', + cls: 'datepicker-months', + cn: [ + { + tag: 'table', + cls: 'table-condensed', + cn:[ + Roo.bootstrap.DateField.head, + Roo.bootstrap.DateField.content, + Roo.bootstrap.DateField.footer + ] + } + ] + }, + { + tag: 'div', + cls: 'datepicker-years', + cn: [ + { + tag: 'table', + cls: 'table-condensed', + cn:[ + Roo.bootstrap.DateField.head, + Roo.bootstrap.DateField.content, + Roo.bootstrap.DateField.footer + ] + } + ] + } + ] + } +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_DateSplitField.js.html b/docs2/src/Roo_bootstrap_DateSplitField.js.html new file mode 100644 index 0000000000..d88060e413 --- /dev/null +++ b/docs2/src/Roo_bootstrap_DateSplitField.js.html @@ -0,0 +1,432 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/DateSplitField.js/* + * - LGPL + * + * page DateSplitField. + * + */ + + +/** + * @class Roo.bootstrap.DateSplitField + * @extends Roo.bootstrap.Component + * Bootstrap DateSplitField class + * @cfg {string} fieldLabel - the label associated + * @cfg {Number} labelWidth set the width of label (0-12) + * @cfg {String} labelAlign (top|left) + * @cfg {Boolean} dayAllowBlank (true|false) default false + * @cfg {Boolean} monthAllowBlank (true|false) default false + * @cfg {Boolean} yearAllowBlank (true|false) default false + * @cfg {string} dayPlaceholder + * @cfg {string} monthPlaceholder + * @cfg {string} yearPlaceholder + * @cfg {string} dayFormat default 'd' + * @cfg {string} monthFormat default 'm' + * @cfg {string} yearFormat default 'Y' + * @cfg {Number} labellg set the width of label (1-12) + * @cfg {Number} labelmd set the width of label (1-12) + * @cfg {Number} labelsm set the width of label (1-12) + * @cfg {Number} labelxs set the width of label (1-12) + + * + * @constructor + * Create a new DateSplitField + * @param {Object} config The config object + */ + +Roo.bootstrap.DateSplitField = function(config){ + Roo.bootstrap.DateSplitField.superclass.constructor.call(this, config); + + this.addEvents({ + // raw events + /** + * @event years + * getting the data of years + * @param {Roo.bootstrap.DateSplitField} this + * @param {Object} years + */ + "years" : true, + /** + * @event days + * getting the data of days + * @param {Roo.bootstrap.DateSplitField} this + * @param {Object} days + */ + "days" : true, + /** + * @event invalid + * Fires after the field has been marked as invalid. + * @param {Roo.form.Field} this + * @param {String} msg The validation message + */ + invalid : true, + /** + * @event valid + * Fires after the field has been validated with no errors. + * @param {Roo.form.Field} this + */ + valid : true + }); +}; + +Roo.extend(Roo.bootstrap.DateSplitField, Roo.bootstrap.Component, { + + fieldLabel : '', + labelAlign : 'top', + labelWidth : 3, + dayAllowBlank : false, + monthAllowBlank : false, + yearAllowBlank : false, + dayPlaceholder : '', + monthPlaceholder : '', + yearPlaceholder : '', + dayFormat : 'd', + monthFormat : 'm', + yearFormat : 'Y', + isFormField : true, + labellg : 0, + labelmd : 0, + labelsm : 0, + labelxs : 0, + + getAutoCreate : function() + { + var cfg = { + tag : 'div', + cls : 'row roo-date-split-field-group', + cn : [ + { + tag : 'input', + type : 'hidden', + cls : 'form-hidden-field roo-date-split-field-group-value', + name : this.name + } + ] + }; + + var labelCls = 'col-md-12'; + var contentCls = 'col-md-4'; + + if(this.fieldLabel){ + + var label = { + tag : 'div', + cls : 'column roo-date-split-field-label col-md-' + ((this.labelAlign == 'top') ? '12' : this.labelWidth), + cn : [ + { + tag : 'label', + html : this.fieldLabel + } + ] + }; + + if(this.labelAlign == 'left'){ + + if(this.labelWidth > 12){ + label.style = "width: " + this.labelWidth + 'px'; + } + + if(this.labelWidth < 13 && this.labelmd == 0){ + this.labelmd = this.labelWidth; + } + + if(this.labellg > 0){ + labelCls = ' col-lg-' + this.labellg; + contentCls = ' col-lg-' + ((12 - this.labellg) / 3); + } + + if(this.labelmd > 0){ + labelCls = ' col-md-' + this.labelmd; + contentCls = ' col-md-' + ((12 - this.labelmd) / 3); + } + + if(this.labelsm > 0){ + labelCls = ' col-sm-' + this.labelsm; + contentCls = ' col-sm-' + ((12 - this.labelsm) / 3); + } + + if(this.labelxs > 0){ + labelCls = ' col-xs-' + this.labelxs; + contentCls = ' col-xs-' + ((12 - this.labelxs) / 3); + } + } + + label.cls += ' ' + labelCls; + + cfg.cn.push(label); + } + + Roo.each(['day', 'month', 'year'], function(t){ + cfg.cn.push({ + tag : 'div', + cls : 'column roo-date-split-field-' + t + ' ' + contentCls + }); + }, this); + + return cfg; + }, + + inputEl: function () + { + return this.el.select('.roo-date-split-field-group-value', true).first(); + }, + + onRender : function(ct, position) + { + var _this = this; + + Roo.bootstrap.NavProgressBar.superclass.onRender.call(this, ct, position); + + this.inputEl = this.el.select('.roo-date-split-field-group-value', true).first(); + + this.dayField = new Roo.bootstrap.ComboBox({ + allowBlank : this.dayAllowBlank, + alwaysQuery : true, + displayField : 'value', + editable : false, + fieldLabel : '', + forceSelection : true, + mode : 'local', + placeholder : this.dayPlaceholder, + selectOnFocus : true, + tpl : '<div class="roo-select2-result"><b>{value}</b></div>', + triggerAction : 'all', + typeAhead : true, + valueField : 'value', + store : new Roo.data.SimpleStore({ + data : (function() { + var days = []; + _this.fireEvent('days', _this, days); + return days; + })(), + fields : [ 'value' ] + }), + listeners : { + select : function (_self, record, index) + { + _this.setValue(_this.getValue()); + } + } + }); + + this.dayField.render(this.el.select('.roo-date-split-field-day', true).first(), null); + + this.monthField = new Roo.bootstrap.MonthField({ + after : '<i class=\"fa fa-calendar\"></i>', + allowBlank : this.monthAllowBlank, + placeholder : this.monthPlaceholder, + readOnly : true, + listeners : { + render : function (_self) + { + this.el.select('span.input-group-addon', true).first().on('click', function(e){ + e.preventDefault(); + _self.focus(); + }); + }, + select : function (_self, oldvalue, newvalue) + { + _this.setValue(_this.getValue()); + } + } + }); + + this.monthField.render(this.el.select('.roo-date-split-field-month', true).first(), null); + + this.yearField = new Roo.bootstrap.ComboBox({ + allowBlank : this.yearAllowBlank, + alwaysQuery : true, + displayField : 'value', + editable : false, + fieldLabel : '', + forceSelection : true, + mode : 'local', + placeholder : this.yearPlaceholder, + selectOnFocus : true, + tpl : '<div class="roo-select2-result"><b>{value}</b></div>', + triggerAction : 'all', + typeAhead : true, + valueField : 'value', + store : new Roo.data.SimpleStore({ + data : (function() { + var years = []; + _this.fireEvent('years', _this, years); + return years; + })(), + fields : [ 'value' ] + }), + listeners : { + select : function (_self, record, index) + { + _this.setValue(_this.getValue()); + } + } + }); + + this.yearField.render(this.el.select('.roo-date-split-field-year', true).first(), null); + }, + + setValue : function(v, format) + { + this.inputEl.dom.value = v; + + var f = format || (this.yearFormat + '-' + this.monthFormat + '-' + this.dayFormat); + + var d = Date.parseDate(v, f); + + if(!d){ + this.validate(); + return; + } + + this.setDay(d.format(this.dayFormat)); + this.setMonth(d.format(this.monthFormat)); + this.setYear(d.format(this.yearFormat)); + + this.validate(); + + return; + }, + + setDay : function(v) + { + this.dayField.setValue(v); + this.inputEl.dom.value = this.getValue(); + this.validate(); + return; + }, + + setMonth : function(v) + { + this.monthField.setValue(v, true); + this.inputEl.dom.value = this.getValue(); + this.validate(); + return; + }, + + setYear : function(v) + { + this.yearField.setValue(v); + this.inputEl.dom.value = this.getValue(); + this.validate(); + return; + }, + + getDay : function() + { + return this.dayField.getValue(); + }, + + getMonth : function() + { + return this.monthField.getValue(); + }, + + getYear : function() + { + return this.yearField.getValue(); + }, + + getValue : function() + { + var f = this.yearFormat + '-' + this.monthFormat + '-' + this.dayFormat; + + var date = this.yearField.getValue() + '-' + this.monthField.getValue() + '-' + this.dayField.getValue(); + + return date; + }, + + reset : function() + { + this.setDay(''); + this.setMonth(''); + this.setYear(''); + this.inputEl.dom.value = ''; + this.validate(); + return; + }, + + validate : function() + { + var d = this.dayField.validate(); + var m = this.monthField.validate(); + var y = this.yearField.validate(); + + var valid = true; + + if( + (!this.dayAllowBlank && !d) || + (!this.monthAllowBlank && !m) || + (!this.yearAllowBlank && !y) + ){ + valid = false; + } + + if(this.dayAllowBlank && this.monthAllowBlank && this.yearAllowBlank){ + return valid; + } + + if(valid){ + this.markValid(); + return valid; + } + + this.markInvalid(); + + return valid; + }, + + markValid : function() + { + + var label = this.el.select('label', true).first(); + var icon = this.el.select('i.fa-star', true).first(); + + if(label && icon){ + icon.remove(); + } + + this.fireEvent('valid', this); + }, + + /** + * Mark this field as invalid + * @param {String} msg The validation message + */ + markInvalid : function(msg) + { + + var label = this.el.select('label', true).first(); + var icon = this.el.select('i.fa-star', true).first(); + + if(label && !icon){ + this.el.select('.roo-date-split-field-label', true).createChild({ + tag : 'i', + cls : 'text-danger fa fa-lg fa-star', + tooltip : 'This field is required', + style : 'margin-right:5px;' + }, label, true); + } + + this.fireEvent('invalid', this, msg); + }, + + clearInvalid : function() + { + var label = this.el.select('label', true).first(); + var icon = this.el.select('i.fa-star', true).first(); + + if(label && icon){ + icon.remove(); + } + + this.fireEvent('valid', this); + }, + + getName: function() + { + return this.name; + } + +}); + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_DocumentManager.js.html b/docs2/src/Roo_bootstrap_DocumentManager.js.html new file mode 100644 index 0000000000..e7fd255029 --- /dev/null +++ b/docs2/src/Roo_bootstrap_DocumentManager.js.html @@ -0,0 +1,805 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/DocumentManager.js +/* +* Licence: LGPL +*/ + +/** + * @class Roo.bootstrap.DocumentManager + * @extends Roo.bootstrap.Component + * Bootstrap DocumentManager class + * @cfg {String} paramName default 'imageUpload' + * @cfg {String} toolTipName default 'filename' + * @cfg {String} method default POST + * @cfg {String} url action url + * @cfg {Number} boxes number of boxes, 0 is no limit.. default 0 + * @cfg {Boolean} multiple multiple upload default true + * @cfg {Number} thumbSize default 300 + * @cfg {String} fieldLabel + * @cfg {Number} labelWidth default 4 + * @cfg {String} labelAlign (left|top) default left + * @cfg {Boolean} editable (true|false) allow edit when upload a image default true +* @cfg {Number} labellg set the width of label (1-12) + * @cfg {Number} labelmd set the width of label (1-12) + * @cfg {Number} labelsm set the width of label (1-12) + * @cfg {Number} labelxs set the width of label (1-12) + * + * @constructor + * Create a new DocumentManager + * @param {Object} config The config object + */ + +Roo.bootstrap.DocumentManager = function(config){ + Roo.bootstrap.DocumentManager.superclass.constructor.call(this, config); + + this.files = []; + this.delegates = []; + + this.addEvents({ + /** + * @event initial + * Fire when initial the DocumentManager + * @param {Roo.bootstrap.DocumentManager} this + */ + "initial" : true, + /** + * @event inspect + * inspect selected file + * @param {Roo.bootstrap.DocumentManager} this + * @param {File} file + */ + "inspect" : true, + /** + * @event exception + * Fire when xhr load exception + * @param {Roo.bootstrap.DocumentManager} this + * @param {XMLHttpRequest} xhr + */ + "exception" : true, + /** + * @event afterupload + * Fire when xhr load exception + * @param {Roo.bootstrap.DocumentManager} this + * @param {XMLHttpRequest} xhr + */ + "afterupload" : true, + /** + * @event prepare + * prepare the form data + * @param {Roo.bootstrap.DocumentManager} this + * @param {Object} formData + */ + "prepare" : true, + /** + * @event remove + * Fire when remove the file + * @param {Roo.bootstrap.DocumentManager} this + * @param {Object} file + */ + "remove" : true, + /** + * @event refresh + * Fire after refresh the file + * @param {Roo.bootstrap.DocumentManager} this + */ + "refresh" : true, + /** + * @event click + * Fire after click the image + * @param {Roo.bootstrap.DocumentManager} this + * @param {Object} file + */ + "click" : true, + /** + * @event edit + * Fire when upload a image and editable set to true + * @param {Roo.bootstrap.DocumentManager} this + * @param {Object} file + */ + "edit" : true, + /** + * @event beforeselectfile + * Fire before select file + * @param {Roo.bootstrap.DocumentManager} this + */ + "beforeselectfile" : true, + /** + * @event process + * Fire before process file + * @param {Roo.bootstrap.DocumentManager} this + * @param {Object} file + */ + "process" : true, + /** + * @event previewrendered + * Fire when preview rendered + * @param {Roo.bootstrap.DocumentManager} this + * @param {Object} file + */ + "previewrendered" : true, + /** + */ + "previewResize" : true + + }); +}; + +Roo.extend(Roo.bootstrap.DocumentManager, Roo.bootstrap.Component, { + + boxes : 0, + inputName : '', + thumbSize : 300, + multiple : true, + files : false, + method : 'POST', + url : '', + paramName : 'imageUpload', + toolTipName : 'filename', + fieldLabel : '', + labelWidth : 4, + labelAlign : 'left', + editable : true, + delegates : false, + xhr : false, + + labellg : 0, + labelmd : 0, + labelsm : 0, + labelxs : 0, + + getAutoCreate : function() + { + var managerWidget = { + tag : 'div', + cls : 'roo-document-manager', + cn : [ + { + tag : 'input', + cls : 'roo-document-manager-selector', + type : 'file' + }, + { + tag : 'div', + cls : 'roo-document-manager-uploader', + cn : [ + { + tag : 'div', + cls : 'roo-document-manager-upload-btn', + html : '<i class="fa fa-plus"></i>' + } + ] + + } + ] + }; + + var content = [ + { + tag : 'div', + cls : 'column col-md-12', + cn : managerWidget + } + ]; + + if(this.fieldLabel.length){ + + content = [ + { + tag : 'div', + cls : 'column col-md-12', + html : this.fieldLabel + }, + { + tag : 'div', + cls : 'column col-md-12', + cn : managerWidget + } + ]; + + if(this.labelAlign == 'left'){ + content = [ + { + tag : 'div', + cls : 'column', + html : this.fieldLabel + }, + { + tag : 'div', + cls : 'column', + cn : managerWidget + } + ]; + + if(this.labelWidth > 12){ + content[0].style = "width: " + this.labelWidth + 'px'; + } + + if(this.labelWidth < 13 && this.labelmd == 0){ + this.labelmd = this.labelWidth; + } + + if(this.labellg > 0){ + content[0].cls += ' col-lg-' + this.labellg; + content[1].cls += ' col-lg-' + (12 - this.labellg); + } + + if(this.labelmd > 0){ + content[0].cls += ' col-md-' + this.labelmd; + content[1].cls += ' col-md-' + (12 - this.labelmd); + } + + if(this.labelsm > 0){ + content[0].cls += ' col-sm-' + this.labelsm; + content[1].cls += ' col-sm-' + (12 - this.labelsm); + } + + if(this.labelxs > 0){ + content[0].cls += ' col-xs-' + this.labelxs; + content[1].cls += ' col-xs-' + (12 - this.labelxs); + } + + } + } + + var cfg = { + tag : 'div', + cls : 'row clearfix', + cn : content + }; + + return cfg; + + }, + + initEvents : function() + { + this.managerEl = this.el.select('.roo-document-manager', true).first(); + this.managerEl.setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + + this.selectorEl = this.el.select('.roo-document-manager-selector', true).first(); + this.selectorEl.hide(); + + if(this.multiple){ + this.selectorEl.attr('multiple', 'multiple'); + } + + this.selectorEl.on('change', this.onFileSelected, this); + + this.uploader = this.el.select('.roo-document-manager-uploader', true).first(); + this.uploader.setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + + this.uploader.on('click', this.onUploaderClick, this); + + this.renderProgressDialog(); + + var _this = this; + + window.addEventListener("resize", function() { _this.refresh(); } ); + + this.fireEvent('initial', this); + }, + + renderProgressDialog : function() + { + var _this = this; + + this.progressDialog = new Roo.bootstrap.Modal({ + cls : 'roo-document-manager-progress-dialog', + allow_close : false, + animate : false, + title : '', + buttons : [ + { + name :'cancel', + weight : 'danger', + html : 'Cancel' + } + ], + listeners : { + btnclick : function() { + _this.uploadCancel(); + this.hide(); + } + } + }); + + this.progressDialog.render(Roo.get(document.body)); + + this.progress = new Roo.bootstrap.Progress({ + cls : 'roo-document-manager-progress', + active : true, + striped : true + }); + + this.progress.render(this.progressDialog.getChildContainer()); + + this.progressBar = new Roo.bootstrap.ProgressBar({ + cls : 'roo-document-manager-progress-bar', + aria_valuenow : 0, + aria_valuemin : 0, + aria_valuemax : 12, + panel : 'success' + }); + + this.progressBar.render(this.progress.getChildContainer()); + }, + + onUploaderClick : function(e) + { + e.preventDefault(); + + if(this.fireEvent('beforeselectfile', this) != false){ + this.selectorEl.dom.click(); + } + + }, + + onFileSelected : function(e) + { + e.preventDefault(); + + if(typeof(this.selectorEl.dom.files) == 'undefined' || !this.selectorEl.dom.files.length){ + return; + } + + Roo.each(this.selectorEl.dom.files, function(file){ + if(this.fireEvent('inspect', this, file) != false){ + this.files.push(file); + } + }, this); + + this.queue(); + + }, + + queue : function() + { + this.selectorEl.dom.value = ''; + + if(!this.files || !this.files.length){ + return; + } + + if(this.boxes > 0 && this.files.length > this.boxes){ + this.files = this.files.slice(0, this.boxes); + } + + this.uploader.show(); + + if(this.boxes > 0 && this.files.length > this.boxes - 1){ + this.uploader.hide(); + } + + var _this = this; + + var files = []; + + var docs = []; + + Roo.each(this.files, function(file){ + + if(typeof(file.id) != 'undefined' && file.id * 1 > 0){ + var f = this.renderPreview(file); + files.push(f); + return; + } + + if(file.type.indexOf('image') != -1){ + this.delegates.push( + (function(){ + _this.process(file); + }).createDelegate(this) + ); + + return; + } + + docs.push( + (function(){ + _this.process(file); + }).createDelegate(this) + ); + + }, this); + + this.files = files; + + this.delegates = this.delegates.concat(docs); + + if(!this.delegates.length){ + this.refresh(); + return; + } + + this.progressBar.aria_valuemax = this.delegates.length; + + this.arrange(); + + return; + }, + + arrange : function() + { + if(!this.delegates.length){ + this.progressDialog.hide(); + this.refresh(); + return; + } + + var delegate = this.delegates.shift(); + + this.progressDialog.show(); + + this.progressDialog.setTitle((this.progressBar.aria_valuemax - this.delegates.length) + ' / ' + this.progressBar.aria_valuemax); + + this.progressBar.update(this.progressBar.aria_valuemax - this.delegates.length); + + delegate(); + }, + + refresh : function() + { + this.uploader.show(); + + if(this.boxes > 0 && this.files.length > this.boxes - 1){ + this.uploader.hide(); + } + + Roo.isTouch ? this.closable(false) : this.closable(true); + + this.fireEvent('refresh', this); + }, + + onRemove : function(e, el, o) + { + e.preventDefault(); + + this.fireEvent('remove', this, o); + + }, + + remove : function(o) + { + var files = []; + + Roo.each(this.files, function(file){ + if(typeof(file.id) == 'undefined' || file.id * 1 < 1 || file.id != o.id){ + files.push(file); + return; + } + + o.target.remove(); + + }, this); + + this.files = files; + + this.refresh(); + }, + + clear : function() + { + Roo.each(this.files, function(file){ + if(!file.target){ + return; + } + + file.target.remove(); + + }, this); + + this.files = []; + + this.refresh(); + }, + + onClick : function(e, el, o) + { + e.preventDefault(); + + this.fireEvent('click', this, o); + + }, + + closable : function(closable) + { + Roo.each(this.managerEl.select('.roo-document-manager-preview > button.close', true).elements, function(el){ + + el.setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + + if(closable){ + el.show(); + return; + } + + el.hide(); + + }, this); + }, + + xhrOnLoad : function(xhr) + { + Roo.each(this.managerEl.select('.roo-document-manager-loading', true).elements, function(el){ + el.remove(); + }, this); + + if (xhr.readyState !== 4) { + this.arrange(); + this.fireEvent('exception', this, xhr); + return; + } + + var response = Roo.decode(xhr.responseText); + + if(!response.success){ + this.arrange(); + this.fireEvent('exception', this, xhr); + return; + } + + var file = this.renderPreview(response.data); + + this.files.push(file); + + this.arrange(); + + this.fireEvent('afterupload', this, xhr); + + }, + + xhrOnError : function(xhr) + { + Roo.log('xhr on error'); + + var response = Roo.decode(xhr.responseText); + + Roo.log(response); + + this.arrange(); + }, + + process : function(file) + { + if(this.fireEvent('process', this, file) !== false){ + if(this.editable && file.type.indexOf('image') != -1){ + this.fireEvent('edit', this, file); + return; + } + + this.uploadStart(file, false); + + return; + } + + }, + + uploadStart : function(file, crop) + { + this.xhr = new XMLHttpRequest(); + + if(typeof(file.id) != 'undefined' && file.id * 1 > 0){ + this.arrange(); + return; + } + + file.xhr = this.xhr; + + this.managerEl.createChild({ + tag : 'div', + cls : 'roo-document-manager-loading', + cn : [ + { + tag : 'div', + tooltip : file.name, + cls : 'roo-document-manager-thumb', + html : '<i class="fa fa-circle-o-notch fa-spin"></i>' + } + ] + + }); + + this.xhr.open(this.method, this.url, true); + + var headers = { + "Accept": "application/json", + "Cache-Control": "no-cache", + "X-Requested-With": "XMLHttpRequest" + }; + + for (var headerName in headers) { + var headerValue = headers[headerName]; + if (headerValue) { + this.xhr.setRequestHeader(headerName, headerValue); + } + } + + var _this = this; + + this.xhr.onload = function() + { + _this.xhrOnLoad(_this.xhr); + } + + this.xhr.onerror = function() + { + _this.xhrOnError(_this.xhr); + } + + var formData = new FormData(); + + formData.append('returnHTML', 'NO'); + + if(crop){ + formData.append('crop', crop); + } + + formData.append(this.paramName, file, file.name); + + var options = { + file : file, + manually : false + }; + + if(this.fireEvent('prepare', this, formData, options) != false){ + + if(options.manually){ + return; + } + + this.xhr.send(formData); + return; + }; + + this.uploadCancel(); + }, + + uploadCancel : function() + { + if (this.xhr) { + this.xhr.abort(); + } + + this.delegates = []; + + Roo.each(this.managerEl.select('.roo-document-manager-loading', true).elements, function(el){ + el.remove(); + }, this); + + this.arrange(); + }, + + renderPreview : function(file) + { + if(typeof(file.target) != 'undefined' && file.target){ + return file; + } + + var img_src = encodeURI(baseURL +'/Images/Thumb/' + this.thumbSize + '/' + file.id + '/' + file.filename); + + var previewEl = this.managerEl.createChild({ + tag : 'div', + cls : 'roo-document-manager-preview', + cn : [ + { + tag : 'div', + tooltip : file[this.toolTipName], + cls : 'roo-document-manager-thumb', + html : '<img tooltip="' + file[this.toolTipName] + '" src="' + img_src + '">' + }, + { + tag : 'button', + cls : 'close', + html : '<i class="fa fa-times-circle"></i>' + } + ] + }); + + var close = previewEl.select('button.close', true).first(); + + close.on('click', this.onRemove, this, file); + + file.target = previewEl; + + var image = previewEl.select('img', true).first(); + + var _this = this; + + image.dom.addEventListener("load", function(){ _this.onPreviewLoad(file, image); }); + + image.on('click', this.onClick, this, file); + + this.fireEvent('previewrendered', this, file); + + return file; + + }, + + onPreviewLoad : function(file, image) + { + if(typeof(file.target) == 'undefined' || !file.target){ + return; + } + + var width = image.dom.naturalWidth || image.dom.width; + var height = image.dom.naturalHeight || image.dom.height; + + if(!this.previewResize) { + return; + } + + if(width > height){ + file.target.addClass('wide'); + return; + } + + file.target.addClass('tall'); + return; + + }, + + uploadFromSource : function(file, crop) + { + this.xhr = new XMLHttpRequest(); + + this.managerEl.createChild({ + tag : 'div', + cls : 'roo-document-manager-loading', + cn : [ + { + tag : 'div', + tooltip : file.name, + cls : 'roo-document-manager-thumb', + html : '<i class="fa fa-circle-o-notch fa-spin"></i>' + } + ] + + }); + + this.xhr.open(this.method, this.url, true); + + var headers = { + "Accept": "application/json", + "Cache-Control": "no-cache", + "X-Requested-With": "XMLHttpRequest" + }; + + for (var headerName in headers) { + var headerValue = headers[headerName]; + if (headerValue) { + this.xhr.setRequestHeader(headerName, headerValue); + } + } + + var _this = this; + + this.xhr.onload = function() + { + _this.xhrOnLoad(_this.xhr); + } + + this.xhr.onerror = function() + { + _this.xhrOnError(_this.xhr); + } + + var formData = new FormData(); + + formData.append('returnHTML', 'NO'); + + formData.append('crop', crop); + + if(typeof(file.filename) != 'undefined'){ + formData.append('filename', file.filename); + } + + if(typeof(file.mimetype) != 'undefined'){ + formData.append('mimetype', file.mimetype); + } + + Roo.log(formData); + + if(this.fireEvent('prepare', this, formData) != false){ + this.xhr.send(formData); + }; + } +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_DocumentSlider.js.html b/docs2/src/Roo_bootstrap_DocumentSlider.js.html new file mode 100644 index 0000000000..fec2a33768 --- /dev/null +++ b/docs2/src/Roo_bootstrap_DocumentSlider.js.html @@ -0,0 +1,196 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/DocumentSlider.js +/* +* Licence: LGPL +*/ + +/** + * @class Roo.bootstrap.DocumentSlider + * @extends Roo.bootstrap.Component + * Bootstrap DocumentSlider class + * + * @constructor + * Create a new DocumentViewer + * @param {Object} config The config object + */ + +Roo.bootstrap.DocumentSlider = function(config){ + Roo.bootstrap.DocumentSlider.superclass.constructor.call(this, config); + + this.files = []; + + this.addEvents({ + /** + * @event initial + * Fire after initEvent + * @param {Roo.bootstrap.DocumentSlider} this + */ + "initial" : true, + /** + * @event update + * Fire after update + * @param {Roo.bootstrap.DocumentSlider} this + */ + "update" : true, + /** + * @event click + * Fire after click + * @param {Roo.bootstrap.DocumentSlider} this + */ + "click" : true + }); +}; + +Roo.extend(Roo.bootstrap.DocumentSlider, Roo.bootstrap.Component, { + + files : false, + + indicator : 0, + + getAutoCreate : function() + { + var cfg = { + tag : 'div', + cls : 'roo-document-slider', + cn : [ + { + tag : 'div', + cls : 'roo-document-slider-header', + cn : [ + { + tag : 'div', + cls : 'roo-document-slider-header-title' + } + ] + }, + { + tag : 'div', + cls : 'roo-document-slider-body', + cn : [ + { + tag : 'div', + cls : 'roo-document-slider-prev', + cn : [ + { + tag : 'i', + cls : 'fa fa-chevron-left' + } + ] + }, + { + tag : 'div', + cls : 'roo-document-slider-thumb', + cn : [ + { + tag : 'img', + cls : 'roo-document-slider-image' + } + ] + }, + { + tag : 'div', + cls : 'roo-document-slider-next', + cn : [ + { + tag : 'i', + cls : 'fa fa-chevron-right' + } + ] + } + ] + } + ] + }; + + return cfg; + }, + + initEvents : function() + { + this.headerEl = this.el.select('.roo-document-slider-header', true).first(); + this.headerEl.setVisibilityMode(Roo.Element.DISPLAY); + + this.titleEl = this.el.select('.roo-document-slider-header .roo-document-slider-header-title', true).first(); + this.titleEl.setVisibilityMode(Roo.Element.DISPLAY); + + this.bodyEl = this.el.select('.roo-document-slider-body', true).first(); + this.bodyEl.setVisibilityMode(Roo.Element.DISPLAY); + + this.thumbEl = this.el.select('.roo-document-slider-thumb', true).first(); + this.thumbEl.setVisibilityMode(Roo.Element.DISPLAY); + + this.imageEl = this.el.select('.roo-document-slider-image', true).first(); + this.imageEl.setVisibilityMode(Roo.Element.DISPLAY); + + this.prevIndicator = this.el.select('.roo-document-slider-prev i', true).first(); + this.prevIndicator.setVisibilityMode(Roo.Element.DISPLAY); + + this.nextIndicator = this.el.select('.roo-document-slider-next i', true).first(); + this.nextIndicator.setVisibilityMode(Roo.Element.DISPLAY); + + this.thumbEl.on('click', this.onClick, this); + + this.prevIndicator.on('click', this.prev, this); + + this.nextIndicator.on('click', this.next, this); + + }, + + initial : function() + { + if(this.files.length){ + this.indicator = 1; + this.update() + } + + this.fireEvent('initial', this); + }, + + update : function() + { + this.imageEl.attr('src', this.files[this.indicator - 1]); + + this.titleEl.dom.innerHTML = String.format('{0} / {1}', this.indicator, this.files.length); + + this.prevIndicator.show(); + + if(this.indicator == 1){ + this.prevIndicator.hide(); + } + + this.nextIndicator.show(); + + if(this.indicator == this.files.length){ + this.nextIndicator.hide(); + } + + this.thumbEl.scrollTo('top'); + + this.fireEvent('update', this); + }, + + onClick : function(e) + { + e.preventDefault(); + + this.fireEvent('click', this); + }, + + prev : function(e) + { + e.preventDefault(); + + this.indicator = Math.max(1, this.indicator - 1); + + this.update(); + }, + + next : function(e) + { + e.preventDefault(); + + this.indicator = Math.min(this.files.length, this.indicator + 1); + + this.update(); + } +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_DocumentViewer.js.html b/docs2/src/Roo_bootstrap_DocumentViewer.js.html new file mode 100644 index 0000000000..c3b2a077bc --- /dev/null +++ b/docs2/src/Roo_bootstrap_DocumentViewer.js.html @@ -0,0 +1,185 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/DocumentViewer.js +/* +* Licence: LGPL +*/ + +/** + * @class Roo.bootstrap.DocumentViewer + * @extends Roo.bootstrap.Component + * Bootstrap DocumentViewer class + * @cfg {Boolean} showDownload (true|false) show download button (default true) + * @cfg {Boolean} showTrash (true|false) show trash button (default true) + * + * @constructor + * Create a new DocumentViewer + * @param {Object} config The config object + */ + +Roo.bootstrap.DocumentViewer = function(config){ + Roo.bootstrap.DocumentViewer.superclass.constructor.call(this, config); + + this.addEvents({ + /** + * @event initial + * Fire after initEvent + * @param {Roo.bootstrap.DocumentViewer} this + */ + "initial" : true, + /** + * @event click + * Fire after click + * @param {Roo.bootstrap.DocumentViewer} this + */ + "click" : true, + /** + * @event download + * Fire after download button + * @param {Roo.bootstrap.DocumentViewer} this + */ + "download" : true, + /** + * @event trash + * Fire after trash button + * @param {Roo.bootstrap.DocumentViewer} this + */ + "trash" : true + + }); +}; + +Roo.extend(Roo.bootstrap.DocumentViewer, Roo.bootstrap.Component, { + + showDownload : true, + + showTrash : true, + + getAutoCreate : function() + { + var cfg = { + tag : 'div', + cls : 'roo-document-viewer', + cn : [ + { + tag : 'div', + cls : 'roo-document-viewer-body', + cn : [ + { + tag : 'div', + cls : 'roo-document-viewer-thumb', + cn : [ + { + tag : 'img', + cls : 'roo-document-viewer-image' + } + ] + } + ] + }, + { + tag : 'div', + cls : 'roo-document-viewer-footer', + cn : { + tag : 'div', + cls : 'btn-group btn-group-justified roo-document-viewer-btn-group', + cn : [ + { + tag : 'div', + cls : 'btn-group roo-document-viewer-download', + cn : [ + { + tag : 'button', + cls : 'btn btn-default', + html : '<i class="fa fa-download"></i>' + } + ] + }, + { + tag : 'div', + cls : 'btn-group roo-document-viewer-trash', + cn : [ + { + tag : 'button', + cls : 'btn btn-default', + html : '<i class="fa fa-trash"></i>' + } + ] + } + ] + } + } + ] + }; + + return cfg; + }, + + initEvents : function() + { + this.bodyEl = this.el.select('.roo-document-viewer-body', true).first(); + this.bodyEl.setVisibilityMode(Roo.Element.DISPLAY); + + this.thumbEl = this.el.select('.roo-document-viewer-thumb', true).first(); + this.thumbEl.setVisibilityMode(Roo.Element.DISPLAY); + + this.imageEl = this.el.select('.roo-document-viewer-image', true).first(); + this.imageEl.setVisibilityMode(Roo.Element.DISPLAY); + + this.footerEl = this.el.select('.roo-document-viewer-footer', true).first(); + this.footerEl.setVisibilityMode(Roo.Element.DISPLAY); + + this.downloadBtn = this.el.select('.roo-document-viewer-download', true).first(); + this.downloadBtn.setVisibilityMode(Roo.Element.DISPLAY); + + this.trashBtn = this.el.select('.roo-document-viewer-trash', true).first(); + this.trashBtn.setVisibilityMode(Roo.Element.DISPLAY); + + this.bodyEl.on('click', this.onClick, this); + this.downloadBtn.on('click', this.onDownload, this); + this.trashBtn.on('click', this.onTrash, this); + + this.downloadBtn.hide(); + this.trashBtn.hide(); + + if(this.showDownload){ + this.downloadBtn.show(); + } + + if(this.showTrash){ + this.trashBtn.show(); + } + + if(!this.showDownload && !this.showTrash) { + this.footerEl.hide(); + } + + }, + + initial : function() + { + this.fireEvent('initial', this); + + }, + + onClick : function(e) + { + e.preventDefault(); + + this.fireEvent('click', this); + }, + + onDownload : function(e) + { + e.preventDefault(); + + this.fireEvent('download', this); + }, + + onTrash : function(e) + { + e.preventDefault(); + + this.fireEvent('trash', this); + } + +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Element.js.html b/docs2/src/Roo_bootstrap_Element.js.html new file mode 100644 index 0000000000..72e83db29e --- /dev/null +++ b/docs2/src/Roo_bootstrap_Element.js.html @@ -0,0 +1,90 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Element.js/* + * - LGPL + * + * element + * + */ + +/** + * @class Roo.bootstrap.Element + * @extends Roo.bootstrap.Component + * Bootstrap Element class + * @cfg {String} html contents of the element + * @cfg {String} tag tag of the element + * @cfg {String} cls class of the element + * @cfg {Boolean} preventDefault (true|false) default false + * @cfg {Boolean} clickable (true|false) default false + * + * @constructor + * Create a new Element + * @param {Object} config The config object + */ + +Roo.bootstrap.Element = function(config){ + Roo.bootstrap.Element.superclass.constructor.call(this, config); + + this.addEvents({ + // raw events + /** + * @event click + * When a element is chick + * @param {Roo.bootstrap.Element} this + * @param {Roo.EventObject} e + */ + "click" : true + }); +}; + +Roo.extend(Roo.bootstrap.Element, Roo.bootstrap.Component, { + + tag: 'div', + cls: '', + html: '', + preventDefault: false, + clickable: false, + + getAutoCreate : function(){ + + var cfg = { + tag: this.tag, + // cls: this.cls, double assign in parent class Component.js :: onRender + html: this.html + }; + + return cfg; + }, + + initEvents: function() + { + Roo.bootstrap.Element.superclass.initEvents.call(this); + + if(this.clickable){ + this.el.on('click', this.onClick, this); + } + + }, + + onClick : function(e) + { + if(this.preventDefault){ + e.preventDefault(); + } + + this.fireEvent('click', this, e); + }, + + getValue : function() + { + return this.el.dom.innerHTML; + }, + + setValue : function(value) + { + this.el.dom.innerHTML = value; + } + +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_FieldLabel.js.html b/docs2/src/Roo_bootstrap_FieldLabel.js.html new file mode 100644 index 0000000000..38bbfc8045 --- /dev/null +++ b/docs2/src/Roo_bootstrap_FieldLabel.js.html @@ -0,0 +1,210 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/FieldLabel.js/* + * - LGPL + * + * FieldLabel + * + */ + +/** + * @class Roo.bootstrap.FieldLabel + * @extends Roo.bootstrap.Component + * Bootstrap FieldLabel class + * @cfg {String} html contents of the element + * @cfg {String} tag tag of the element default label + * @cfg {String} cls class of the element + * @cfg {String} target label target + * @cfg {Boolean} allowBlank (true|false) target allowBlank default true + * @cfg {String} invalidClass DEPRICATED - BS4 uses is-invalid + * @cfg {String} validClass DEPRICATED - BS4 uses is-valid + * @cfg {String} iconTooltip default "This field is required" + * @cfg {String} indicatorpos (left|right) default left + * + * @constructor + * Create a new FieldLabel + * @param {Object} config The config object + */ + +Roo.bootstrap.FieldLabel = function(config){ + Roo.bootstrap.Element.superclass.constructor.call(this, config); + + this.addEvents({ + /** + * @event invalid + * Fires after the field has been marked as invalid. + * @param {Roo.form.FieldLabel} this + * @param {String} msg The validation message + */ + invalid : true, + /** + * @event valid + * Fires after the field has been validated with no errors. + * @param {Roo.form.FieldLabel} this + */ + valid : true + }); +}; + +Roo.extend(Roo.bootstrap.FieldLabel, Roo.bootstrap.Component, { + + tag: 'label', + cls: '', + html: '', + target: '', + allowBlank : true, + invalidClass : 'has-warning', + validClass : 'has-success', + iconTooltip : 'This field is required', + indicatorpos : 'left', + + getAutoCreate : function(){ + + var cls = ""; + if (!this.allowBlank) { + cls = "visible"; + } + + var cfg = { + tag : this.tag, + cls : 'roo-bootstrap-field-label ' + this.cls, + for : this.target, + cn : [ + { + tag : 'i', + cls : 'roo-required-indicator left-indicator text-danger fa fa-lg fa-star ' + cls, + tooltip : this.iconTooltip + }, + { + tag : 'span', + html : this.html + } + ] + }; + + if(this.indicatorpos == 'right'){ + var cfg = { + tag : this.tag, + cls : 'roo-bootstrap-field-label ' + this.cls, + for : this.target, + cn : [ + { + tag : 'span', + html : this.html + }, + { + tag : 'i', + cls : 'roo-required-indicator right-indicator text-danger fa fa-lg fa-star '+ cls, + tooltip : this.iconTooltip + } + ] + }; + } + + return cfg; + }, + + initEvents: function() + { + Roo.bootstrap.Element.superclass.initEvents.call(this); + + this.indicator = this.indicatorEl(); + + if(this.indicator){ + this.indicator.removeClass('visible'); + this.indicator.addClass('invisible'); + } + + Roo.bootstrap.FieldLabel.register(this); + }, + + indicatorEl : function() + { + var indicator = this.el.select('i.roo-required-indicator',true).first(); + + if(!indicator){ + return false; + } + + return indicator; + + }, + + /** + * Mark this field as valid + */ + markValid : function() + { + if(this.indicator){ + this.indicator.removeClass('visible'); + this.indicator.addClass('invisible'); + } + if (Roo.bootstrap.version == 3) { + this.el.removeClass(this.invalidClass); + this.el.addClass(this.validClass); + } else { + this.el.removeClass('is-invalid'); + this.el.addClass('is-valid'); + } + + + this.fireEvent('valid', this); + }, + + /** + * Mark this field as invalid + * @param {String} msg The validation message + */ + markInvalid : function(msg) + { + if(this.indicator){ + this.indicator.removeClass('invisible'); + this.indicator.addClass('visible'); + } + if (Roo.bootstrap.version == 3) { + this.el.removeClass(this.validClass); + this.el.addClass(this.invalidClass); + } else { + this.el.removeClass('is-valid'); + this.el.addClass('is-invalid'); + } + + + this.fireEvent('invalid', this, msg); + } + + +}); + +Roo.apply(Roo.bootstrap.FieldLabel, { + + groups: {}, + + /** + * register a FieldLabel Group + * @param {Roo.bootstrap.FieldLabel} the FieldLabel to add + */ + register : function(label) + { + if(this.groups.hasOwnProperty(label.target)){ + return; + } + + this.groups[label.target] = label; + + }, + /** + * fetch a FieldLabel Group based on the target + * @param {string} target + * @returns {Roo.bootstrap.FieldLabel} the CheckBox group + */ + get: function(target) { + if (typeof(this.groups[target]) == 'undefined') { + return false; + } + + return this.groups[target] ; + } +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Form.js.html b/docs2/src/Roo_bootstrap_Form.js.html new file mode 100644 index 0000000000..e757afd19c --- /dev/null +++ b/docs2/src/Roo_bootstrap_Form.js.html @@ -0,0 +1,795 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Form.js/* + * - LGPL + * + * form + * + */ + +/** + * @class Roo.bootstrap.Form + * @extends Roo.bootstrap.Component + * Bootstrap Form class + * @cfg {String} method GET | POST (default POST) + * @cfg {String} labelAlign top | left (default top) + * @cfg {String} align left | right - for navbars + * @cfg {Boolean} loadMask load mask when submit (default true) + + * + * @constructor + * Create a new Form + * @param {Object} config The config object + */ + + +Roo.bootstrap.Form = function(config){ + + Roo.bootstrap.Form.superclass.constructor.call(this, config); + + Roo.bootstrap.Form.popover.apply(); + + this.addEvents({ + /** + * @event clientvalidation + * If the monitorValid config option is true, this event fires repetitively to notify of valid state + * @param {Form} this + * @param {Boolean} valid true if the form has passed client-side validation + */ + clientvalidation: true, + /** + * @event beforeaction + * Fires before any action is performed. Return false to cancel the action. + * @param {Form} this + * @param {Action} action The action to be performed + */ + beforeaction: true, + /** + * @event actionfailed + * Fires when an action fails. + * @param {Form} this + * @param {Action} action The action that failed + */ + actionfailed : true, + /** + * @event actioncomplete + * Fires when an action is completed. + * @param {Form} this + * @param {Action} action The action that completed + */ + actioncomplete : true + }); +}; + +Roo.extend(Roo.bootstrap.Form, Roo.bootstrap.Component, { + + /** + * @cfg {String} method + * The request method to use (GET or POST) for form actions if one isn't supplied in the action options. + */ + method : 'POST', + /** + * @cfg {String} url + * The URL to use for form actions if one isn't supplied in the action options. + */ + /** + * @cfg {Boolean} fileUpload + * Set to true if this form is a file upload. + */ + + /** + * @cfg {Object} baseParams + * Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}. + */ + + /** + * @cfg {Number} timeout Timeout for form actions in seconds (default is 30 seconds). + */ + timeout: 30, + /** + * @cfg {Sting} align (left|right) for navbar forms + */ + align : 'left', + + // private + activeAction : null, + + /** + * By default wait messages are displayed with Roo.MessageBox.wait. You can target a specific + * element by passing it or its id or mask the form itself by passing in true. + * @type Mixed + */ + waitMsgTarget : false, + + loadMask : true, + + /** + * @cfg {Boolean} errorMask (true|false) default false + */ + errorMask : false, + + /** + * @cfg {Number} maskOffset Default 100 + */ + maskOffset : 100, + + /** + * @cfg {Boolean} maskBody + */ + maskBody : false, + + getAutoCreate : function(){ + + var cfg = { + tag: 'form', + method : this.method || 'POST', + id : this.id || Roo.id(), + cls : '' + }; + if (this.parent().xtype.match(/^Nav/)) { + cfg.cls = 'navbar-form form-inline navbar-' + this.align; + + } + + if (this.labelAlign == 'left' ) { + cfg.cls += ' form-horizontal'; + } + + + return cfg; + }, + initEvents : function() + { + this.el.on('submit', this.onSubmit, this); + // this was added as random key presses on the form where triggering form submit. + this.el.on('keypress', function(e) { + if (e.getCharCode() != 13) { + return true; + } + // we might need to allow it for textareas.. and some other items. + // check e.getTarget(). + + if(e.getTarget().nodeName.toLowerCase() === 'textarea'){ + return true; + } + + Roo.log("keypress blocked"); + + e.preventDefault(); + return false; + }); + + }, + // private + onSubmit : function(e){ + e.stopEvent(); + }, + + /** + * Returns true if client-side validation on the form is successful. + * @return Boolean + */ + isValid : function(){ + var items = this.getItems(); + var valid = true; + var target = false; + + items.each(function(f){ + + if(f.validate()){ + return; + } + + Roo.log('invalid field: ' + f.name); + + valid = false; + + if(!target && f.el.isVisible(true)){ + target = f; + } + + }); + + if(this.errorMask && !valid){ + Roo.bootstrap.Form.popover.mask(this, target); + } + + return valid; + }, + + /** + * Returns true if any fields in this form have changed since their original load. + * @return Boolean + */ + isDirty : function(){ + var dirty = false; + var items = this.getItems(); + items.each(function(f){ + if(f.isDirty()){ + dirty = true; + return false; + } + return true; + }); + return dirty; + }, + /** + * Performs a predefined action (submit or load) or custom actions you define on this form. + * @param {String} actionName The name of the action type + * @param {Object} options (optional) The options to pass to the action. All of the config options listed + * below are supported by both the submit and load actions unless otherwise noted (custom actions could also + * accept other config options): + * <pre> +Property Type Description +---------------- --------------- ---------------------------------------------------------------------------------- +url String The url for the action (defaults to the form's url) +method String The form method to use (defaults to the form's method, or POST if not defined) +params String/Object The params to pass (defaults to the form's baseParams, or none if not defined) +clientValidation Boolean Applies to submit only. Pass true to call form.isValid() prior to posting to + validate the form on the client (defaults to false) + * </pre> + * @return {BasicForm} this + */ + doAction : function(action, options){ + if(typeof action == 'string'){ + action = new Roo.form.Action.ACTION_TYPES[action](this, options); + } + if(this.fireEvent('beforeaction', this, action) !== false){ + this.beforeAction(action); + action.run.defer(100, action); + } + return this; + }, + + // private + beforeAction : function(action){ + var o = action.options; + + if(this.loadMask){ + + if(this.maskBody){ + Roo.get(document.body).mask(o.waitMsg || "Sending", 'x-mask-loading') + } else { + this.el.mask(o.waitMsg || "Sending", 'x-mask-loading'); + } + } + // not really supported yet.. ?? + + //if(this.waitMsgTarget === true){ + // this.el.mask(o.waitMsg || "Sending", 'x-mask-loading'); + //}else if(this.waitMsgTarget){ + // this.waitMsgTarget = Roo.get(this.waitMsgTarget); + // this.waitMsgTarget.mask(o.waitMsg || "Sending", 'x-mask-loading'); + //}else { + // Roo.MessageBox.wait(o.waitMsg || "Sending", o.waitTitle || this.waitTitle || 'Please Wait...'); + // } + + }, + + // private + afterAction : function(action, success){ + this.activeAction = null; + var o = action.options; + + if(this.loadMask){ + + if(this.maskBody){ + Roo.get(document.body).unmask(); + } else { + this.el.unmask(); + } + } + + //if(this.waitMsgTarget === true){ +// this.el.unmask(); + //}else if(this.waitMsgTarget){ + // this.waitMsgTarget.unmask(); + //}else{ + // Roo.MessageBox.updateProgress(1); + // Roo.MessageBox.hide(); + // } + // + if(success){ + if(o.reset){ + this.reset(); + } + Roo.callback(o.success, o.scope, [this, action]); + this.fireEvent('actioncomplete', this, action); + + }else{ + + // failure condition.. + // we have a scenario where updates need confirming. + // eg. if a locking scenario exists.. + // we look for { errors : { needs_confirm : true }} in the response. + if ( + (typeof(action.result) != 'undefined') && + (typeof(action.result.errors) != 'undefined') && + (typeof(action.result.errors.needs_confirm) != 'undefined') + ){ + var _t = this; + Roo.log("not supported yet"); + /* + + Roo.MessageBox.confirm( + "Change requires confirmation", + action.result.errorMsg, + function(r) { + if (r != 'yes') { + return; + } + _t.doAction('submit', { params : { _submit_confirmed : 1 } } ); + } + + ); + */ + + + return; + } + + Roo.callback(o.failure, o.scope, [this, action]); + // show an error message if no failed handler is set.. + if (!this.hasListener('actionfailed')) { + Roo.log("need to add dialog support"); + /* + Roo.MessageBox.alert("Error", + (typeof(action.result) != 'undefined' && typeof(action.result.errorMsg) != 'undefined') ? + action.result.errorMsg : + "Saving Failed, please check your entries or try again" + ); + */ + } + + this.fireEvent('actionfailed', this, action); + } + + }, + /** + * Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName + * @param {String} id The value to search for + * @return Field + */ + findField : function(id){ + var items = this.getItems(); + var field = items.get(id); + if(!field){ + items.each(function(f){ + if(f.isFormField && (f.dataIndex == id || f.id == id || f.getName() == id)){ + field = f; + return false; + } + return true; + }); + } + return field || null; + }, + /** + * Mark fields in this form invalid in bulk. + * @param {Array/Object} errors Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2} + * @return {BasicForm} this + */ + markInvalid : function(errors){ + if(errors instanceof Array){ + for(var i = 0, len = errors.length; i < len; i++){ + var fieldError = errors[i]; + var f = this.findField(fieldError.id); + if(f){ + f.markInvalid(fieldError.msg); + } + } + }else{ + var field, id; + for(id in errors){ + if(typeof errors[id] != 'function' && (field = this.findField(id))){ + field.markInvalid(errors[id]); + } + } + } + //Roo.each(this.childForms || [], function (f) { + // f.markInvalid(errors); + //}); + + return this; + }, + + /** + * Set values for fields in this form in bulk. + * @param {Array/Object} values Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2} + * @return {BasicForm} this + */ + setValues : function(values){ + if(values instanceof Array){ // array of objects + for(var i = 0, len = values.length; i < len; i++){ + var v = values[i]; + var f = this.findField(v.id); + if(f){ + f.setValue(v.value); + if(this.trackResetOnLoad){ + f.originalValue = f.getValue(); + } + } + } + }else{ // object hash + var field, id; + for(id in values){ + if(typeof values[id] != 'function' && (field = this.findField(id))){ + + if (field.setFromData && + field.valueField && + field.displayField && + // combos' with local stores can + // be queried via setValue() + // to set their value.. + (field.store && !field.store.isLocal) + ) { + // it's a combo + var sd = { }; + sd[field.valueField] = typeof(values[field.hiddenName]) == 'undefined' ? '' : values[field.hiddenName]; + sd[field.displayField] = typeof(values[field.name]) == 'undefined' ? '' : values[field.name]; + field.setFromData(sd); + + } else if(field.setFromData && (field.store && !field.store.isLocal)) { + + field.setFromData(values); + + } else { + field.setValue(values[id]); + } + + + if(this.trackResetOnLoad){ + field.originalValue = field.getValue(); + } + } + } + } + + //Roo.each(this.childForms || [], function (f) { + // f.setValues(values); + //}); + + return this; + }, + + /** + * Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name + * they are returned as an array. + * @param {Boolean} asString + * @return {Object} + */ + getValues : function(asString){ + //if (this.childForms) { + // copy values from the child forms + // Roo.each(this.childForms, function (f) { + // this.setValues(f.getValues()); + // }, this); + //} + + + + var fs = Roo.lib.Ajax.serializeForm(this.el.dom); + if(asString === true){ + return fs; + } + return Roo.urlDecode(fs); + }, + + /** + * Returns the fields in this form as an object with key/value pairs. + * This differs from getValues as it calls getValue on each child item, rather than using dom data. + * @return {Object} + */ + getFieldValues : function(with_hidden) + { + var items = this.getItems(); + var ret = {}; + items.each(function(f){ + + if (!f.getName()) { + return; + } + + var v = f.getValue(); + + if (f.inputType =='radio') { + if (typeof(ret[f.getName()]) == 'undefined') { + ret[f.getName()] = ''; // empty.. + } + + if (!f.el.dom.checked) { + return; + + } + v = f.el.dom.value; + + } + + if(f.xtype == 'MoneyField'){ + ret[f.currencyName] = f.getCurrency(); + } + + // not sure if this supported any more.. + if ((typeof(v) == 'object') && f.getRawValue) { + v = f.getRawValue() ; // dates.. + } + // combo boxes where name != hiddenName... + if (f.name !== false && f.name != '' && f.name != f.getName()) { + ret[f.name] = f.getRawValue(); + } + ret[f.getName()] = v; + }); + + return ret; + }, + + /** + * Clears all invalid messages in this form. + * @return {BasicForm} this + */ + clearInvalid : function(){ + var items = this.getItems(); + + items.each(function(f){ + f.clearInvalid(); + }); + + return this; + }, + + /** + * Resets this form. + * @return {BasicForm} this + */ + reset : function(){ + var items = this.getItems(); + items.each(function(f){ + f.reset(); + }); + + Roo.each(this.childForms || [], function (f) { + f.reset(); + }); + + + return this; + }, + + getItems : function() + { + var r=new Roo.util.MixedCollection(false, function(o){ + return o.id || (o.id = Roo.id()); + }); + var iter = function(el) { + if (el.inputEl) { + r.add(el); + } + if (!el.items) { + return; + } + Roo.each(el.items,function(e) { + iter(e); + }); + }; + + iter(this); + return r; + }, + + hideFields : function(items) + { + Roo.each(items, function(i){ + + var f = this.findField(i); + + if(!f){ + return; + } + + f.hide(); + + }, this); + }, + + showFields : function(items) + { + Roo.each(items, function(i){ + + var f = this.findField(i); + + if(!f){ + return; + } + + f.show(); + + }, this); + } + +}); + +Roo.apply(Roo.bootstrap.Form, { + + popover : { + + padding : 5, + + isApplied : false, + + isMasked : false, + + form : false, + + target : false, + + toolTip : false, + + intervalID : false, + + maskEl : false, + + apply : function() + { + if(this.isApplied){ + return; + } + + this.maskEl = { + top : Roo.DomHelper.append(Roo.get(document.body), { tag: "div", cls:"x-dlg-mask roo-form-top-mask" }, true), + left : Roo.DomHelper.append(Roo.get(document.body), { tag: "div", cls:"x-dlg-mask roo-form-left-mask" }, true), + bottom : Roo.DomHelper.append(Roo.get(document.body), { tag: "div", cls:"x-dlg-mask roo-form-bottom-mask" }, true), + right : Roo.DomHelper.append(Roo.get(document.body), { tag: "div", cls:"x-dlg-mask roo-form-right-mask" }, true) + }; + + this.maskEl.top.enableDisplayMode("block"); + this.maskEl.left.enableDisplayMode("block"); + this.maskEl.bottom.enableDisplayMode("block"); + this.maskEl.right.enableDisplayMode("block"); + + this.toolTip = new Roo.bootstrap.Tooltip({ + cls : 'roo-form-error-popover', + alignment : { + 'left' : ['r-l', [-2,0], 'right'], + 'right' : ['l-r', [2,0], 'left'], + 'bottom' : ['tl-bl', [0,2], 'top'], + 'top' : [ 'bl-tl', [0,-2], 'bottom'] + } + }); + + this.toolTip.render(Roo.get(document.body)); + + this.toolTip.el.enableDisplayMode("block"); + + Roo.get(document.body).on('click', function(){ + this.unmask(); + }, this); + + Roo.get(document.body).on('touchstart', function(){ + this.unmask(); + }, this); + + this.isApplied = true + }, + + mask : function(form, target) + { + this.form = form; + + this.target = target; + + if(!this.form.errorMask || !target.el){ + return; + } + + var scrollable = this.target.el.findScrollableParent() || this.target.el.findParent('div.modal', 100, true) || Roo.get(document.body); + + Roo.log(scrollable); + + var ot = this.target.el.calcOffsetsTo(scrollable); + + var scrollTo = ot[1] - this.form.maskOffset; + + scrollTo = Math.min(scrollTo, scrollable.dom.scrollHeight); + + scrollable.scrollTo('top', scrollTo); + + var box = this.target.el.getBox(); + Roo.log(box); + var zIndex = Roo.bootstrap.Modal.zIndex++; + + + this.maskEl.top.setStyle('position', 'absolute'); + this.maskEl.top.setStyle('z-index', zIndex); + this.maskEl.top.setSize(Roo.lib.Dom.getDocumentWidth(), box.y - this.padding); + this.maskEl.top.setLeft(0); + this.maskEl.top.setTop(0); + this.maskEl.top.show(); + + this.maskEl.left.setStyle('position', 'absolute'); + this.maskEl.left.setStyle('z-index', zIndex); + this.maskEl.left.setSize(box.x - this.padding, box.height + this.padding * 2); + this.maskEl.left.setLeft(0); + this.maskEl.left.setTop(box.y - this.padding); + this.maskEl.left.show(); + + this.maskEl.bottom.setStyle('position', 'absolute'); + this.maskEl.bottom.setStyle('z-index', zIndex); + this.maskEl.bottom.setSize(Roo.lib.Dom.getDocumentWidth(), Roo.lib.Dom.getDocumentHeight() - box.bottom - this.padding); + this.maskEl.bottom.setLeft(0); + this.maskEl.bottom.setTop(box.bottom + this.padding); + this.maskEl.bottom.show(); + + this.maskEl.right.setStyle('position', 'absolute'); + this.maskEl.right.setStyle('z-index', zIndex); + this.maskEl.right.setSize(Roo.lib.Dom.getDocumentWidth() - box.right - this.padding, box.height + this.padding * 2); + this.maskEl.right.setLeft(box.right + this.padding); + this.maskEl.right.setTop(box.y - this.padding); + this.maskEl.right.show(); + + this.toolTip.bindEl = this.target.el; + + this.toolTip.el.setStyle('z-index', Roo.bootstrap.Modal.zIndex++); + + var tip = this.target.blankText; + + if(this.target.getValue() !== '' ) { + + if (this.target.invalidText.length) { + tip = this.target.invalidText; + } else if (this.target.regexText.length){ + tip = this.target.regexText; + } + } + + this.toolTip.show(tip); + + this.intervalID = window.setInterval(function() { + Roo.bootstrap.Form.popover.unmask(); + }, 10000); + + window.onwheel = function(){ return false;}; + + (function(){ this.isMasked = true; }).defer(500, this); + + }, + + unmask : function() + { + if(!this.isApplied || !this.isMasked || !this.form || !this.target || !this.form.errorMask){ + return; + } + + this.maskEl.top.setStyle('position', 'absolute'); + this.maskEl.top.setSize(0, 0).setXY([0, 0]); + this.maskEl.top.hide(); + + this.maskEl.left.setStyle('position', 'absolute'); + this.maskEl.left.setSize(0, 0).setXY([0, 0]); + this.maskEl.left.hide(); + + this.maskEl.bottom.setStyle('position', 'absolute'); + this.maskEl.bottom.setSize(0, 0).setXY([0, 0]); + this.maskEl.bottom.hide(); + + this.maskEl.right.setStyle('position', 'absolute'); + this.maskEl.right.setSize(0, 0).setXY([0, 0]); + this.maskEl.right.hide(); + + this.toolTip.hide(); + + this.toolTip.el.hide(); + + window.onwheel = function(){ return true;}; + + if(this.intervalID){ + window.clearInterval(this.intervalID); + this.intervalID = false; + } + + this.isMasked = false; + + } + + } + +}); + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Graph.js.html b/docs2/src/Roo_bootstrap_Graph.js.html new file mode 100644 index 0000000000..c557838f79 --- /dev/null +++ b/docs2/src/Roo_bootstrap_Graph.js.html @@ -0,0 +1,214 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Graph.js /* + * - LGPL + * + * Graph + * + */ + + +/** + * @class Roo.bootstrap.Graph + * @extends Roo.bootstrap.Component + * Bootstrap Graph class +> Prameters + -sm {number} sm 4 + -md {number} md 5 + @cfg {String} graphtype bar | vbar | pie + @cfg {number} g_x coodinator | centre x (pie) + @cfg {number} g_y coodinator | centre y (pie) + @cfg {number} g_r radius (pie) + @cfg {number} g_height height of the chart (respected by all elements in the set) + @cfg {number} g_width width of the chart (respected by all elements in the set) + @cfg {Object} title The title of the chart + + -{Array} values + -opts (object) options for the chart + o { + o type (string) type of endings of the bar. Default: 'square'. Other options are: 'round', 'sharp', 'soft'. + o gutter (number)(string) default '20%' (WHAT DOES IT DO?) + o vgutter (number) + o colors (array) colors be used repeatedly to plot the bars. If multicolumn bar is used each sequence of bars with use a different color. + o stacked (boolean) whether or not to tread values as in a stacked bar chart + o to + o stretch (boolean) + o } + -opts (object) options for the pie + o{ + o cut + o startAngle (number) + o endAngle (number) + } + * + * @constructor + * Create a new Input + * @param {Object} config The config object + */ + +Roo.bootstrap.Graph = function(config){ + Roo.bootstrap.Graph.superclass.constructor.call(this, config); + + this.addEvents({ + // img events + /** + * @event click + * The img click event for the img. + * @param {Roo.EventObject} e + */ + "click" : true + }); +}; + +Roo.extend(Roo.bootstrap.Graph, Roo.bootstrap.Component, { + + sm: 4, + md: 5, + graphtype: 'bar', + g_height: 250, + g_width: 400, + g_x: 50, + g_y: 50, + g_r: 30, + opts:{ + //g_colors: this.colors, + g_type: 'soft', + g_gutter: '20%' + + }, + title : false, + + getAutoCreate : function(){ + + var cfg = { + tag: 'div', + html : null + }; + + + return cfg; + }, + + onRender : function(ct,position){ + + + Roo.bootstrap.Graph.superclass.onRender.call(this,ct,position); + + if (typeof(Raphael) == 'undefined') { + Roo.bootstrap.MessageBox.alert("Error","Raphael is not availabe"); + return; + } + + this.raphael = Raphael(this.el.dom); + + // data1 = [[55, 20, 13, 32, 5, 1, 2, 10], [10, 2, 1, 5, 32, 13, 20, 55], [12, 20, 30]], + // data2 = [[55, 20, 13, 32, 5, 1, 2, 10], [10, 2, 1, 5, 32, 13, 20, 55], [12, 20, 30]], + // data3 = [[55, 20, 13, 32, 5, 1, 2, 10], [10, 2, 1, 5, 32, 13, 20, 55], [12, 20, 30]], + // txtattr = { font: "12px 'Fontin Sans', Fontin-Sans, sans-serif" }; + /* + r.text(160, 10, "Single Series Chart").attr(txtattr); + r.text(480, 10, "Multiline Series Chart").attr(txtattr); + r.text(160, 250, "Multiple Series Stacked Chart").attr(txtattr); + r.text(480, 250, 'Multiline Series Stacked Vertical Chart. Type "round"').attr(txtattr); + + r.barchart(10, 10, 300, 220, [[55, 20, 13, 32, 5, 1, 2, 10]], 0, {type: "sharp"}); + r.barchart(330, 10, 300, 220, data1); + r.barchart(10, 250, 300, 220, data2, {stacked: true}); + r.barchart(330, 250, 300, 220, data3, {stacked: true, type: "round"}); + */ + + // var xdata = [55, 20, 13, 32, 5, 1, 2, 10,5 , 10]; + // r.barchart(30, 30, 560, 250, xdata, { + // labels : [55, 20, 13, 32, 5, 1, 2, 10,5 , 10], + // axis : "0 0 1 1", + // axisxlabels : xdata + // //yvalues : cols, + + // }); +// var xdata = [55, 20, 13, 32, 5, 1, 2, 10,5 , 10]; +// +// this.load(null,xdata,{ +// axis : "0 0 1 1", +// axisxlabels : xdata +// }); + + }, + + load : function(graphtype,xdata,opts) + { + this.raphael.clear(); + if(!graphtype) { + graphtype = this.graphtype; + } + if(!opts){ + opts = this.opts; + } + var r = this.raphael, + fin = function () { + this.flag = r.popup(this.bar.x, this.bar.y, this.bar.value || "0").insertBefore(this); + }, + fout = function () { + this.flag.animate({opacity: 0}, 300, function () {this.remove();}); + }, + pfin = function() { + this.sector.stop(); + this.sector.scale(1.1, 1.1, this.cx, this.cy); + + if (this.label) { + this.label[0].stop(); + this.label[0].attr({ r: 7.5 }); + this.label[1].attr({ "font-weight": 800 }); + } + }, + pfout = function() { + this.sector.animate({ transform: 's1 1 ' + this.cx + ' ' + this.cy }, 500, "bounce"); + + if (this.label) { + this.label[0].animate({ r: 5 }, 500, "bounce"); + this.label[1].attr({ "font-weight": 400 }); + } + }; + + switch(graphtype){ + case 'bar': + this.raphael.barchart(this.g_x,this.g_y,this.g_width,this.g_height,xdata,opts).hover(fin,fout); + break; + case 'hbar': + this.raphael.hbarchart(this.g_x,this.g_y,this.g_width,this.g_height,xdata,opts).hover(fin,fout); + break; + case 'pie': +// opts = { legend: ["%% - Enterprise Users", "% - ddd","Chrome Users"], legendpos: "west", +// href: ["http://raphaeljs.com", "http://g.raphaeljs.com"]}; +// + this.raphael.piechart(this.g_x,this.g_y,this.g_r,xdata,opts).hover(pfin, pfout); + + break; + + } + + if(this.title){ + this.raphael.text(this.title.x, this.title.y, this.title.text).attr(this.title.attr); + } + + }, + + setTitle: function(o) + { + this.title = o; + }, + + initEvents: function() { + + if(!this.href){ + this.el.on('click', this.onClick, this); + } + }, + + onClick : function(e) + { + Roo.log('img onclick'); + this.fireEvent('click', this, e); + } + +}); + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Header.js.html b/docs2/src/Roo_bootstrap_Header.js.html new file mode 100644 index 0000000000..4089d80db4 --- /dev/null +++ b/docs2/src/Roo_bootstrap_Header.js.html @@ -0,0 +1,49 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Header.js/* + * - LGPL + * + * header + * + */ + +/** + * @class Roo.bootstrap.Header + * @extends Roo.bootstrap.Component + * Bootstrap Header class + * @cfg {String} html content of header + * @cfg {Number} level (1|2|3|4|5|6) default 1 + * + * @constructor + * Create a new Header + * @param {Object} config The config object + */ + + +Roo.bootstrap.Header = function(config){ + Roo.bootstrap.Header.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.Header, Roo.bootstrap.Component, { + + //href : false, + html : false, + level : 1, + + + + getAutoCreate : function(){ + + + + var cfg = { + tag: 'h' + (1 *this.level), + html: this.html || '' + } ; + + return cfg; + } + +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_HtmlEditor.js.html b/docs2/src/Roo_bootstrap_HtmlEditor.js.html new file mode 100644 index 0000000000..736eb1e4a5 --- /dev/null +++ b/docs2/src/Roo_bootstrap_HtmlEditor.js.html @@ -0,0 +1,435 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/HtmlEditor.js/* + * - LGPL + * + * HtmlEditor + * + */ + +/** + * @class Roo.bootstrap.HtmlEditor + * @extends Roo.bootstrap.TextArea + * Bootstrap HtmlEditor class + + * @constructor + * Create a new HtmlEditor + * @param {Object} config The config object + */ + +Roo.bootstrap.HtmlEditor = function(config){ + Roo.bootstrap.HtmlEditor.superclass.constructor.call(this, config); + if (!this.toolbars) { + this.toolbars = []; + } + + this.editorcore = new Roo.HtmlEditorCore(Roo.apply({ owner : this} , config)); + this.addEvents({ + /** + * @event initialize + * Fires when the editor is fully initialized (including the iframe) + * @param {HtmlEditor} this + */ + initialize: true, + /** + * @event activate + * Fires when the editor is first receives the focus. Any insertion must wait + * until after this event. + * @param {HtmlEditor} this + */ + activate: true, + /** + * @event beforesync + * Fires before the textarea is updated with content from the editor iframe. Return false + * to cancel the sync. + * @param {HtmlEditor} this + * @param {String} html + */ + beforesync: true, + /** + * @event beforepush + * Fires before the iframe editor is updated with content from the textarea. Return false + * to cancel the push. + * @param {HtmlEditor} this + * @param {String} html + */ + beforepush: true, + /** + * @event sync + * Fires when the textarea is updated with content from the editor iframe. + * @param {HtmlEditor} this + * @param {String} html + */ + sync: true, + /** + * @event push + * Fires when the iframe editor is updated with content from the textarea. + * @param {HtmlEditor} this + * @param {String} html + */ + push: true, + /** + * @event editmodechange + * Fires when the editor switches edit modes + * @param {HtmlEditor} this + * @param {Boolean} sourceEdit True if source edit, false if standard editing. + */ + editmodechange: true, + /** + * @event editorevent + * Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks. + * @param {HtmlEditor} this + */ + editorevent: true, + /** + * @event firstfocus + * Fires when on first focus - needed by toolbars.. + * @param {HtmlEditor} this + */ + firstfocus: true, + /** + * @event autosave + * Auto save the htmlEditor value as a file into Events + * @param {HtmlEditor} this + */ + autosave: true, + /** + * @event savedpreview + * preview the saved version of htmlEditor + * @param {HtmlEditor} this + */ + savedpreview: true + }); +}; + + +Roo.extend(Roo.bootstrap.HtmlEditor, Roo.bootstrap.TextArea, { + + + /** + * @cfg {Array} toolbars Array of toolbars. - defaults to just the Standard one + */ + toolbars : false, + + /** + * @cfg {Array} buttons Array of toolbar's buttons. - defaults to empty + */ + btns : [], + + /** + * @cfg {String} resizable 's' or 'se' or 'e' - wrapps the element in a + * Roo.resizable. + */ + resizable : false, + /** + * @cfg {Number} height (in pixels) + */ + height: 300, + /** + * @cfg {Number} width (in pixels) + */ + width: false, + + /** + * @cfg {Array} stylesheets url of stylesheets. set to [] to disable stylesheets. + * + */ + stylesheets: false, + + // id of frame.. + frameId: false, + + // private properties + validationEvent : false, + deferHeight: true, + initialized : false, + activated : false, + + onFocus : Roo.emptyFn, + iframePad:3, + hideMode:'offsets', + + tbContainer : false, + + bodyCls : '', + + toolbarContainer :function() { + return this.wrap.select('.x-html-editor-tb',true).first(); + }, + + /** + * Protected method that will not generally be called directly. It + * is called when the editor creates its toolbar. Override this method if you need to + * add custom toolbar buttons. + * @param {HtmlEditor} editor + */ + createToolbar : function(){ + Roo.log('renewing'); + Roo.log("create toolbars"); + + this.toolbars = [ new Roo.bootstrap.htmleditor.ToolbarStandard({editor: this} ) ]; + this.toolbars[0].render(this.toolbarContainer()); + + return; + +// if (!editor.toolbars || !editor.toolbars.length) { +// editor.toolbars = [ new Roo.bootstrap.HtmlEditor.ToolbarStandard() ]; // can be empty? +// } +// +// for (var i =0 ; i < editor.toolbars.length;i++) { +// editor.toolbars[i] = Roo.factory( +// typeof(editor.toolbars[i]) == 'string' ? +// { xtype: editor.toolbars[i]} : editor.toolbars[i], +// Roo.bootstrap.HtmlEditor); +// editor.toolbars[i].init(editor); +// } + }, + + + // private + onRender : function(ct, position) + { + // Roo.log("Call onRender: " + this.xtype); + var _t = this; + Roo.bootstrap.HtmlEditor.superclass.onRender.call(this, ct, position); + + this.wrap = this.inputEl().wrap({ + cls:'x-html-editor-wrap', cn:{cls:'x-html-editor-tb'} + }); + + this.editorcore.onRender(ct, position); + + if (this.resizable) { + this.resizeEl = new Roo.Resizable(this.wrap, { + pinned : true, + wrap: true, + dynamic : true, + minHeight : this.height, + height: this.height, + handles : this.resizable, + width: this.width, + listeners : { + resize : function(r, w, h) { + _t.onResize(w,h); // -something + } + } + }); + + } + this.createToolbar(this); + + + if(!this.width && this.resizable){ + this.setSize(this.wrap.getSize()); + } + if (this.resizeEl) { + this.resizeEl.resizeTo.defer(100, this.resizeEl,[ this.width,this.height ] ); + // should trigger onReize.. + } + + }, + + // private + onResize : function(w, h) + { + Roo.log('resize: ' +w + ',' + h ); + Roo.bootstrap.HtmlEditor.superclass.onResize.apply(this, arguments); + var ew = false; + var eh = false; + + if(this.inputEl() ){ + if(typeof w == 'number'){ + var aw = w - this.wrap.getFrameWidth('lr'); + this.inputEl().setWidth(this.adjustWidth('textarea', aw)); + ew = aw; + } + if(typeof h == 'number'){ + var tbh = -11; // fixme it needs to tool bar size! + for (var i =0; i < this.toolbars.length;i++) { + // fixme - ask toolbars for heights? + tbh += this.toolbars[i].el.getHeight(); + //if (this.toolbars[i].footer) { + // tbh += this.toolbars[i].footer.el.getHeight(); + //} + } + + + + + + var ah = h - this.wrap.getFrameWidth('tb') - tbh;// this.tb.el.getHeight(); + ah -= 5; // knock a few pixes off for look.. + this.inputEl().setHeight(this.adjustWidth('textarea', ah)); + var eh = ah; + } + } + Roo.log('onResize:' + [w,h,ew,eh].join(',') ); + this.editorcore.onResize(ew,eh); + + }, + + /** + * Toggles the editor between standard and source edit mode. + * @param {Boolean} sourceEdit (optional) True for source edit, false for standard + */ + toggleSourceEdit : function(sourceEditMode) + { + this.editorcore.toggleSourceEdit(sourceEditMode); + + if(this.editorcore.sourceEditMode){ + Roo.log('editor - showing textarea'); + +// Roo.log('in'); +// Roo.log(this.syncValue()); + this.syncValue(); + this.inputEl().removeClass(['hide', 'x-hidden']); + this.inputEl().dom.removeAttribute('tabIndex'); + this.inputEl().focus(); + }else{ + Roo.log('editor - hiding textarea'); +// Roo.log('out') +// Roo.log(this.pushValue()); + this.pushValue(); + + this.inputEl().addClass(['hide', 'x-hidden']); + this.inputEl().dom.setAttribute('tabIndex', -1); + //this.deferFocus(); + } + + if(this.resizable){ + this.setSize(this.wrap.getSize()); + } + + this.fireEvent('editmodechange', this, this.editorcore.sourceEditMode); + }, + + // private (for BoxComponent) + adjustSize : Roo.BoxComponent.prototype.adjustSize, + + // private (for BoxComponent) + getResizeEl : function(){ + return this.wrap; + }, + + // private (for BoxComponent) + getPositionEl : function(){ + return this.wrap; + }, + + // private + initEvents : function(){ + this.originalValue = this.getValue(); + }, + +// /** +// * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide +// * @method +// */ +// markInvalid : Roo.emptyFn, +// /** +// * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide +// * @method +// */ +// clearInvalid : Roo.emptyFn, + + setValue : function(v){ + Roo.bootstrap.HtmlEditor.superclass.setValue.call(this, v); + this.editorcore.pushValue(); + }, + + + // private + deferFocus : function(){ + this.focus.defer(10, this); + }, + + // doc'ed in Field + focus : function(){ + this.editorcore.focus(); + + }, + + + // private + onDestroy : function(){ + + + + if(this.rendered){ + + for (var i =0; i < this.toolbars.length;i++) { + // fixme - ask toolbars for heights? + this.toolbars[i].onDestroy(); + } + + this.wrap.dom.innerHTML = ''; + this.wrap.remove(); + } + }, + + // private + onFirstFocus : function(){ + //Roo.log("onFirstFocus"); + this.editorcore.onFirstFocus(); + for (var i =0; i < this.toolbars.length;i++) { + this.toolbars[i].onFirstFocus(); + } + + }, + + // private + syncValue : function() + { + this.editorcore.syncValue(); + }, + + pushValue : function() + { + this.editorcore.pushValue(); + } + + + // hide stuff that is not compatible + /** + * @event blur + * @hide + */ + /** + * @event change + * @hide + */ + /** + * @event focus + * @hide + */ + /** + * @event specialkey + * @hide + */ + /** + * @cfg {String} fieldClass @hide + */ + /** + * @cfg {String} focusClass @hide + */ + /** + * @cfg {String} autoCreate @hide + */ + /** + * @cfg {String} inputType @hide + */ + + /** + * @cfg {String} invalidText @hide + */ + /** + * @cfg {String} msgFx @hide + */ + /** + * @cfg {String} validateOnBlur @hide + */ +}); + + + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Img.js.html b/docs2/src/Roo_bootstrap_Img.js.html new file mode 100644 index 0000000000..7de1efd40f --- /dev/null +++ b/docs2/src/Roo_bootstrap_Img.js.html @@ -0,0 +1,193 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Img.js/* + * - LGPL + * + * image + * + */ + + +/** + * @class Roo.bootstrap.Img + * @extends Roo.bootstrap.Component + * Bootstrap Img class + * @cfg {Boolean} imgResponsive false | true + * @cfg {String} border rounded | circle | thumbnail + * @cfg {String} src image source + * @cfg {String} alt image alternative text + * @cfg {String} href a tag href + * @cfg {String} target (_self|_blank|_parent|_top)target for a href. + * @cfg {String} xsUrl xs image source + * @cfg {String} smUrl sm image source + * @cfg {String} mdUrl md image source + * @cfg {String} lgUrl lg image source + * + * @constructor + * Create a new Input + * @param {Object} config The config object + */ + +Roo.bootstrap.Img = function(config){ + Roo.bootstrap.Img.superclass.constructor.call(this, config); + + this.addEvents({ + // img events + /** + * @event click + * The img click event for the img. + * @param {Roo.EventObject} e + */ + "click" : true + }); +}; + +Roo.extend(Roo.bootstrap.Img, Roo.bootstrap.Component, { + + imgResponsive: true, + border: '', + src: 'about:blank', + href: false, + target: false, + xsUrl: '', + smUrl: '', + mdUrl: '', + lgUrl: '', + + getAutoCreate : function() + { + if(this.src || (!this.xsUrl && !this.smUrl && !this.mdUrl && !this.lgUrl)){ + return this.createSingleImg(); + } + + var cfg = { + tag: 'div', + cls: 'roo-image-responsive-group', + cn: [] + }; + var _this = this; + + Roo.each(['xs', 'sm', 'md', 'lg'], function(size){ + + if(!_this[size + 'Url']){ + return; + } + + var img = { + tag: 'img', + cls: (_this.imgResponsive) ? 'img-responsive' : '', + html: _this.html || cfg.html, + src: _this[size + 'Url'] + }; + + img.cls += ' roo-image-responsive-' + size; + + var s = ['xs', 'sm', 'md', 'lg']; + + s.splice(s.indexOf(size), 1); + + Roo.each(s, function(ss){ + img.cls += ' hidden-' + ss; + }); + + if (['rounded','circle','thumbnail'].indexOf(_this.border)>-1) { + cfg.cls += ' img-' + _this.border; + } + + if(_this.alt){ + cfg.alt = _this.alt; + } + + if(_this.href){ + var a = { + tag: 'a', + href: _this.href, + cn: [ + img + ] + }; + + if(this.target){ + a.target = _this.target; + } + } + + cfg.cn.push((_this.href) ? a : img); + + }); + + return cfg; + }, + + createSingleImg : function() + { + var cfg = { + tag: 'img', + cls: (this.imgResponsive) ? 'img-responsive' : '', + html : null, + src : 'about:blank' // just incase src get's set to undefined?!? + }; + + cfg.html = this.html || cfg.html; + + cfg.src = this.src || cfg.src; + + if (['rounded','circle','thumbnail'].indexOf(this.border)>-1) { + cfg.cls += ' img-' + this.border; + } + + if(this.alt){ + cfg.alt = this.alt; + } + + if(this.href){ + var a = { + tag: 'a', + href: this.href, + cn: [ + cfg + ] + }; + + if(this.target){ + a.target = this.target; + } + + } + + return (this.href) ? a : cfg; + }, + + initEvents: function() + { + if(!this.href){ + this.el.on('click', this.onClick, this); + } + + }, + + onClick : function(e) + { + Roo.log('img onclick'); + this.fireEvent('click', this, e); + }, + /** + * Sets the url of the image - used to update it + * @param {String} url the url of the image + */ + + setSrc : function(url) + { + this.src = url; + + if(this.src || (!this.xsUrl && !this.smUrl && !this.mdUrl && !this.lgUrl)){ + this.el.dom.src = url; + return; + } + + this.el.select('img', true).first().dom.src = url; + } + + + +}); + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Input.js.html b/docs2/src/Roo_bootstrap_Input.js.html new file mode 100644 index 0000000000..7ae8210ff6 --- /dev/null +++ b/docs2/src/Roo_bootstrap_Input.js.html @@ -0,0 +1,1093 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Input.js/* + * - LGPL + * + * Input + * + */ + +/** + * @class Roo.bootstrap.Input + * @extends Roo.bootstrap.Component + * Bootstrap Input class + * @cfg {Boolean} disabled is it disabled + * @cfg {String} inputType button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text + * @cfg {String} name name of the input + * @cfg {string} fieldLabel - the label associated + * @cfg {string} placeholder - placeholder to put in text. + * @cfg {string} before - input group add on before + * @cfg {string} after - input group add on after + * @cfg {string} size - (lg|sm) or leave empty.. + * @cfg {Number} xs colspan out of 12 for mobile-sized screens + * @cfg {Number} sm colspan out of 12 for tablet-sized screens + * @cfg {Number} md colspan out of 12 for computer-sized screens + * @cfg {Number} lg colspan out of 12 for large computer-sized screens + * @cfg {string} value default value of the input + * @cfg {Number} labelWidth set the width of label + * @cfg {Number} labellg set the width of label (1-12) + * @cfg {Number} labelmd set the width of label (1-12) + * @cfg {Number} labelsm set the width of label (1-12) + * @cfg {Number} labelxs set the width of label (1-12) + * @cfg {String} labelAlign (top|left) + * @cfg {Boolean} readOnly Specifies that the field should be read-only + * @cfg {String} autocomplete - default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en + * @cfg {String} indicatorpos (left|right) default left + * @cfg {String} capture (user|camera) use for file input only. (default empty) + * @cfg {String} accept (image|video|audio) use for file input only. (default empty) + + * @cfg {String} align (left|center|right) Default left + * @cfg {Boolean} forceFeedback (true|false) Default false + * + * @constructor + * Create a new Input + * @param {Object} config The config object + */ + +Roo.bootstrap.Input = function(config){ + + Roo.bootstrap.Input.superclass.constructor.call(this, config); + + this.addEvents({ + /** + * @event focus + * Fires when this field receives input focus. + * @param {Roo.form.Field} this + */ + focus : true, + /** + * @event blur + * Fires when this field loses input focus. + * @param {Roo.form.Field} this + */ + blur : true, + /** + * @event specialkey + * Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check + * {@link Roo.EventObject#getKey} to determine which key was pressed. + * @param {Roo.form.Field} this + * @param {Roo.EventObject} e The event object + */ + specialkey : true, + /** + * @event change + * Fires just before the field blurs if the field value has changed. + * @param {Roo.form.Field} this + * @param {Mixed} newValue The new value + * @param {Mixed} oldValue The original value + */ + change : true, + /** + * @event invalid + * Fires after the field has been marked as invalid. + * @param {Roo.form.Field} this + * @param {String} msg The validation message + */ + invalid : true, + /** + * @event valid + * Fires after the field has been validated with no errors. + * @param {Roo.form.Field} this + */ + valid : true, + /** + * @event keyup + * Fires after the key up + * @param {Roo.form.Field} this + * @param {Roo.EventObject} e The event Object + */ + keyup : true + }); +}; + +Roo.extend(Roo.bootstrap.Input, Roo.bootstrap.Component, { + /** + * @cfg {String/Boolean} validationEvent The event that should initiate field validation. Set to false to disable + automatic validation (defaults to "keyup"). + */ + validationEvent : "keyup", + /** + * @cfg {Boolean} validateOnBlur Whether the field should validate when it loses focus (defaults to true). + */ + validateOnBlur : true, + /** + * @cfg {Number} validationDelay The length of time in milliseconds after user input begins until validation is initiated (defaults to 250) + */ + validationDelay : 250, + /** + * @cfg {String} focusClass The CSS class to use when the field receives focus (defaults to "x-form-focus") + */ + focusClass : "x-form-focus", // not needed??? + + + /** + * @cfg {String} invalidClass DEPRICATED - code uses BS4 - is-valid / is-invalid + */ + invalidClass : "has-warning", + + /** + * @cfg {String} validClass DEPRICATED - code uses BS4 - is-valid / is-invalid + */ + validClass : "has-success", + + /** + * @cfg {Boolean} hasFeedback (true|false) default true + */ + hasFeedback : true, + + /** + * @cfg {String} invalidFeedbackIcon The CSS class to use when create feedback icon (defaults to "x-form-invalid") + */ + invalidFeedbackClass : "glyphicon-warning-sign", + + /** + * @cfg {String} validFeedbackIcon The CSS class to use when create feedback icon (defaults to "x-form-invalid") + */ + validFeedbackClass : "glyphicon-ok", + + /** + * @cfg {Boolean} selectOnFocus True to automatically select any existing field text when the field receives input focus (defaults to false) + */ + selectOnFocus : false, + + /** + * @cfg {String} maskRe An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null) + */ + maskRe : null, + /** + * @cfg {String} vtype A validation type name as defined in {@link Roo.form.VTypes} (defaults to null) + */ + vtype : null, + + /** + * @cfg {Boolean} disableKeyFilter True to disable input keystroke filtering (defaults to false) + */ + disableKeyFilter : false, + + /** + * @cfg {Boolean} disabled True to disable the field (defaults to false). + */ + disabled : false, + /** + * @cfg {Boolean} allowBlank False to validate that the value length > 0 (defaults to true) + */ + allowBlank : true, + /** + * @cfg {String} blankText Error text to display if the allow blank validation fails (defaults to "This field is required") + */ + blankText : "Please complete this mandatory field", + + /** + * @cfg {Number} minLength Minimum input field length required (defaults to 0) + */ + minLength : 0, + /** + * @cfg {Number} maxLength Maximum input field length allowed (defaults to Number.MAX_VALUE) + */ + maxLength : Number.MAX_VALUE, + /** + * @cfg {String} minLengthText Error text to display if the minimum length validation fails (defaults to "The minimum length for this field is {minLength}") + */ + minLengthText : "The minimum length for this field is {0}", + /** + * @cfg {String} maxLengthText Error text to display if the maximum length validation fails (defaults to "The maximum length for this field is {maxLength}") + */ + maxLengthText : "The maximum length for this field is {0}", + + + /** + * @cfg {Function} validator A custom validation function to be called during field validation (defaults to null). + * If available, this function will be called only after the basic validators all return true, and will be passed the + * current field value and expected to return boolean true if the value is valid or a string error message if invalid. + */ + validator : null, + /** + * @cfg {RegExp} regex A JavaScript RegExp object to be tested against the field value during validation (defaults to null). + * If available, this regex will be evaluated only after the basic validators all return true, and will be passed the + * current field value. If the test fails, the field will be marked invalid using {@link #regexText}. + */ + regex : null, + /** + * @cfg {String} regexText -- Depricated - use Invalid Text + */ + regexText : "", + + /** + * @cfg {String} invalidText The error text to display if {@link #validator} test fails during validation (defaults to "") + */ + invalidText : "", + + + + autocomplete: false, + + + fieldLabel : '', + inputType : 'text', + + name : false, + placeholder: false, + before : false, + after : false, + size : false, + hasFocus : false, + preventMark: false, + isFormField : true, + value : '', + labelWidth : 2, + labelAlign : false, + readOnly : false, + align : false, + formatedValue : false, + forceFeedback : false, + + indicatorpos : 'left', + + labellg : 0, + labelmd : 0, + labelsm : 0, + labelxs : 0, + + capture : '', + accept : '', + + parentLabelAlign : function() + { + var parent = this; + while (parent.parent()) { + parent = parent.parent(); + if (typeof(parent.labelAlign) !='undefined') { + return parent.labelAlign; + } + } + return 'left'; + + }, + + getAutoCreate : function() + { + var align = (!this.labelAlign) ? this.parentLabelAlign() : this.labelAlign; + + var id = Roo.id(); + + var cfg = {}; + + if(this.inputType != 'hidden'){ + cfg.cls = 'form-group' //input-group + } + + var input = { + tag: 'input', + id : id, + type : this.inputType, + value : this.value, + cls : 'form-control', + placeholder : this.placeholder || '', + autocomplete : this.autocomplete || 'new-password' + }; + + if(this.capture.length){ + input.capture = this.capture; + } + + if(this.accept.length){ + input.accept = this.accept + "/*"; + } + + if(this.align){ + input.style = (typeof(input.style) == 'undefined') ? ('text-align:' + this.align) : (input.style + 'text-align:' + this.align); + } + + if(this.maxLength && this.maxLength != Number.MAX_VALUE){ + input.maxLength = this.maxLength; + } + + if (this.disabled) { + input.disabled=true; + } + + if (this.readOnly) { + input.readonly=true; + } + + if (this.name) { + input.name = this.name; + } + + if (this.size) { + input.cls += ' input-' + this.size; + } + + var settings=this; + ['xs','sm','md','lg'].map(function(size){ + if (settings[size]) { + cfg.cls += ' col-' + size + '-' + settings[size]; + } + }); + + var inputblock = input; + + var feedback = { + tag: 'span', + cls: 'glyphicon form-control-feedback' + }; + + if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank){ + + inputblock = { + cls : 'has-feedback', + cn : [ + input, + feedback + ] + }; + } + + if (this.before || this.after) { + + inputblock = { + cls : 'input-group', + cn : [] + }; + + if (this.before && typeof(this.before) == 'string') { + + inputblock.cn.push({ + tag :'span', + cls : 'roo-input-before input-group-addon input-group-prepend input-group-text', + html : this.before + }); + } + if (this.before && typeof(this.before) == 'object') { + this.before = Roo.factory(this.before); + + inputblock.cn.push({ + tag :'span', + cls : 'roo-input-before input-group-prepend input-group-text input-group-' + + (this.before.xtype == 'Button' ? 'btn' : 'addon') //?? what about checkboxes - that looks like a bit of a hack thought? + }); + } + + inputblock.cn.push(input); + + if (this.after && typeof(this.after) == 'string') { + inputblock.cn.push({ + tag :'span', + cls : 'roo-input-after input-group-append input-group-text input-group-addon', + html : this.after + }); + } + if (this.after && typeof(this.after) == 'object') { + this.after = Roo.factory(this.after); + + inputblock.cn.push({ + tag :'span', + cls : 'roo-input-after input-group-append input-group-text input-group-' + + (this.after.xtype == 'Button' ? 'btn' : 'addon') //?? what about checkboxes - that looks like a bit of a hack thought? + }); + } + + if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank){ + inputblock.cls += ' has-feedback'; + inputblock.cn.push(feedback); + } + }; + var indicator = { + tag : 'i', + cls : 'roo-required-indicator ' + (this.indicatorpos == 'right' ? 'right' : 'left') +'-indicator text-danger fa fa-lg fa-star', + tooltip : 'This field is required' + }; + if (Roo.bootstrap.version == 4) { + indicator = { + tag : 'i', + style : 'display-none' + }; + } + if (align ==='left' && this.fieldLabel.length) { + + cfg.cls += ' roo-form-group-label-left' + (Roo.bootstrap.version == 4 ? ' row' : ''); + + cfg.cn = [ + indicator, + { + tag: 'label', + 'for' : id, + cls : 'control-label col-form-label', + html : this.fieldLabel + + }, + { + cls : "", + cn: [ + inputblock + ] + } + ]; + + var labelCfg = cfg.cn[1]; + var contentCfg = cfg.cn[2]; + + if(this.indicatorpos == 'right'){ + cfg.cn = [ + { + tag: 'label', + 'for' : id, + cls : 'control-label col-form-label', + cn : [ + { + tag : 'span', + html : this.fieldLabel + }, + indicator + ] + }, + { + cls : "", + cn: [ + inputblock + ] + } + + ]; + + labelCfg = cfg.cn[0]; + contentCfg = cfg.cn[1]; + + } + + if(this.labelWidth > 12){ + labelCfg.style = "width: " + this.labelWidth + 'px'; + } + + if(this.labelWidth < 13 && this.labelmd == 0){ + this.labelmd = this.labelWidth; + } + + if(this.labellg > 0){ + labelCfg.cls += ' col-lg-' + this.labellg; + contentCfg.cls += ' col-lg-' + (12 - this.labellg); + } + + if(this.labelmd > 0){ + labelCfg.cls += ' col-md-' + this.labelmd; + contentCfg.cls += ' col-md-' + (12 - this.labelmd); + } + + if(this.labelsm > 0){ + labelCfg.cls += ' col-sm-' + this.labelsm; + contentCfg.cls += ' col-sm-' + (12 - this.labelsm); + } + + if(this.labelxs > 0){ + labelCfg.cls += ' col-xs-' + this.labelxs; + contentCfg.cls += ' col-xs-' + (12 - this.labelxs); + } + + + } else if ( this.fieldLabel.length) { + + cfg.cn = [ + { + tag : 'i', + cls : 'roo-required-indicator left-indicator text-danger fa fa-lg fa-star', + tooltip : 'This field is required' + }, + { + tag: 'label', + //cls : 'input-group-addon', + html : this.fieldLabel + + }, + + inputblock + + ]; + + if(this.indicatorpos == 'right'){ + + cfg.cn = [ + { + tag: 'label', + //cls : 'input-group-addon', + html : this.fieldLabel + + }, + { + tag : 'i', + cls : 'roo-required-indicator right-indicator text-danger fa fa-lg fa-star', + tooltip : 'This field is required' + }, + + inputblock + + ]; + + } + + } else { + + cfg.cn = [ + + inputblock + + ]; + + + }; + + if (this.parentType === 'Navbar' && this.parent().bar) { + cfg.cls += ' navbar-form'; + } + + if (this.parentType === 'NavGroup' && !(Roo.bootstrap.version == 4 && this.parent().form)) { + // on BS4 we do this only if not form + cfg.cls += ' navbar-form'; + cfg.tag = 'li'; + } + + return cfg; + + }, + /** + * return the real input element. + */ + inputEl: function () + { + return this.el.select('input.form-control',true).first(); + }, + + tooltipEl : function() + { + return this.inputEl(); + }, + + indicatorEl : function() + { + if (Roo.bootstrap.version == 4) { + return false; // not enabled in v4 yet. + } + + var indicator = this.el.select('i.roo-required-indicator',true).first(); + + if(!indicator){ + return false; + } + + return indicator; + + }, + + setDisabled : function(v) + { + var i = this.inputEl().dom; + if (!v) { + i.removeAttribute('disabled'); + return; + + } + i.setAttribute('disabled','true'); + }, + initEvents : function() + { + + this.inputEl().on("keydown" , this.fireKey, this); + this.inputEl().on("focus", this.onFocus, this); + this.inputEl().on("blur", this.onBlur, this); + + this.inputEl().relayEvent('keyup', this); + + this.indicator = this.indicatorEl(); + + if(this.indicator){ + this.indicator.addClass(this.indicatorpos == 'right' ? 'hidden' : 'invisible'); // changed from invisible??? - + } + + // reference to original value for reset + this.originalValue = this.getValue(); + //Roo.form.TextField.superclass.initEvents.call(this); + if(this.validationEvent == 'keyup'){ + this.validationTask = new Roo.util.DelayedTask(this.validate, this); + this.inputEl().on('keyup', this.filterValidation, this); + } + else if(this.validationEvent !== false){ + this.inputEl().on(this.validationEvent, this.validate, this, {buffer: this.validationDelay}); + } + + if(this.selectOnFocus){ + this.on("focus", this.preFocus, this); + + } + if(this.maskRe || (this.vtype && this.disableKeyFilter !== true && (this.maskRe = Roo.form.VTypes[this.vtype+'Mask']))){ + this.inputEl().on("keypress", this.filterKeys, this); + } else { + this.inputEl().relayEvent('keypress', this); + } + /* if(this.grow){ + this.el.on("keyup", this.onKeyUp, this, {buffer:50}); + this.el.on("click", this.autoSize, this); + } + */ + if(this.inputEl().is('input[type=password]') && Roo.isSafari){ + this.inputEl().on('keydown', this.SafariOnKeyDown, this); + } + + if (typeof(this.before) == 'object') { + this.before.render(this.el.select('.roo-input-before',true).first()); + } + if (typeof(this.after) == 'object') { + this.after.render(this.el.select('.roo-input-after',true).first()); + } + + this.inputEl().on('change', this.onChange, this); + + }, + filterValidation : function(e){ + if(!e.isNavKeyPress()){ + this.validationTask.delay(this.validationDelay); + } + }, + /** + * Validates the field value + * @return {Boolean} True if the value is valid, else false + */ + validate : function(){ + //if(this.disabled || this.validateValue(this.processValue(this.getRawValue()))){ + if(this.disabled || this.validateValue(this.getRawValue())){ + this.markValid(); + return true; + } + + this.markInvalid(); + return false; + }, + + + /** + * Validates a value according to the field's validation rules and marks the field as invalid + * if the validation fails + * @param {Mixed} value The value to validate + * @return {Boolean} True if the value is valid, else false + */ + validateValue : function(value) + { + if(this.getVisibilityEl().hasClass('hidden')){ + return true; + } + + if(value.length < 1) { // if it's blank + if(this.allowBlank){ + return true; + } + return false; + } + + if(value.length < this.minLength){ + return false; + } + if(value.length > this.maxLength){ + return false; + } + if(this.vtype){ + var vt = Roo.form.VTypes; + if(!vt[this.vtype](value, this)){ + return false; + } + } + if(typeof this.validator == "function"){ + var msg = this.validator(value); + if(msg !== true){ + return false; + } + if (typeof(msg) == 'string') { + this.invalidText = msg; + } + } + + if(this.regex && !this.regex.test(value)){ + return false; + } + + return true; + }, + + // private + fireKey : function(e){ + //Roo.log('field ' + e.getKey()); + if(e.isNavKeyPress()){ + this.fireEvent("specialkey", this, e); + } + }, + focus : function (selectText){ + if(this.rendered){ + this.inputEl().focus(); + if(selectText === true){ + this.inputEl().dom.select(); + } + } + return this; + } , + + onFocus : function(){ + if(!Roo.isOpera && this.focusClass){ // don't touch in Opera + // this.el.addClass(this.focusClass); + } + if(!this.hasFocus){ + this.hasFocus = true; + this.startValue = this.getValue(); + this.fireEvent("focus", this); + } + }, + + beforeBlur : Roo.emptyFn, + + + // private + onBlur : function(){ + this.beforeBlur(); + if(!Roo.isOpera && this.focusClass){ // don't touch in Opera + //this.el.removeClass(this.focusClass); + } + this.hasFocus = false; + if(this.validationEvent !== false && this.validateOnBlur && this.validationEvent != "blur"){ + this.validate(); + } + var v = this.getValue(); + if(String(v) !== String(this.startValue)){ + this.fireEvent('change', this, v, this.startValue); + } + this.fireEvent("blur", this); + }, + + onChange : function(e) + { + var v = this.getValue(); + if(String(v) !== String(this.startValue)){ + this.fireEvent('change', this, v, this.startValue); + } + + }, + + /** + * Resets the current field value to the originally loaded value and clears any validation messages + */ + reset : function(){ + this.setValue(this.originalValue); + this.validate(); + }, + /** + * Returns the name of the field + * @return {Mixed} name The name field + */ + getName: function(){ + return this.name; + }, + /** + * Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}. + * @return {Mixed} value The field value + */ + getValue : function(){ + + var v = this.inputEl().getValue(); + + return v; + }, + /** + * Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}. + * @return {Mixed} value The field value + */ + getRawValue : function(){ + var v = this.inputEl().getValue(); + + return v; + }, + + /** + * Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}. + * @param {Mixed} value The value to set + */ + setRawValue : function(v){ + return this.inputEl().dom.value = (v === null || v === undefined ? '' : v); + }, + + selectText : function(start, end){ + var v = this.getRawValue(); + if(v.length > 0){ + start = start === undefined ? 0 : start; + end = end === undefined ? v.length : end; + var d = this.inputEl().dom; + if(d.setSelectionRange){ + d.setSelectionRange(start, end); + }else if(d.createTextRange){ + var range = d.createTextRange(); + range.moveStart("character", start); + range.moveEnd("character", v.length-end); + range.select(); + } + } + }, + + /** + * Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}. + * @param {Mixed} value The value to set + */ + setValue : function(v){ + this.value = v; + if(this.rendered){ + this.inputEl().dom.value = (v === null || v === undefined ? '' : v); + this.validate(); + } + }, + + /* + processValue : function(value){ + if(this.stripCharsRe){ + var newValue = value.replace(this.stripCharsRe, ''); + if(newValue !== value){ + this.setRawValue(newValue); + return newValue; + } + } + return value; + }, + */ + preFocus : function(){ + + if(this.selectOnFocus){ + this.inputEl().dom.select(); + } + }, + filterKeys : function(e){ + var k = e.getKey(); + if(!Roo.isIE && (e.isNavKeyPress() || k == e.BACKSPACE || (k == e.DELETE && e.button == -1))){ + return; + } + var c = e.getCharCode(), cc = String.fromCharCode(c); + if(Roo.isIE && (e.isSpecialKey() || !cc)){ + return; + } + if(!this.maskRe.test(cc)){ + e.stopEvent(); + } + }, + /** + * Clear any invalid styles/messages for this field + */ + clearInvalid : function(){ + + if(!this.el || this.preventMark){ // not rendered + return; + } + + + this.el.removeClass([this.invalidClass, 'is-invalid']); + + if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank){ + + var feedback = this.el.select('.form-control-feedback', true).first(); + + if(feedback){ + this.el.select('.form-control-feedback', true).first().removeClass(this.invalidFeedbackClass); + } + + } + + if(this.indicator){ + this.indicator.removeClass('visible'); + this.indicator.addClass(this.indicatorpos == 'right' ? 'hidden' : 'invisible'); + } + + this.fireEvent('valid', this); + }, + + /** + * Mark this field as valid + */ + markValid : function() + { + if(!this.el || this.preventMark){ // not rendered... + return; + } + + this.el.removeClass([this.invalidClass, this.validClass]); + this.inputEl().removeClass(['is-valid', 'is-invalid']); + + var feedback = this.el.select('.form-control-feedback', true).first(); + + if(feedback){ + this.el.select('.form-control-feedback', true).first().removeClass([this.invalidFeedbackClass, this.validFeedbackClass]); + } + + if(this.indicator){ + this.indicator.removeClass('visible'); + this.indicator.addClass(this.indicatorpos == 'right' ? 'hidden' : 'invisible'); + } + + if(this.disabled){ + return; + } + + if(this.allowBlank && !this.getRawValue().length){ + return; + } + if (Roo.bootstrap.version == 3) { + this.el.addClass(this.validClass); + } else { + this.inputEl().addClass('is-valid'); + } + + if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank && (this.getValue().length || this.forceFeedback)){ + + var feedback = this.el.select('.form-control-feedback', true).first(); + + if(feedback){ + this.el.select('.form-control-feedback', true).first().removeClass([this.invalidFeedbackClass, this.validFeedbackClass]); + this.el.select('.form-control-feedback', true).first().addClass([this.validFeedbackClass]); + } + + } + + this.fireEvent('valid', this); + }, + + /** + * Mark this field as invalid + * @param {String} msg The validation message + */ + markInvalid : function(msg) + { + if(!this.el || this.preventMark){ // not rendered + return; + } + + this.el.removeClass([this.invalidClass, this.validClass]); + this.inputEl().removeClass(['is-valid', 'is-invalid']); + + var feedback = this.el.select('.form-control-feedback', true).first(); + + if(feedback){ + this.el.select('.form-control-feedback', true).first().removeClass( + [this.invalidFeedbackClass, this.validFeedbackClass]); + } + + if(this.disabled){ + return; + } + + if(this.allowBlank && !this.getRawValue().length){ + return; + } + + if(this.indicator){ + this.indicator.removeClass(this.indicatorpos == 'right' ? 'hidden' : 'invisible'); + this.indicator.addClass('visible'); + } + if (Roo.bootstrap.version == 3) { + this.el.addClass(this.invalidClass); + } else { + this.inputEl().addClass('is-invalid'); + } + + + + if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank){ + + var feedback = this.el.select('.form-control-feedback', true).first(); + + if(feedback){ + this.el.select('.form-control-feedback', true).first().removeClass([this.invalidFeedbackClass, this.validFeedbackClass]); + + if(this.getValue().length || this.forceFeedback){ + this.el.select('.form-control-feedback', true).first().addClass([this.invalidFeedbackClass]); + } + + } + + } + + this.fireEvent('invalid', this, msg); + }, + // private + SafariOnKeyDown : function(event) + { + // this is a workaround for a password hang bug on chrome/ webkit. + if (this.inputEl().dom.type != 'password') { + return; + } + + var isSelectAll = false; + + if(this.inputEl().dom.selectionEnd > 0){ + isSelectAll = (this.inputEl().dom.selectionEnd - this.inputEl().dom.selectionStart - this.getValue().length == 0) ? true : false; + } + if(((event.getKey() == 8 || event.getKey() == 46) && this.getValue().length ==1)){ // backspace and delete key + event.preventDefault(); + this.setValue(''); + return; + } + + if(isSelectAll && event.getCharCode() > 31 && !event.ctrlKey) { // not backspace and delete key (or ctrl-v) + + event.preventDefault(); + // this is very hacky as keydown always get's upper case. + // + var cc = String.fromCharCode(event.getCharCode()); + this.setValue( event.shiftKey ? cc : cc.toLowerCase()); + + } + }, + adjustWidth : function(tag, w){ + tag = tag.toLowerCase(); + if(typeof w == 'number' && Roo.isStrict && !Roo.isSafari){ + if(Roo.isIE && (tag == 'input' || tag == 'textarea')){ + if(tag == 'input'){ + return w + 2; + } + if(tag == 'textarea'){ + return w-2; + } + }else if(Roo.isOpera){ + if(tag == 'input'){ + return w + 2; + } + if(tag == 'textarea'){ + return w-2; + } + } + } + return w; + }, + + setFieldLabel : function(v) + { + if(!this.rendered){ + return; + } + + if(this.indicatorEl()){ + var ar = this.el.select('label > span',true); + + if (ar.elements.length) { + this.el.select('label > span',true).first().dom.innerHTML = (v === null || v === undefined ? '' : v); + this.fieldLabel = v; + return; + } + + var br = this.el.select('label',true); + + if(br.elements.length) { + this.el.select('label',true).first().dom.innerHTML = (v === null || v === undefined ? '' : v); + this.fieldLabel = v; + return; + } + + Roo.log('Cannot Found any of label > span || label in input'); + return; + } + + this.el.select('label',true).first().dom.innerHTML = (v === null || v === undefined ? '' : v); + this.fieldLabel = v; + + + } +}); + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_LayoutMasonry.js.html b/docs2/src/Roo_bootstrap_LayoutMasonry.js.html new file mode 100644 index 0000000000..8421ae0d71 --- /dev/null +++ b/docs2/src/Roo_bootstrap_LayoutMasonry.js.html @@ -0,0 +1,1333 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/LayoutMasonry.js/** + * + * This is based on + * http://masonry.desandro.com + * + * The idea is to render all the bricks based on vertical width... + * + * The original code extends 'outlayer' - we might need to use that.... + * + */ + + +/** + * @class Roo.bootstrap.LayoutMasonry + * @extends Roo.bootstrap.Component + * Bootstrap Layout Masonry class + * + * @constructor + * Create a new Element + * @param {Object} config The config object + */ + +Roo.bootstrap.LayoutMasonry = function(config){ + + Roo.bootstrap.LayoutMasonry.superclass.constructor.call(this, config); + + this.bricks = []; + + Roo.bootstrap.LayoutMasonry.register(this); + + this.addEvents({ + // raw events + /** + * @event layout + * Fire after layout the items + * @param {Roo.bootstrap.LayoutMasonry} this + * @param {Roo.EventObject} e + */ + "layout" : true + }); + +}; + +Roo.extend(Roo.bootstrap.LayoutMasonry, Roo.bootstrap.Component, { + + /** + * @cfg {Boolean} isLayoutInstant = no animation? + */ + isLayoutInstant : false, // needed? + + /** + * @cfg {Number} boxWidth width of the columns + */ + boxWidth : 450, + + /** + * @cfg {Number} boxHeight - 0 for square, or fix it at a certian height + */ + boxHeight : 0, + + /** + * @cfg {Number} padWidth padding below box.. + */ + padWidth : 10, + + /** + * @cfg {Number} gutter gutter width.. + */ + gutter : 10, + + /** + * @cfg {Number} maxCols maximum number of columns + */ + + maxCols: 0, + + /** + * @cfg {Boolean} isAutoInitial defalut true + */ + isAutoInitial : true, + + containerWidth: 0, + + /** + * @cfg {Boolean} isHorizontal defalut false + */ + isHorizontal : false, + + currentSize : null, + + tag: 'div', + + cls: '', + + bricks: null, //CompositeElement + + cols : 1, + + _isLayoutInited : false, + +// isAlternative : false, // only use for vertical layout... + + /** + * @cfg {Number} alternativePadWidth padding below box.. + */ + alternativePadWidth : 50, + + selectedBrick : [], + + getAutoCreate : function(){ + + var cfg = Roo.apply({}, Roo.bootstrap.LayoutMasonry.superclass.getAutoCreate.call(this)); + + var cfg = { + tag: this.tag, + cls: 'blog-masonary-wrapper ' + this.cls, + cn : { + cls : 'mas-boxes masonary' + } + }; + + return cfg; + }, + + getChildContainer: function( ) + { + if (this.boxesEl) { + return this.boxesEl; + } + + this.boxesEl = this.el.select('.mas-boxes').first(); + + return this.boxesEl; + }, + + + initEvents : function() + { + var _this = this; + + if(this.isAutoInitial){ + Roo.log('hook children rendered'); + this.on('childrenrendered', function() { + Roo.log('children rendered'); + _this.initial(); + } ,this); + } + }, + + initial : function() + { + this.selectedBrick = []; + + this.currentSize = this.el.getBox(true); + + Roo.EventManager.onWindowResize(this.resize, this); + + if(!this.isAutoInitial){ + this.layout(); + return; + } + + this.layout(); + + return; + //this.layout.defer(500,this); + + }, + + resize : function() + { + var cs = this.el.getBox(true); + + if ( + this.currentSize.width == cs.width && + this.currentSize.x == cs.x && + this.currentSize.height == cs.height && + this.currentSize.y == cs.y + ) { + Roo.log("no change in with or X or Y"); + return; + } + + this.currentSize = cs; + + this.layout(); + + }, + + layout : function() + { + this._resetLayout(); + + var isInstant = this.isLayoutInstant !== undefined ? this.isLayoutInstant : !this._isLayoutInited; + + this.layoutItems( isInstant ); + + this._isLayoutInited = true; + + this.fireEvent('layout', this); + + }, + + _resetLayout : function() + { + if(this.isHorizontal){ + this.horizontalMeasureColumns(); + return; + } + + this.verticalMeasureColumns(); + + }, + + verticalMeasureColumns : function() + { + this.getContainerWidth(); + +// if(Roo.lib.Dom.getViewWidth() < 768 && this.isAlternative){ +// this.colWidth = Math.floor(this.containerWidth * 0.8); +// return; +// } + + var boxWidth = this.boxWidth + this.padWidth; + + if(this.containerWidth < this.boxWidth){ + boxWidth = this.containerWidth + } + + var containerWidth = this.containerWidth; + + var cols = Math.floor(containerWidth / boxWidth); + + this.cols = Math.max( cols, 1 ); + + this.cols = this.maxCols > 0 ? Math.min( this.cols, this.maxCols ) : this.cols; + + var totalBoxWidth = this.cols * boxWidth - this.padWidth; + + var avail = Math.floor((containerWidth - totalBoxWidth) / this.cols); + + this.colWidth = boxWidth + avail - this.padWidth; + + this.unitWidth = Math.round((this.colWidth - (this.gutter * 2)) / 3); + this.unitHeight = this.boxHeight > 0 ? this.boxHeight : this.unitWidth; + }, + + horizontalMeasureColumns : function() + { + this.getContainerWidth(); + + var boxWidth = this.boxWidth; + + if(this.containerWidth < boxWidth){ + boxWidth = this.containerWidth; + } + + this.unitWidth = Math.floor((boxWidth - (this.gutter * 2)) / 3); + + this.el.setHeight(boxWidth); + + }, + + getContainerWidth : function() + { + this.containerWidth = this.el.getBox(true).width; //maybe use getComputedWidth + }, + + layoutItems : function( isInstant ) + { + Roo.log(this.bricks); + + var items = Roo.apply([], this.bricks); + + if(this.isHorizontal){ + this._horizontalLayoutItems( items , isInstant ); + return; + } + +// if(Roo.lib.Dom.getViewWidth() < 768 && this.isAlternative){ +// this._verticalAlternativeLayoutItems( items , isInstant ); +// return; +// } + + this._verticalLayoutItems( items , isInstant ); + + }, + + _verticalLayoutItems : function ( items , isInstant) + { + if ( !items || !items.length ) { + return; + } + + var standard = [ + ['xs', 'xs', 'xs', 'tall'], + ['xs', 'xs', 'tall'], + ['xs', 'xs', 'sm'], + ['xs', 'xs', 'xs'], + ['xs', 'tall'], + ['xs', 'sm'], + ['xs', 'xs'], + ['xs'], + + ['sm', 'xs', 'xs'], + ['sm', 'xs'], + ['sm'], + + ['tall', 'xs', 'xs', 'xs'], + ['tall', 'xs', 'xs'], + ['tall', 'xs'], + ['tall'] + + ]; + + var queue = []; + + var boxes = []; + + var box = []; + + Roo.each(items, function(item, k){ + + switch (item.size) { + // these layouts take up a full box, + case 'md' : + case 'md-left' : + case 'md-right' : + case 'wide' : + + if(box.length){ + boxes.push(box); + box = []; + } + + boxes.push([item]); + + break; + + case 'xs' : + case 'sm' : + case 'tall' : + + box.push(item); + + break; + default : + break; + + } + + }, this); + + if(box.length){ + boxes.push(box); + box = []; + } + + var filterPattern = function(box, length) + { + if(!box.length){ + return; + } + + var match = false; + + var pattern = box.slice(0, length); + + var format = []; + + Roo.each(pattern, function(i){ + format.push(i.size); + }, this); + + Roo.each(standard, function(s){ + + if(String(s) != String(format)){ + return; + } + + match = true; + return false; + + }, this); + + if(!match && length == 1){ + return; + } + + if(!match){ + filterPattern(box, length - 1); + return; + } + + queue.push(pattern); + + box = box.slice(length, box.length); + + filterPattern(box, 4); + + return; + + } + + Roo.each(boxes, function(box, k){ + + if(!box.length){ + return; + } + + if(box.length == 1){ + queue.push(box); + return; + } + + filterPattern(box, 4); + + }, this); + + this._processVerticalLayoutQueue( queue, isInstant ); + + }, + +// _verticalAlternativeLayoutItems : function( items , isInstant ) +// { +// if ( !items || !items.length ) { +// return; +// } +// +// this._processVerticalAlternativeLayoutQueue( items, isInstant ); +// +// }, + + _horizontalLayoutItems : function ( items , isInstant) + { + if ( !items || !items.length || items.length < 3) { + return; + } + + items.reverse(); + + var eItems = items.slice(0, 3); + + items = items.slice(3, items.length); + + var standard = [ + ['xs', 'xs', 'xs', 'wide'], + ['xs', 'xs', 'wide'], + ['xs', 'xs', 'sm'], + ['xs', 'xs', 'xs'], + ['xs', 'wide'], + ['xs', 'sm'], + ['xs', 'xs'], + ['xs'], + + ['sm', 'xs', 'xs'], + ['sm', 'xs'], + ['sm'], + + ['wide', 'xs', 'xs', 'xs'], + ['wide', 'xs', 'xs'], + ['wide', 'xs'], + ['wide'], + + ['wide-thin'] + ]; + + var queue = []; + + var boxes = []; + + var box = []; + + Roo.each(items, function(item, k){ + + switch (item.size) { + case 'md' : + case 'md-left' : + case 'md-right' : + case 'tall' : + + if(box.length){ + boxes.push(box); + box = []; + } + + boxes.push([item]); + + break; + + case 'xs' : + case 'sm' : + case 'wide' : + case 'wide-thin' : + + box.push(item); + + break; + default : + break; + + } + + }, this); + + if(box.length){ + boxes.push(box); + box = []; + } + + var filterPattern = function(box, length) + { + if(!box.length){ + return; + } + + var match = false; + + var pattern = box.slice(0, length); + + var format = []; + + Roo.each(pattern, function(i){ + format.push(i.size); + }, this); + + Roo.each(standard, function(s){ + + if(String(s) != String(format)){ + return; + } + + match = true; + return false; + + }, this); + + if(!match && length == 1){ + return; + } + + if(!match){ + filterPattern(box, length - 1); + return; + } + + queue.push(pattern); + + box = box.slice(length, box.length); + + filterPattern(box, 4); + + return; + + } + + Roo.each(boxes, function(box, k){ + + if(!box.length){ + return; + } + + if(box.length == 1){ + queue.push(box); + return; + } + + filterPattern(box, 4); + + }, this); + + + var prune = []; + + var pos = this.el.getBox(true); + + var minX = pos.x; + + var maxX = pos.right - this.unitWidth * 3 - this.gutter * 2 - this.padWidth; + + var hit_end = false; + + Roo.each(queue, function(box){ + + if(hit_end){ + + Roo.each(box, function(b){ + + b.el.setVisibilityMode(Roo.Element.DISPLAY); + b.el.hide(); + + }, this); + + return; + } + + var mx = 0; + + Roo.each(box, function(b){ + + b.el.setVisibilityMode(Roo.Element.DISPLAY); + b.el.show(); + + mx = Math.max(mx, b.x); + + }, this); + + maxX = maxX - this.unitWidth * mx - this.gutter * (mx - 1) - this.padWidth; + + if(maxX < minX){ + + Roo.each(box, function(b){ + + b.el.setVisibilityMode(Roo.Element.DISPLAY); + b.el.hide(); + + }, this); + + hit_end = true; + + return; + } + + prune.push(box); + + }, this); + + this._processHorizontalLayoutQueue( prune, eItems, isInstant ); + }, + + /** Sets position of item in DOM + * @param {Element} item + * @param {Number} x - horizontal position + * @param {Number} y - vertical position + * @param {Boolean} isInstant - disables transitions + */ + _processVerticalLayoutQueue : function( queue, isInstant ) + { + var pos = this.el.getBox(true); + var x = pos.x; + var y = pos.y; + var maxY = []; + + for (var i = 0; i < this.cols; i++){ + maxY[i] = pos.y; + } + + Roo.each(queue, function(box, k){ + + var col = k % this.cols; + + Roo.each(box, function(b,kk){ + + b.el.position('absolute'); + + var width = Math.floor(this.unitWidth * b.x + (this.gutter * (b.x - 1)) + b.el.getPadding('lr')); + var height = Math.floor(this.unitHeight * b.y + (this.gutter * (b.y - 1)) + b.el.getPadding('tb')); + + if(b.size == 'md-left' || b.size == 'md-right'){ + width = Math.floor(this.unitWidth * (b.x - 1) + (this.gutter * (b.x - 2)) + b.el.getPadding('lr')); + height = Math.floor(this.unitHeight * (b.y - 1) + (this.gutter * (b.y - 2)) + b.el.getPadding('tb')); + } + + b.el.setWidth(width); + b.el.setHeight(height); + // iframe? + b.el.select('iframe',true).setSize(width,height); + + }, this); + + for (var i = 0; i < this.cols; i++){ + + if(maxY[i] < maxY[col]){ + col = i; + continue; + } + + col = Math.min(col, i); + + } + + x = pos.x + col * (this.colWidth + this.padWidth); + + y = maxY[col]; + + var positions = []; + + switch (box.length){ + case 1 : + positions = this.getVerticalOneBoxColPositions(x, y, box); + break; + case 2 : + positions = this.getVerticalTwoBoxColPositions(x, y, box); + break; + case 3 : + positions = this.getVerticalThreeBoxColPositions(x, y, box); + break; + case 4 : + positions = this.getVerticalFourBoxColPositions(x, y, box); + break; + default : + break; + } + + Roo.each(box, function(b,kk){ + + b.el.setXY([positions[kk].x, positions[kk].y], isInstant ? false : true); + + var sz = b.el.getSize(); + + maxY[col] = Math.max(maxY[col], positions[kk].y + sz.height + this.padWidth); + + }, this); + + }, this); + + var mY = 0; + + for (var i = 0; i < this.cols; i++){ + mY = Math.max(mY, maxY[i]); + } + + this.el.setHeight(mY - pos.y); + + }, + +// _processVerticalAlternativeLayoutQueue : function( items, isInstant ) +// { +// var pos = this.el.getBox(true); +// var x = pos.x; +// var y = pos.y; +// var maxX = pos.right; +// +// var maxHeight = 0; +// +// Roo.each(items, function(item, k){ +// +// var c = k % 2; +// +// item.el.position('absolute'); +// +// var width = Math.floor(this.colWidth + item.el.getPadding('lr')); +// +// item.el.setWidth(width); +// +// var height = Math.floor(this.colWidth * item.y / item.x + item.el.getPadding('tb')); +// +// item.el.setHeight(height); +// +// if(c == 0){ +// item.el.setXY([x, y], isInstant ? false : true); +// } else { +// item.el.setXY([maxX - width, y], isInstant ? false : true); +// } +// +// y = y + height + this.alternativePadWidth; +// +// maxHeight = maxHeight + height + this.alternativePadWidth; +// +// }, this); +// +// this.el.setHeight(maxHeight); +// +// }, + + _processHorizontalLayoutQueue : function( queue, eItems, isInstant ) + { + var pos = this.el.getBox(true); + + var minX = pos.x; + var minY = pos.y; + + var maxX = pos.right; + + this._processHorizontalEndItem(eItems, maxX, minX, minY, isInstant); + + var maxX = maxX - this.unitWidth * 3 - this.gutter * 2 - this.padWidth; + + Roo.each(queue, function(box, k){ + + Roo.each(box, function(b, kk){ + + b.el.position('absolute'); + + var width = Math.floor(this.unitWidth * b.x + (this.gutter * (b.x - 1)) + b.el.getPadding('lr')); + var height = Math.floor(this.unitWidth * b.y + (this.gutter * (b.y - 1)) + b.el.getPadding('tb')); + + if(b.size == 'md-left' || b.size == 'md-right'){ + width = Math.floor(this.unitWidth * (b.x - 1) + (this.gutter * (b.x - 2)) + b.el.getPadding('lr')); + height = Math.floor(this.unitWidth * (b.y - 1) + (this.gutter * (b.y - 2)) + b.el.getPadding('tb')); + } + + b.el.setWidth(width); + b.el.setHeight(height); + + }, this); + + if(!box.length){ + return; + } + + var positions = []; + + switch (box.length){ + case 1 : + positions = this.getHorizontalOneBoxColPositions(maxX, minY, box); + break; + case 2 : + positions = this.getHorizontalTwoBoxColPositions(maxX, minY, box); + break; + case 3 : + positions = this.getHorizontalThreeBoxColPositions(maxX, minY, box); + break; + case 4 : + positions = this.getHorizontalFourBoxColPositions(maxX, minY, box); + break; + default : + break; + } + + Roo.each(box, function(b,kk){ + + b.el.setXY([positions[kk].x, positions[kk].y], isInstant ? false : true); + + maxX = Math.min(maxX, positions[kk].x - this.padWidth); + + }, this); + + }, this); + + }, + + _processHorizontalEndItem : function(eItems, maxX, minX, minY, isInstant) + { + Roo.each(eItems, function(b,k){ + + b.size = (k == 0) ? 'sm' : 'xs'; + b.x = (k == 0) ? 2 : 1; + b.y = (k == 0) ? 2 : 1; + + b.el.position('absolute'); + + var width = Math.floor(this.unitWidth * b.x + (this.gutter * (b.x - 1)) + b.el.getPadding('lr')); + + b.el.setWidth(width); + + var height = Math.floor(this.unitWidth * b.y + (this.gutter * (b.y - 1)) + b.el.getPadding('tb')); + + b.el.setHeight(height); + + }, this); + + var positions = []; + + positions.push({ + x : maxX - this.unitWidth * 2 - this.gutter, + y : minY + }); + + positions.push({ + x : maxX - this.unitWidth, + y : minY + (this.unitWidth + this.gutter) * 2 + }); + + positions.push({ + x : maxX - this.unitWidth * 3 - this.gutter * 2, + y : minY + }); + + Roo.each(eItems, function(b,k){ + + b.el.setXY([positions[k].x, positions[k].y], isInstant ? false : true); + + }, this); + + }, + + getVerticalOneBoxColPositions : function(x, y, box) + { + var pos = []; + + var rand = Math.floor(Math.random() * ((4 - box[0].x))); + + if(box[0].size == 'md-left'){ + rand = 0; + } + + if(box[0].size == 'md-right'){ + rand = 1; + } + + pos.push({ + x : x + (this.unitWidth + this.gutter) * rand, + y : y + }); + + return pos; + }, + + getVerticalTwoBoxColPositions : function(x, y, box) + { + var pos = []; + + if(box[0].size == 'xs'){ + + pos.push({ + x : x, + y : y + ((this.unitHeight + this.gutter) * Math.floor(Math.random() * box[1].y)) + }); + + pos.push({ + x : x + (this.unitWidth + this.gutter) * (3 - box[1].x), + y : y + }); + + return pos; + + } + + pos.push({ + x : x, + y : y + }); + + pos.push({ + x : x + (this.unitWidth + this.gutter) * 2, + y : y + ((this.unitHeight + this.gutter) * Math.floor(Math.random() * box[0].y)) + }); + + return pos; + + }, + + getVerticalThreeBoxColPositions : function(x, y, box) + { + var pos = []; + + if(box[0].size == 'xs' && box[1].size == 'xs' && box[2].size == 'xs'){ + + pos.push({ + x : x, + y : y + }); + + pos.push({ + x : x + (this.unitWidth + this.gutter) * 1, + y : y + }); + + pos.push({ + x : x + (this.unitWidth + this.gutter) * 2, + y : y + }); + + return pos; + + } + + if(box[0].size == 'xs' && box[1].size == 'xs'){ + + pos.push({ + x : x, + y : y + }); + + pos.push({ + x : x, + y : y + ((this.unitHeight + this.gutter) * (box[2].y - 1)) + }); + + pos.push({ + x : x + (this.unitWidth + this.gutter) * 1, + y : y + }); + + return pos; + + } + + pos.push({ + x : x, + y : y + }); + + pos.push({ + x : x + (this.unitWidth + this.gutter) * 2, + y : y + }); + + pos.push({ + x : x + (this.unitWidth + this.gutter) * 2, + y : y + (this.unitHeight + this.gutter) * (box[0].y - 1) + }); + + return pos; + + }, + + getVerticalFourBoxColPositions : function(x, y, box) + { + var pos = []; + + if(box[0].size == 'xs'){ + + pos.push({ + x : x, + y : y + }); + + pos.push({ + x : x, + y : y + (this.unitHeight + this.gutter) * 1 + }); + + pos.push({ + x : x, + y : y + (this.unitHeight + this.gutter) * 2 + }); + + pos.push({ + x : x + (this.unitWidth + this.gutter) * 1, + y : y + }); + + return pos; + + } + + pos.push({ + x : x, + y : y + }); + + pos.push({ + x : x + (this.unitWidth + this.gutter) * 2, + y : y + }); + + pos.push({ + x : x + (this.unitHeightunitWidth + this.gutter) * 2, + y : y + (this.unitHeight + this.gutter) * 1 + }); + + pos.push({ + x : x + (this.unitWidth + this.gutter) * 2, + y : y + (this.unitWidth + this.gutter) * 2 + }); + + return pos; + + }, + + getHorizontalOneBoxColPositions : function(maxX, minY, box) + { + var pos = []; + + if(box[0].size == 'md-left'){ + pos.push({ + x : maxX - this.unitWidth * (box[0].x - 1) - this.gutter * (box[0].x - 2), + y : minY + }); + + return pos; + } + + if(box[0].size == 'md-right'){ + pos.push({ + x : maxX - this.unitWidth * (box[0].x - 1) - this.gutter * (box[0].x - 2), + y : minY + (this.unitWidth + this.gutter) * 1 + }); + + return pos; + } + + var rand = Math.floor(Math.random() * (4 - box[0].y)); + + pos.push({ + x : maxX - this.unitWidth * box[0].x - this.gutter * (box[0].x - 1), + y : minY + (this.unitWidth + this.gutter) * rand + }); + + return pos; + + }, + + getHorizontalTwoBoxColPositions : function(maxX, minY, box) + { + var pos = []; + + if(box[0].size == 'xs'){ + + pos.push({ + x : maxX - this.unitWidth * box[0].x - this.gutter * (box[0].x - 1), + y : minY + }); + + pos.push({ + x : maxX - this.unitWidth * box[1].x - this.gutter * (box[1].x - 1), + y : minY + (this.unitWidth + this.gutter) * (3 - box[1].y) + }); + + return pos; + + } + + pos.push({ + x : maxX - this.unitWidth * box[0].x - this.gutter * (box[0].x - 1), + y : minY + }); + + pos.push({ + x : maxX - this.unitWidth * box[1].x - this.gutter * (box[1].x - 1), + y : minY + (this.unitWidth + this.gutter) * 2 + }); + + return pos; + + }, + + getHorizontalThreeBoxColPositions : function(maxX, minY, box) + { + var pos = []; + + if(box[0].size == 'xs' && box[1].size == 'xs' && box[2].size == 'xs'){ + + pos.push({ + x : maxX - this.unitWidth * box[0].x - this.gutter * (box[0].x - 1), + y : minY + }); + + pos.push({ + x : maxX - this.unitWidth * box[1].x - this.gutter * (box[1].x - 1), + y : minY + (this.unitWidth + this.gutter) * 1 + }); + + pos.push({ + x : maxX - this.unitWidth * box[2].x - this.gutter * (box[2].x - 1), + y : minY + (this.unitWidth + this.gutter) * 2 + }); + + return pos; + + } + + if(box[0].size == 'xs' && box[1].size == 'xs'){ + + pos.push({ + x : maxX - this.unitWidth * box[0].x - this.gutter * (box[0].x - 1), + y : minY + }); + + pos.push({ + x : maxX - this.unitWidth * box[0].x - this.gutter * (box[0].x - 1) - this.unitWidth * box[1].x - this.gutter * (box[1].x - 1), + y : minY + }); + + pos.push({ + x : maxX - this.unitWidth * box[2].x - this.gutter * (box[2].x - 1), + y : minY + (this.unitWidth + this.gutter) * 1 + }); + + return pos; + + } + + pos.push({ + x : maxX - this.unitWidth * box[0].x - this.gutter * (box[0].x - 1), + y : minY + }); + + pos.push({ + x : maxX - this.unitWidth * box[1].x - this.gutter * (box[1].x - 1), + y : minY + (this.unitWidth + this.gutter) * 2 + }); + + pos.push({ + x : maxX - this.unitWidth * box[1].x - this.gutter * (box[1].x - 1) - this.unitWidth * box[2].x - this.gutter * (box[2].x - 1), + y : minY + (this.unitWidth + this.gutter) * 2 + }); + + return pos; + + }, + + getHorizontalFourBoxColPositions : function(maxX, minY, box) + { + var pos = []; + + if(box[0].size == 'xs'){ + + pos.push({ + x : maxX - this.unitWidth * box[0].x - this.gutter * (box[0].x - 1), + y : minY + }); + + pos.push({ + x : maxX - this.unitWidth * box[0].x - this.gutter * (box[0].x - 1) - this.unitWidth * box[1].x - this.gutter * (box[1].x - 1), + y : minY + }); + + pos.push({ + x : maxX - this.unitWidth * box[0].x - this.gutter * (box[0].x - 1) - this.unitWidth * box[1].x - this.gutter * (box[1].x - 1) - this.unitWidth * box[2].x - this.gutter * (box[2].x - 1), + y : minY + }); + + pos.push({ + x : maxX - this.unitWidth * box[3].x - this.gutter * (box[3].x - 1), + y : minY + (this.unitWidth + this.gutter) * 1 + }); + + return pos; + + } + + pos.push({ + x : maxX - this.unitWidth * box[0].x - this.gutter * (box[0].x - 1), + y : minY + }); + + pos.push({ + x : maxX - this.unitWidth * box[1].x - this.gutter * (box[1].x - 1), + y : minY + (this.unitWidth + this.gutter) * 2 + }); + + pos.push({ + x : maxX - this.unitWidth * box[1].x - this.gutter * (box[1].x - 1) - this.unitWidth * box[2].x - this.gutter * (box[2].x - 1), + y : minY + (this.unitWidth + this.gutter) * 2 + }); + + pos.push({ + x : maxX - this.unitWidth * box[1].x - this.gutter * (box[1].x - 1) - this.unitWidth * box[2].x - this.gutter * (box[2].x - 1) - this.unitWidth * box[3].x - this.gutter * (box[3].x - 1), + y : minY + (this.unitWidth + this.gutter) * 2 + }); + + return pos; + + }, + + /** + * remove a Masonry Brick + * @param {Roo.bootstrap.MasonryBrick} the masonry brick to remove + */ + removeBrick : function(brick_id) + { + if (!brick_id) { + return; + } + + for (var i = 0; i<this.bricks.length; i++) { + if (this.bricks[i].id == brick_id) { + this.bricks.splice(i,1); + this.el.dom.removeChild(Roo.get(brick_id).dom); + this.initial(); + } + } + }, + + /** + * adds a Masonry Brick + * @param {Roo.bootstrap.MasonryBrick} the masonry brick to add + */ + addBrick : function(cfg) + { + var cn = new Roo.bootstrap.MasonryBrick(cfg); + //this.register(cn); + cn.parentId = this.id; + cn.render(this.el); + return cn; + }, + + /** + * register a Masonry Brick + * @param {Roo.bootstrap.MasonryBrick} the masonry brick to add + */ + + register : function(brick) + { + this.bricks.push(brick); + brick.masonryId = this.id; + }, + + /** + * clear all the Masonry Brick + */ + clearAll : function() + { + this.bricks = []; + //this.getChildContainer().dom.innerHTML = ""; + this.el.dom.innerHTML = ''; + }, + + getSelected : function() + { + if (!this.selectedBrick) { + return false; + } + + return this.selectedBrick; + } +}); + +Roo.apply(Roo.bootstrap.LayoutMasonry, { + + groups: {}, + /** + * register a Masonry Layout + * @param {Roo.bootstrap.LayoutMasonry} the masonry layout to add + */ + + register : function(layout) + { + this.groups[layout.id] = layout; + }, + /** + * fetch a Masonry Layout based on the masonry layout ID + * @param {string} the masonry layout to add + * @returns {Roo.bootstrap.LayoutMasonry} the masonry layout + */ + + get: function(layout_id) { + if (typeof(this.groups[layout_id]) == 'undefined') { + return false; + } + return this.groups[layout_id] ; + } + + + +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_LayoutMasonryAuto.js.html b/docs2/src/Roo_bootstrap_LayoutMasonryAuto.js.html new file mode 100644 index 0000000000..4f0dd75cc5 --- /dev/null +++ b/docs2/src/Roo_bootstrap_LayoutMasonryAuto.js.html @@ -0,0 +1,501 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/LayoutMasonryAuto.js/** + * + * This is based on + * http://masonry.desandro.com + * + * The idea is to render all the bricks based on vertical width... + * + * The original code extends 'outlayer' - we might need to use that.... + * + */ + + +/** + * @class Roo.bootstrap.LayoutMasonryAuto + * @extends Roo.bootstrap.Component + * Bootstrap Layout Masonry class + * + * @constructor + * Create a new Element + * @param {Object} config The config object + */ + +Roo.bootstrap.LayoutMasonryAuto = function(config){ + Roo.bootstrap.LayoutMasonryAuto.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.LayoutMasonryAuto, Roo.bootstrap.Component, { + + /** + * @cfg {Boolean} isFitWidth - resize the width.. + */ + isFitWidth : false, // options.. + /** + * @cfg {Boolean} isOriginLeft = left align? + */ + isOriginLeft : true, + /** + * @cfg {Boolean} isOriginTop = top align? + */ + isOriginTop : false, + /** + * @cfg {Boolean} isLayoutInstant = no animation? + */ + isLayoutInstant : false, // needed? + /** + * @cfg {Boolean} isResizingContainer = not sure if this is used.. + */ + isResizingContainer : true, + /** + * @cfg {Number} columnWidth width of the columns + */ + + columnWidth : 0, + + /** + * @cfg {Number} maxCols maximum number of columns + */ + + maxCols: 0, + /** + * @cfg {Number} padHeight padding below box.. + */ + + padHeight : 10, + + /** + * @cfg {Boolean} isAutoInitial defalut true + */ + + isAutoInitial : true, + + // private? + gutter : 0, + + containerWidth: 0, + initialColumnWidth : 0, + currentSize : null, + + colYs : null, // array. + maxY : 0, + padWidth: 10, + + + tag: 'div', + cls: '', + bricks: null, //CompositeElement + cols : 0, // array? + // element : null, // wrapped now this.el + _isLayoutInited : null, + + + getAutoCreate : function(){ + + var cfg = { + tag: this.tag, + cls: 'blog-masonary-wrapper ' + this.cls, + cn : { + cls : 'mas-boxes masonary' + } + }; + + return cfg; + }, + + getChildContainer: function( ) + { + if (this.boxesEl) { + return this.boxesEl; + } + + this.boxesEl = this.el.select('.mas-boxes').first(); + + return this.boxesEl; + }, + + + initEvents : function() + { + var _this = this; + + if(this.isAutoInitial){ + Roo.log('hook children rendered'); + this.on('childrenrendered', function() { + Roo.log('children rendered'); + _this.initial(); + } ,this); + } + + }, + + initial : function() + { + this.reloadItems(); + + this.currentSize = this.el.getBox(true); + + /// was window resize... - let's see if this works.. + Roo.EventManager.onWindowResize(this.resize, this); + + if(!this.isAutoInitial){ + this.layout(); + return; + } + + this.layout.defer(500,this); + }, + + reloadItems: function() + { + this.bricks = this.el.select('.masonry-brick', true); + + this.bricks.each(function(b) { + //Roo.log(b.getSize()); + if (!b.attr('originalwidth')) { + b.attr('originalwidth', b.getSize().width); + } + + }); + + Roo.log(this.bricks.elements.length); + }, + + resize : function() + { + Roo.log('resize'); + var cs = this.el.getBox(true); + + if (this.currentSize.width == cs.width && this.currentSize.x == cs.x ) { + Roo.log("no change in with or X"); + return; + } + this.currentSize = cs; + this.layout(); + }, + + layout : function() + { + Roo.log('layout'); + this._resetLayout(); + //this._manageStamps(); + + // don't animate first layout + var isInstant = this.isLayoutInstant !== undefined ? this.isLayoutInstant : !this._isLayoutInited; + this.layoutItems( isInstant ); + + // flag for initalized + this._isLayoutInited = true; + }, + + layoutItems : function( isInstant ) + { + //var items = this._getItemsForLayout( this.items ); + // original code supports filtering layout items.. we just ignore it.. + + this._layoutItems( this.bricks , isInstant ); + + this._postLayout(); + }, + _layoutItems : function ( items , isInstant) + { + //this.fireEvent( 'layout', this, items ); + + + if ( !items || !items.elements.length ) { + // no items, emit event with empty array + return; + } + + var queue = []; + items.each(function(item) { + Roo.log("layout item"); + Roo.log(item); + // get x/y object from method + var position = this._getItemLayoutPosition( item ); + // enqueue + position.item = item; + position.isInstant = isInstant; // || item.isLayoutInstant; << not set yet... + queue.push( position ); + }, this); + + this._processLayoutQueue( queue ); + }, + /** Sets position of item in DOM + * @param {Element} item + * @param {Number} x - horizontal position + * @param {Number} y - vertical position + * @param {Boolean} isInstant - disables transitions + */ + _processLayoutQueue : function( queue ) + { + for ( var i=0, len = queue.length; i < len; i++ ) { + var obj = queue[i]; + obj.item.position('absolute'); + obj.item.setXY([obj.x,obj.y], obj.isInstant ? false : true); + } + }, + + + /** + * Any logic you want to do after each layout, + * i.e. size the container + */ + _postLayout : function() + { + this.resizeContainer(); + }, + + resizeContainer : function() + { + if ( !this.isResizingContainer ) { + return; + } + var size = this._getContainerSize(); + if ( size ) { + this.el.setSize(size.width,size.height); + this.boxesEl.setSize(size.width,size.height); + } + }, + + + + _resetLayout : function() + { + //this.getSize(); // -- does not really do anything.. it probably applies left/right etc. to obuject but not used + this.colWidth = this.el.getWidth(); + //this.gutter = this.el.getWidth(); + + this.measureColumns(); + + // reset column Y + var i = this.cols; + this.colYs = []; + while (i--) { + this.colYs.push( 0 ); + } + + this.maxY = 0; + }, + + measureColumns : function() + { + this.getContainerWidth(); + // if columnWidth is 0, default to outerWidth of first item + if ( !this.columnWidth ) { + var firstItem = this.bricks.first(); + Roo.log(firstItem); + this.columnWidth = this.containerWidth; + if (firstItem && firstItem.attr('originalwidth') ) { + this.columnWidth = 1* (firstItem.attr('originalwidth') || firstItem.getWidth()); + } + // columnWidth fall back to item of first element + Roo.log("set column width?"); + this.initialColumnWidth = this.columnWidth ; + + // if first elem has no width, default to size of container + + } + + + if (this.initialColumnWidth) { + this.columnWidth = this.initialColumnWidth; + } + + + + // column width is fixed at the top - however if container width get's smaller we should + // reduce it... + + // this bit calcs how man columns.. + + var columnWidth = this.columnWidth += this.gutter; + + // calculate columns + var containerWidth = this.containerWidth + this.gutter; + + var cols = (containerWidth - this.padWidth) / (columnWidth - this.padWidth); + // fix rounding errors, typically with gutters + var excess = columnWidth - containerWidth % columnWidth; + + + // if overshoot is less than a pixel, round up, otherwise floor it + var mathMethod = excess && excess < 1 ? 'round' : 'floor'; + cols = Math[ mathMethod ]( cols ); + this.cols = Math.max( cols, 1 ); + this.cols = this.maxCols > 0 ? Math.min( this.cols, this.maxCols ) : this.cols; + + // padding positioning.. + var totalColWidth = this.cols * this.columnWidth; + var padavail = this.containerWidth - totalColWidth; + // so for 2 columns - we need 3 'pads' + + var padNeeded = (1+this.cols) * this.padWidth; + + var padExtra = Math.floor((padavail - padNeeded) / this.cols); + + this.columnWidth += padExtra + //this.padWidth = Math.floor(padavail / ( this.cols)); + + // adjust colum width so that padding is fixed?? + + // we have 3 columns ... total = width * 3 + // we have X left over... that should be used by + + //if (this.expandC) { + + //} + + + + }, + + getContainerWidth : function() + { + /* // container is parent if fit width + var container = this.isFitWidth ? this.element.parentNode : this.element; + // check that this.size and size are there + // IE8 triggers resize on body size change, so they might not be + + var size = getSize( container ); //FIXME + this.containerWidth = size && size.innerWidth; //FIXME + */ + + this.containerWidth = this.el.getBox(true).width; //maybe use getComputedWidth + + }, + + _getItemLayoutPosition : function( item ) // what is item? + { + // we resize the item to our columnWidth.. + + item.setWidth(this.columnWidth); + item.autoBoxAdjust = false; + + var sz = item.getSize(); + + // how many columns does this brick span + var remainder = this.containerWidth % this.columnWidth; + + var mathMethod = remainder && remainder < 1 ? 'round' : 'ceil'; + // round if off by 1 pixel, otherwise use ceil + var colSpan = Math[ mathMethod ]( sz.width / this.columnWidth ); + colSpan = Math.min( colSpan, this.cols ); + + // normally this should be '1' as we dont' currently allow multi width columns.. + + var colGroup = this._getColGroup( colSpan ); + // get the minimum Y value from the columns + var minimumY = Math.min.apply( Math, colGroup ); + Roo.log([ 'setHeight', minimumY, sz.height, setHeight ]); + + var shortColIndex = colGroup.indexOf( minimumY ); // broken on ie8..?? probably... + + // position the brick + var position = { + x: this.currentSize.x + (this.padWidth /2) + ((this.columnWidth + this.padWidth )* shortColIndex), + y: this.currentSize.y + minimumY + this.padHeight + }; + + Roo.log(position); + // apply setHeight to necessary columns + var setHeight = minimumY + sz.height + this.padHeight; + //Roo.log([ 'setHeight', minimumY, sz.height, setHeight ]); + + var setSpan = this.cols + 1 - colGroup.length; + for ( var i = 0; i < setSpan; i++ ) { + this.colYs[ shortColIndex + i ] = setHeight ; + } + + return position; + }, + + /** + * @param {Number} colSpan - number of columns the element spans + * @returns {Array} colGroup + */ + _getColGroup : function( colSpan ) + { + if ( colSpan < 2 ) { + // if brick spans only one column, use all the column Ys + return this.colYs; + } + + var colGroup = []; + // how many different places could this brick fit horizontally + var groupCount = this.cols + 1 - colSpan; + // for each group potential horizontal position + for ( var i = 0; i < groupCount; i++ ) { + // make an array of colY values for that one group + var groupColYs = this.colYs.slice( i, i + colSpan ); + // and get the max value of the array + colGroup[i] = Math.max.apply( Math, groupColYs ); + } + return colGroup; + }, + /* + _manageStamp : function( stamp ) + { + var stampSize = stamp.getSize(); + var offset = stamp.getBox(); + // get the columns that this stamp affects + var firstX = this.isOriginLeft ? offset.x : offset.right; + var lastX = firstX + stampSize.width; + var firstCol = Math.floor( firstX / this.columnWidth ); + firstCol = Math.max( 0, firstCol ); + + var lastCol = Math.floor( lastX / this.columnWidth ); + // lastCol should not go over if multiple of columnWidth #425 + lastCol -= lastX % this.columnWidth ? 0 : 1; + lastCol = Math.min( this.cols - 1, lastCol ); + + // set colYs to bottom of the stamp + var stampMaxY = ( this.isOriginTop ? offset.y : offset.bottom ) + + stampSize.height; + + for ( var i = firstCol; i <= lastCol; i++ ) { + this.colYs[i] = Math.max( stampMaxY, this.colYs[i] ); + } + }, + */ + + _getContainerSize : function() + { + this.maxY = Math.max.apply( Math, this.colYs ); + var size = { + height: this.maxY + }; + + if ( this.isFitWidth ) { + size.width = this._getContainerFitWidth(); + } + + return size; + }, + + _getContainerFitWidth : function() + { + var unusedCols = 0; + // count unused columns + var i = this.cols; + while ( --i ) { + if ( this.colYs[i] !== 0 ) { + break; + } + unusedCols++; + } + // fit container to columns that have been used + return ( this.cols - unusedCols ) * this.columnWidth - this.gutter; + }, + + needsResizeLayout : function() + { + var previousWidth = this.containerWidth; + this.getContainerWidth(); + return previousWidth !== this.containerWidth; + } + +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Link.js.html b/docs2/src/Roo_bootstrap_Link.js.html new file mode 100644 index 0000000000..f11f83ec7d --- /dev/null +++ b/docs2/src/Roo_bootstrap_Link.js.html @@ -0,0 +1,106 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Link.js/* + * - LGPL + * + * image + * + */ + + +/** + * @class Roo.bootstrap.Link + * @extends Roo.bootstrap.Component + * Bootstrap Link Class + * @cfg {String} alt image alternative text + * @cfg {String} href a tag href + * @cfg {String} target (_self|_blank|_parent|_top) target for a href. + * @cfg {String} html the content of the link. + * @cfg {String} anchor name for the anchor link + * @cfg {String} fa - favicon + + * @cfg {Boolean} preventDefault (true | false) default false + + * + * @constructor + * Create a new Input + * @param {Object} config The config object + */ + +Roo.bootstrap.Link = function(config){ + Roo.bootstrap.Link.superclass.constructor.call(this, config); + + this.addEvents({ + // img events + /** + * @event click + * The img click event for the img. + * @param {Roo.EventObject} e + */ + "click" : true + }); +}; + +Roo.extend(Roo.bootstrap.Link, Roo.bootstrap.Component, { + + href: false, + target: false, + preventDefault: false, + anchor : false, + alt : false, + fa: false, + + + getAutoCreate : function() + { + var html = this.html || ''; + + if (this.fa !== false) { + html = '<i class="fa fa-' + this.fa + '"></i>'; + } + var cfg = { + tag: 'a' + }; + // anchor's do not require html/href... + if (this.anchor === false) { + cfg.html = html; + cfg.href = this.href || '#'; + } else { + cfg.name = this.anchor; + if (this.html !== false || this.fa !== false) { + cfg.html = html; + } + if (this.href !== false) { + cfg.href = this.href; + } + } + + if(this.alt !== false){ + cfg.alt = this.alt; + } + + + if(this.target !== false) { + cfg.target = this.target; + } + + return cfg; + }, + + initEvents: function() { + + if(!this.href || this.preventDefault){ + this.el.on('click', this.onClick, this); + } + }, + + onClick : function(e) + { + if(this.preventDefault){ + e.preventDefault(); + } + //Roo.log('img onclick'); + this.fireEvent('click', this, e); + } + +}); + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_LocationPicker.js.html b/docs2/src/Roo_bootstrap_LocationPicker.js.html new file mode 100644 index 0000000000..b42bd539a1 --- /dev/null +++ b/docs2/src/Roo_bootstrap_LocationPicker.js.html @@ -0,0 +1,482 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/LocationPicker.js/* + * - LGPL + * + * Location Picker + * + */ + +/** + * @class Roo.bootstrap.LocationPicker + * @extends Roo.bootstrap.Component + * Bootstrap LocationPicker class + * @cfg {Number} latitude Position when init default 0 + * @cfg {Number} longitude Position when init default 0 + * @cfg {Number} zoom default 15 + * @cfg {String} mapTypeId default google.maps.MapTypeId.ROADMAP + * @cfg {Boolean} mapTypeControl default false + * @cfg {Boolean} disableDoubleClickZoom default false + * @cfg {Boolean} scrollwheel default true + * @cfg {Boolean} streetViewControl default false + * @cfg {Number} radius default 0 + * @cfg {String} locationName + * @cfg {Boolean} draggable default true + * @cfg {Boolean} enableAutocomplete default false + * @cfg {Boolean} enableReverseGeocode default true + * @cfg {String} markerTitle + * + * @constructor + * Create a new LocationPicker + * @param {Object} config The config object + */ + + +Roo.bootstrap.LocationPicker = function(config){ + + Roo.bootstrap.LocationPicker.superclass.constructor.call(this, config); + + this.addEvents({ + /** + * @event initial + * Fires when the picker initialized. + * @param {Roo.bootstrap.LocationPicker} this + * @param {Google Location} location + */ + initial : true, + /** + * @event positionchanged + * Fires when the picker position changed. + * @param {Roo.bootstrap.LocationPicker} this + * @param {Google Location} location + */ + positionchanged : true, + /** + * @event resize + * Fires when the map resize. + * @param {Roo.bootstrap.LocationPicker} this + */ + resize : true, + /** + * @event show + * Fires when the map show. + * @param {Roo.bootstrap.LocationPicker} this + */ + show : true, + /** + * @event hide + * Fires when the map hide. + * @param {Roo.bootstrap.LocationPicker} this + */ + hide : true, + /** + * @event mapClick + * Fires when click the map. + * @param {Roo.bootstrap.LocationPicker} this + * @param {Map event} e + */ + mapClick : true, + /** + * @event mapRightClick + * Fires when right click the map. + * @param {Roo.bootstrap.LocationPicker} this + * @param {Map event} e + */ + mapRightClick : true, + /** + * @event markerClick + * Fires when click the marker. + * @param {Roo.bootstrap.LocationPicker} this + * @param {Map event} e + */ + markerClick : true, + /** + * @event markerRightClick + * Fires when right click the marker. + * @param {Roo.bootstrap.LocationPicker} this + * @param {Map event} e + */ + markerRightClick : true, + /** + * @event OverlayViewDraw + * Fires when OverlayView Draw + * @param {Roo.bootstrap.LocationPicker} this + */ + OverlayViewDraw : true, + /** + * @event OverlayViewOnAdd + * Fires when OverlayView Draw + * @param {Roo.bootstrap.LocationPicker} this + */ + OverlayViewOnAdd : true, + /** + * @event OverlayViewOnRemove + * Fires when OverlayView Draw + * @param {Roo.bootstrap.LocationPicker} this + */ + OverlayViewOnRemove : true, + /** + * @event OverlayViewShow + * Fires when OverlayView Draw + * @param {Roo.bootstrap.LocationPicker} this + * @param {Pixel} cpx + */ + OverlayViewShow : true, + /** + * @event OverlayViewHide + * Fires when OverlayView Draw + * @param {Roo.bootstrap.LocationPicker} this + */ + OverlayViewHide : true, + /** + * @event loadexception + * Fires when load google lib failed. + * @param {Roo.bootstrap.LocationPicker} this + */ + loadexception : true + }); + +}; + +Roo.extend(Roo.bootstrap.LocationPicker, Roo.bootstrap.Component, { + + gMapContext: false, + + latitude: 0, + longitude: 0, + zoom: 15, + mapTypeId: false, + mapTypeControl: false, + disableDoubleClickZoom: false, + scrollwheel: true, + streetViewControl: false, + radius: 0, + locationName: '', + draggable: true, + enableAutocomplete: false, + enableReverseGeocode: true, + markerTitle: '', + + getAutoCreate: function() + { + + var cfg = { + tag: 'div', + cls: 'roo-location-picker' + }; + + return cfg + }, + + initEvents: function(ct, position) + { + if(!this.el.getWidth() || this.isApplied()){ + return; + } + + this.el.setVisibilityMode(Roo.Element.DISPLAY); + + this.initial(); + }, + + initial: function() + { + if(typeof(google) == 'undefined' || typeof(google.maps) == 'undefined'){ + this.fireEvent('loadexception', this); + return; + } + + if(!this.mapTypeId){ + this.mapTypeId = google.maps.MapTypeId.ROADMAP; + } + + this.gMapContext = this.GMapContext(); + + this.initOverlayView(); + + this.OverlayView = new Roo.bootstrap.LocationPicker.OverlayView(this.gMapContext.map); + + var _this = this; + + google.maps.event.addListener(this.gMapContext.marker, "dragend", function(event) { + _this.setPosition(_this.gMapContext.marker.position); + }); + + google.maps.event.addListener(this.gMapContext.map, 'click', function(event){ + _this.fireEvent('mapClick', this, event); + + }); + + google.maps.event.addListener(this.gMapContext.map, 'rightclick', function(event){ + _this.fireEvent('mapRightClick', this, event); + + }); + + google.maps.event.addListener(this.gMapContext.marker, 'click', function(event){ + _this.fireEvent('markerClick', this, event); + + }); + + google.maps.event.addListener(this.gMapContext.marker, 'rightclick', function(event){ + _this.fireEvent('markerRightClick', this, event); + + }); + + this.setPosition(this.gMapContext.location); + + this.fireEvent('initial', this, this.gMapContext.location); + }, + + initOverlayView: function() + { + var _this = this; + + Roo.bootstrap.LocationPicker.OverlayView.prototype = Roo.apply(new google.maps.OverlayView(), { + + draw: function() + { + _this.fireEvent('OverlayViewDraw', _this); + }, + + onAdd: function() + { + _this.fireEvent('OverlayViewOnAdd', _this); + }, + + onRemove: function() + { + _this.fireEvent('OverlayViewOnRemove', _this); + }, + + show: function(cpx) + { + _this.fireEvent('OverlayViewShow', _this, cpx); + }, + + hide: function() + { + _this.fireEvent('OverlayViewHide', _this); + } + + }); + }, + + fromLatLngToContainerPixel: function(event) + { + return this.OverlayView.getProjection().fromLatLngToContainerPixel(event.latLng); + }, + + isApplied: function() + { + return this.getGmapContext() == false ? false : true; + }, + + getGmapContext: function() + { + return (typeof(this.gMapContext) == 'undefined') ? false : this.gMapContext; + }, + + GMapContext: function() + { + var position = new google.maps.LatLng(this.latitude, this.longitude); + + var _map = new google.maps.Map(this.el.dom, { + center: position, + zoom: this.zoom, + mapTypeId: this.mapTypeId, + mapTypeControl: this.mapTypeControl, + disableDoubleClickZoom: this.disableDoubleClickZoom, + scrollwheel: this.scrollwheel, + streetViewControl: this.streetViewControl, + locationName: this.locationName, + draggable: this.draggable, + enableAutocomplete: this.enableAutocomplete, + enableReverseGeocode: this.enableReverseGeocode + }); + + var _marker = new google.maps.Marker({ + position: position, + map: _map, + title: this.markerTitle, + draggable: this.draggable + }); + + return { + map: _map, + marker: _marker, + circle: null, + location: position, + radius: this.radius, + locationName: this.locationName, + addressComponents: { + formatted_address: null, + addressLine1: null, + addressLine2: null, + streetName: null, + streetNumber: null, + city: null, + district: null, + state: null, + stateOrProvince: null + }, + settings: this, + domContainer: this.el.dom, + geodecoder: new google.maps.Geocoder() + }; + }, + + drawCircle: function(center, radius, options) + { + if (this.gMapContext.circle != null) { + this.gMapContext.circle.setMap(null); + } + if (radius > 0) { + radius *= 1; + options = Roo.apply({}, options, { + strokeColor: "#0000FF", + strokeOpacity: .35, + strokeWeight: 2, + fillColor: "#0000FF", + fillOpacity: .2 + }); + + options.map = this.gMapContext.map; + options.radius = radius; + options.center = center; + this.gMapContext.circle = new google.maps.Circle(options); + return this.gMapContext.circle; + } + + return null; + }, + + setPosition: function(location) + { + this.gMapContext.location = location; + this.gMapContext.marker.setPosition(location); + this.gMapContext.map.panTo(location); + this.drawCircle(location, this.gMapContext.radius, {}); + + var _this = this; + + if (this.gMapContext.settings.enableReverseGeocode) { + this.gMapContext.geodecoder.geocode({ + latLng: this.gMapContext.location + }, function(results, status) { + + if (status == google.maps.GeocoderStatus.OK && results.length > 0) { + _this.gMapContext.locationName = results[0].formatted_address; + _this.gMapContext.addressComponents = _this.address_component_from_google_geocode(results[0].address_components); + + _this.fireEvent('positionchanged', this, location); + } + }); + + return; + } + + this.fireEvent('positionchanged', this, location); + }, + + resize: function() + { + google.maps.event.trigger(this.gMapContext.map, "resize"); + + this.gMapContext.map.setCenter(this.gMapContext.marker.position); + + this.fireEvent('resize', this); + }, + + setPositionByLatLng: function(latitude, longitude) + { + this.setPosition(new google.maps.LatLng(latitude, longitude)); + }, + + getCurrentPosition: function() + { + return { + latitude: this.gMapContext.location.lat(), + longitude: this.gMapContext.location.lng() + }; + }, + + getAddressName: function() + { + return this.gMapContext.locationName; + }, + + getAddressComponents: function() + { + return this.gMapContext.addressComponents; + }, + + address_component_from_google_geocode: function(address_components) + { + var result = {}; + + for (var i = 0; i < address_components.length; i++) { + var component = address_components[i]; + if (component.types.indexOf("postal_code") >= 0) { + result.postalCode = component.short_name; + } else if (component.types.indexOf("street_number") >= 0) { + result.streetNumber = component.short_name; + } else if (component.types.indexOf("route") >= 0) { + result.streetName = component.short_name; + } else if (component.types.indexOf("neighborhood") >= 0) { + result.city = component.short_name; + } else if (component.types.indexOf("locality") >= 0) { + result.city = component.short_name; + } else if (component.types.indexOf("sublocality") >= 0) { + result.district = component.short_name; + } else if (component.types.indexOf("administrative_area_level_1") >= 0) { + result.stateOrProvince = component.short_name; + } else if (component.types.indexOf("country") >= 0) { + result.country = component.short_name; + } + } + + result.addressLine1 = [ result.streetNumber, result.streetName ].join(" ").trim(); + result.addressLine2 = ""; + return result; + }, + + setZoomLevel: function(zoom) + { + this.gMapContext.map.setZoom(zoom); + }, + + show: function() + { + if(!this.el){ + return; + } + + this.el.show(); + + this.resize(); + + this.fireEvent('show', this); + }, + + hide: function() + { + if(!this.el){ + return; + } + + this.el.hide(); + + this.fireEvent('hide', this); + } + +}); + +Roo.apply(Roo.bootstrap.LocationPicker, { + + OverlayView : function(map, options) + { + options = options || {}; + + this.setMap(map); + } + + +}); \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_MasonryBrick.js.html b/docs2/src/Roo_bootstrap_MasonryBrick.js.html new file mode 100644 index 0000000000..1a8c9351fe --- /dev/null +++ b/docs2/src/Roo_bootstrap_MasonryBrick.js.html @@ -0,0 +1,546 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/MasonryBrick.js/* + * - LGPL + * + * element + * + */ + +/** + * @class Roo.bootstrap.MasonryBrick + * @extends Roo.bootstrap.Component + * Bootstrap MasonryBrick class + * + * @constructor + * Create a new MasonryBrick + * @param {Object} config The config object + */ + +Roo.bootstrap.MasonryBrick = function(config){ + + Roo.bootstrap.MasonryBrick.superclass.constructor.call(this, config); + + Roo.bootstrap.MasonryBrick.register(this); + + this.addEvents({ + // raw events + /** + * @event click + * When a MasonryBrick is clcik + * @param {Roo.bootstrap.MasonryBrick} this + * @param {Roo.EventObject} e + */ + "click" : true + }); +}; + +Roo.extend(Roo.bootstrap.MasonryBrick, Roo.bootstrap.Component, { + + /** + * @cfg {String} title + */ + title : '', + /** + * @cfg {String} html + */ + html : '', + /** + * @cfg {String} bgimage + */ + bgimage : '', + /** + * @cfg {String} videourl + */ + videourl : '', + /** + * @cfg {String} cls + */ + cls : '', + /** + * @cfg {String} href + */ + href : '', + /** + * @cfg {String} size (xs|sm|md|md-left|md-right|tall|wide) + */ + size : 'xs', + + /** + * @cfg {String} placetitle (center|bottom) + */ + placetitle : '', + + /** + * @cfg {Boolean} isFitContainer defalut true + */ + isFitContainer : true, + + /** + * @cfg {Boolean} preventDefault defalut false + */ + preventDefault : false, + + /** + * @cfg {Boolean} inverse defalut false + */ + maskInverse : false, + + getAutoCreate : function() + { + if(!this.isFitContainer){ + return this.getSplitAutoCreate(); + } + + var cls = 'masonry-brick masonry-brick-full'; + + if(this.href.length){ + cls += ' masonry-brick-link'; + } + + if(this.bgimage.length){ + cls += ' masonry-brick-image'; + } + + if(this.maskInverse){ + cls += ' mask-inverse'; + } + + if(!this.html.length && !this.maskInverse && !this.videourl.length){ + cls += ' enable-mask'; + } + + if(this.size){ + cls += ' masonry-' + this.size + '-brick'; + } + + if(this.placetitle.length){ + + switch (this.placetitle) { + case 'center' : + cls += ' masonry-center-title'; + break; + case 'bottom' : + cls += ' masonry-bottom-title'; + break; + default: + break; + } + + } else { + if(!this.html.length && !this.bgimage.length){ + cls += ' masonry-center-title'; + } + + if(!this.html.length && this.bgimage.length){ + cls += ' masonry-bottom-title'; + } + } + + if(this.cls){ + cls += ' ' + this.cls; + } + + var cfg = { + tag: (this.href.length) ? 'a' : 'div', + cls: cls, + cn: [ + { + tag: 'div', + cls: 'masonry-brick-mask' + }, + { + tag: 'div', + cls: 'masonry-brick-paragraph', + cn: [] + } + ] + }; + + if(this.href.length){ + cfg.href = this.href; + } + + var cn = cfg.cn[1].cn; + + if(this.title.length){ + cn.push({ + tag: 'h4', + cls: 'masonry-brick-title', + html: this.title + }); + } + + if(this.html.length){ + cn.push({ + tag: 'p', + cls: 'masonry-brick-text', + html: this.html + }); + } + + if (!this.title.length && !this.html.length) { + cfg.cn[1].cls += ' hide'; + } + + if(this.bgimage.length){ + cfg.cn.push({ + tag: 'img', + cls: 'masonry-brick-image-view', + src: this.bgimage + }); + } + + if(this.videourl.length){ + var vurl = this.videourl.replace(/https:\/\/youtu\.be/, 'https://www.youtube.com/embed/'); + // youtube support only? + cfg.cn.push({ + tag: 'iframe', + cls: 'masonry-brick-image-view', + src: vurl, + frameborder : 0, + allowfullscreen : true + }); + } + + return cfg; + + }, + + getSplitAutoCreate : function() + { + var cls = 'masonry-brick masonry-brick-split'; + + if(this.href.length){ + cls += ' masonry-brick-link'; + } + + if(this.bgimage.length){ + cls += ' masonry-brick-image'; + } + + if(this.size){ + cls += ' masonry-' + this.size + '-brick'; + } + + switch (this.placetitle) { + case 'center' : + cls += ' masonry-center-title'; + break; + case 'bottom' : + cls += ' masonry-bottom-title'; + break; + default: + if(!this.bgimage.length){ + cls += ' masonry-center-title'; + } + + if(this.bgimage.length){ + cls += ' masonry-bottom-title'; + } + break; + } + + if(this.cls){ + cls += ' ' + this.cls; + } + + var cfg = { + tag: (this.href.length) ? 'a' : 'div', + cls: cls, + cn: [ + { + tag: 'div', + cls: 'masonry-brick-split-head', + cn: [ + { + tag: 'div', + cls: 'masonry-brick-paragraph', + cn: [] + } + ] + }, + { + tag: 'div', + cls: 'masonry-brick-split-body', + cn: [] + } + ] + }; + + if(this.href.length){ + cfg.href = this.href; + } + + if(this.title.length){ + cfg.cn[0].cn[0].cn.push({ + tag: 'h4', + cls: 'masonry-brick-title', + html: this.title + }); + } + + if(this.html.length){ + cfg.cn[1].cn.push({ + tag: 'p', + cls: 'masonry-brick-text', + html: this.html + }); + } + + if(this.bgimage.length){ + cfg.cn[0].cn.push({ + tag: 'img', + cls: 'masonry-brick-image-view', + src: this.bgimage + }); + } + + if(this.videourl.length){ + var vurl = this.videourl.replace(/https:\/\/youtu\.be/, 'https://www.youtube.com/embed/'); + // youtube support only? + cfg.cn[0].cn.cn.push({ + tag: 'iframe', + cls: 'masonry-brick-image-view', + src: vurl, + frameborder : 0, + allowfullscreen : true + }); + } + + return cfg; + }, + + initEvents: function() + { + switch (this.size) { + case 'xs' : + this.x = 1; + this.y = 1; + break; + case 'sm' : + this.x = 2; + this.y = 2; + break; + case 'md' : + case 'md-left' : + case 'md-right' : + this.x = 3; + this.y = 3; + break; + case 'tall' : + this.x = 2; + this.y = 3; + break; + case 'wide' : + this.x = 3; + this.y = 2; + break; + case 'wide-thin' : + this.x = 3; + this.y = 1; + break; + + default : + break; + } + + if(Roo.isTouch){ + this.el.on('touchstart', this.onTouchStart, this); + this.el.on('touchmove', this.onTouchMove, this); + this.el.on('touchend', this.onTouchEnd, this); + this.el.on('contextmenu', this.onContextMenu, this); + } else { + this.el.on('mouseenter' ,this.enter, this); + this.el.on('mouseleave', this.leave, this); + this.el.on('click', this.onClick, this); + } + + if (typeof(this.parent().bricks) == 'object' && this.parent().bricks != null) { + this.parent().bricks.push(this); + } + + }, + + onClick: function(e, el) + { + var time = this.endTimer - this.startTimer; + // Roo.log(e.preventDefault()); + if(Roo.isTouch){ + if(time > 1000){ + e.preventDefault(); + return; + } + } + + if(!this.preventDefault){ + return; + } + + e.preventDefault(); + + if (this.activeClass != '') { + this.selectBrick(); + } + + this.fireEvent('click', this, e); + }, + + enter: function(e, el) + { + e.preventDefault(); + + if(!this.isFitContainer || this.maskInverse || this.videourl.length){ + return; + } + + if(this.bgimage.length && this.html.length){ + this.el.select('.masonry-brick-paragraph', true).first().setOpacity(0.9, true); + } + }, + + leave: function(e, el) + { + e.preventDefault(); + + if(!this.isFitContainer || this.maskInverse || this.videourl.length){ + return; + } + + if(this.bgimage.length && this.html.length){ + this.el.select('.masonry-brick-paragraph', true).first().setOpacity(0, true); + } + }, + + onTouchStart: function(e, el) + { +// e.preventDefault(); + + this.touchmoved = false; + + if(!this.isFitContainer){ + return; + } + + if(!this.bgimage.length || !this.html.length){ + return; + } + + this.el.select('.masonry-brick-paragraph', true).first().setOpacity(0.9, true); + + this.timer = new Date().getTime(); + + }, + + onTouchMove: function(e, el) + { + this.touchmoved = true; + }, + + onContextMenu : function(e,el) + { + e.preventDefault(); + e.stopPropagation(); + return false; + }, + + onTouchEnd: function(e, el) + { +// e.preventDefault(); + + if((new Date().getTime() - this.timer > 1000) || !this.href.length || this.touchmoved){ + + this.leave(e,el); + + return; + } + + if(!this.bgimage.length || !this.html.length){ + + if(this.href.length){ + window.location.href = this.href; + } + + return; + } + + if(!this.isFitContainer){ + return; + } + + this.el.select('.masonry-brick-paragraph', true).first().setOpacity(0, true); + + window.location.href = this.href; + }, + + //selection on single brick only + selectBrick : function() { + + if (!this.parentId) { + return; + } + + var m = Roo.bootstrap.LayoutMasonry.get(this.parentId); + var index = m.selectedBrick.indexOf(this.id); + + if ( index > -1) { + m.selectedBrick.splice(index,1); + this.el.removeClass(this.activeClass); + return; + } + + for(var i = 0; i < m.selectedBrick.length; i++) { + var b = Roo.bootstrap.MasonryBrick.get(m.selectedBrick[i]); + b.el.removeClass(b.activeClass); + } + + m.selectedBrick = []; + + m.selectedBrick.push(this.id); + this.el.addClass(this.activeClass); + return; + }, + + isSelected : function(){ + return this.el.hasClass(this.activeClass); + + } +}); + +Roo.apply(Roo.bootstrap.MasonryBrick, { + + //groups: {}, + groups : new Roo.util.MixedCollection(false, function(o) { return o.el.id; }), + /** + * register a Masonry Brick + * @param {Roo.bootstrap.MasonryBrick} the masonry brick to add + */ + + register : function(brick) + { + //this.groups[brick.id] = brick; + this.groups.add(brick.id, brick); + }, + /** + * fetch a masonry brick based on the masonry brick ID + * @param {string} the masonry brick to add + * @returns {Roo.bootstrap.MasonryBrick} the masonry brick + */ + + get: function(brick_id) + { + // if (typeof(this.groups[brick_id]) == 'undefined') { + // return false; + // } + // return this.groups[brick_id] ; + + if(this.groups.key(brick_id)) { + return this.groups.key(brick_id); + } + + return false; + } + + + +}); + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Menu.js.html b/docs2/src/Roo_bootstrap_Menu.js.html new file mode 100644 index 0000000000..37536be715 --- /dev/null +++ b/docs2/src/Roo_bootstrap_Menu.js.html @@ -0,0 +1,432 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Menu.js/* + * - LGPL + * + * menu + * + */ + +/** + * @class Roo.bootstrap.Menu + * @extends Roo.bootstrap.Component + * Bootstrap Menu class - container for MenuItems + * @cfg {String} type (dropdown|treeview|submenu) type of menu + * @cfg {bool} hidden if the menu should be hidden when rendered. + * @cfg {bool} stopEvent (true|false) Stop event after trigger press (default true) + * @cfg {bool} isLink (true|false) the menu has link disable auto expand and collaspe (default false) + * + * @constructor + * Create a new Menu + * @param {Object} config The config object + */ + + +Roo.bootstrap.Menu = function(config){ + Roo.bootstrap.Menu.superclass.constructor.call(this, config); + if (this.registerMenu && this.type != 'treeview') { + Roo.bootstrap.MenuMgr.register(this); + } + + + this.addEvents({ + /** + * @event beforeshow + * Fires before this menu is displayed + * @param {Roo.menu.Menu} this + */ + beforeshow : true, + /** + * @event beforehide + * Fires before this menu is hidden + * @param {Roo.menu.Menu} this + */ + beforehide : true, + /** + * @event show + * Fires after this menu is displayed + * @param {Roo.menu.Menu} this + */ + show : true, + /** + * @event hide + * Fires after this menu is hidden + * @param {Roo.menu.Menu} this + */ + hide : true, + /** + * @event click + * Fires when this menu is clicked (or when the enter key is pressed while it is active) + * @param {Roo.menu.Menu} this + * @param {Roo.menu.Item} menuItem The menu item that was clicked + * @param {Roo.EventObject} e + */ + click : true, + /** + * @event mouseover + * Fires when the mouse is hovering over this menu + * @param {Roo.menu.Menu} this + * @param {Roo.EventObject} e + * @param {Roo.menu.Item} menuItem The menu item that was clicked + */ + mouseover : true, + /** + * @event mouseout + * Fires when the mouse exits this menu + * @param {Roo.menu.Menu} this + * @param {Roo.EventObject} e + * @param {Roo.menu.Item} menuItem The menu item that was clicked + */ + mouseout : true, + /** + * @event itemclick + * Fires when a menu item contained in this menu is clicked + * @param {Roo.menu.BaseItem} baseItem The BaseItem that was clicked + * @param {Roo.EventObject} e + */ + itemclick: true + }); + this.menuitems = new Roo.util.MixedCollection(false, function(o) { return o.el.id; }); +}; + +Roo.extend(Roo.bootstrap.Menu, Roo.bootstrap.Component, { + + /// html : false, + //align : '', + triggerEl : false, // is this set by component builder? -- it should really be fetched from parent()??? + type: false, + /** + * @cfg {Boolean} registerMenu True (default) - means that clicking on screen etc. hides it. + */ + registerMenu : true, + + menuItems :false, // stores the menu items.. + + hidden:true, + + parentMenu : false, + + stopEvent : true, + + isLink : false, + + getChildContainer : function() { + return this.el; + }, + + getAutoCreate : function(){ + + //if (['right'].indexOf(this.align)!==-1) { + // cfg.cn[1].cls += ' pull-right' + //} + + + var cfg = { + tag : 'ul', + cls : 'dropdown-menu' , + style : 'z-index:1000' + + }; + + if (this.type === 'submenu') { + cfg.cls = 'submenu active'; + } + if (this.type === 'treeview') { + cfg.cls = 'treeview-menu'; + } + + return cfg; + }, + initEvents : function() { + + // Roo.log("ADD event"); + // Roo.log(this.triggerEl.dom); + + this.triggerEl.on('click', this.onTriggerClick, this); + + this.triggerEl.on(Roo.isTouch ? 'touchstart' : 'mouseup', this.onTriggerPress, this); + + + if (this.triggerEl.hasClass('nav-item')) { + // dropdown toggle on the 'a' in BS4? + this.triggerEl.select('.nav-link',true).first().addClass('dropdown-toggle'); + } else { + this.triggerEl.addClass('dropdown-toggle'); + } + if (Roo.isTouch) { + this.el.on('touchstart' , this.onTouch, this); + } + this.el.on('click' , this.onClick, this); + + this.el.on("mouseover", this.onMouseOver, this); + this.el.on("mouseout", this.onMouseOut, this); + + }, + + findTargetItem : function(e) + { + var t = e.getTarget(".dropdown-menu-item", this.el, true); + if(!t){ + return false; + } + //Roo.log(t); Roo.log(t.id); + if(t && t.id){ + //Roo.log(this.menuitems); + return this.menuitems.get(t.id); + + //return this.items.get(t.menuItemId); + } + + return false; + }, + + onTouch : function(e) + { + Roo.log("menu.onTouch"); + //e.stopEvent(); this make the user popdown broken + this.onClick(e); + }, + + onClick : function(e) + { + Roo.log("menu.onClick"); + + var t = this.findTargetItem(e); + if(!t || t.isContainer){ + return; + } + Roo.log(e); + /* + if (Roo.isTouch && e.type == 'touchstart' && t.menu && !t.disabled) { + if(t == this.activeItem && t.shouldDeactivate(e)){ + this.activeItem.deactivate(); + delete this.activeItem; + return; + } + if(t.canActivate){ + this.setActiveItem(t, true); + } + return; + + + } + */ + + Roo.log('pass click event'); + + t.onClick(e); + + this.fireEvent("click", this, t, e); + + var _this = this; + + if(!t.href.length || t.href == '#'){ + (function() { _this.hide(); }).defer(100); + } + + }, + + onMouseOver : function(e){ + var t = this.findTargetItem(e); + //Roo.log(t); + //if(t){ + // if(t.canActivate && !t.disabled){ + // this.setActiveItem(t, true); + // } + //} + + this.fireEvent("mouseover", this, e, t); + }, + isVisible : function(){ + return !this.hidden; + }, + onMouseOut : function(e){ + var t = this.findTargetItem(e); + + //if(t ){ + // if(t == this.activeItem && t.shouldDeactivate(e)){ + // this.activeItem.deactivate(); + // delete this.activeItem; + // } + //} + this.fireEvent("mouseout", this, e, t); + }, + + + /** + * Displays this menu relative to another element + * @param {String/HTMLElement/Roo.Element} element The element to align to + * @param {String} position (optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to + * the element (defaults to this.defaultAlign) + * @param {Roo.menu.Menu} parentMenu (optional) This menu's parent menu, if applicable (defaults to undefined) + */ + show : function(el, pos, parentMenu){ + this.parentMenu = parentMenu; + if(!this.el){ + this.render(); + } + this.fireEvent("beforeshow", this); + this.showAt(this.el.getAlignToXY(el, pos || this.defaultAlign), parentMenu, false); + }, + /** + * Displays this menu at a specific xy position + * @param {Array} xyPosition Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based) + * @param {Roo.menu.Menu} parentMenu (optional) This menu's parent menu, if applicable (defaults to undefined) + */ + showAt : function(xy, parentMenu, /* private: */_e){ + this.parentMenu = parentMenu; + if(!this.el){ + this.render(); + } + if(_e !== false){ + this.fireEvent("beforeshow", this); + //xy = this.el.adjustForConstraints(xy); + } + + //this.el.show(); + this.hideMenuItems(); + this.hidden = false; + this.triggerEl.addClass('open'); + this.el.addClass('show'); + + // reassign x when hitting right + if(this.el.getWidth() + xy[0] >= Roo.lib.Dom.getViewWidth()){ + xy[0] = xy[0] - this.el.getWidth() + this.triggerEl.getWidth(); + } + + // reassign y when hitting bottom + if(this.el.getHeight() + xy[1] >= Roo.lib.Dom.getViewHeight()){ + xy[1] = xy[1] - this.el.getHeight() - this.triggerEl.getHeight(); + } + + // but the list may align on trigger left or trigger top... should it be a properity? + + if(this.el.getStyle('top') != 'auto' && this.el.getStyle('top').slice(-1) != "%"){ + this.el.setXY(xy); + } + + this.focus(); + this.fireEvent("show", this); + }, + + focus : function(){ + return; + if(!this.hidden){ + this.doFocus.defer(50, this); + } + }, + + doFocus : function(){ + if(!this.hidden){ + this.focusEl.focus(); + } + }, + + /** + * Hides this menu and optionally all parent menus + * @param {Boolean} deep (optional) True to hide all parent menus recursively, if any (defaults to false) + */ + hide : function(deep) + { + + this.hideMenuItems(); + if(this.el && this.isVisible()){ + this.fireEvent("beforehide", this); + if(this.activeItem){ + this.activeItem.deactivate(); + this.activeItem = null; + } + this.triggerEl.removeClass('open');; + this.el.removeClass('show'); + this.hidden = true; + this.fireEvent("hide", this); + } + if(deep === true && this.parentMenu){ + this.parentMenu.hide(true); + } + }, + + onTriggerClick : function(e) + { + Roo.log('trigger click'); + + var target = e.getTarget(); + + Roo.log(target.nodeName.toLowerCase()); + + if(target.nodeName.toLowerCase() === 'i'){ + e.preventDefault(); + } + + }, + + onTriggerPress : function(e) + { + Roo.log('trigger press'); + //Roo.log(e.getTarget()); + // Roo.log(this.triggerEl.dom); + + // trigger only occurs on normal menu's -- if it's a treeview or dropdown... do not hide/show.. + var pel = Roo.get(e.getTarget()); + if (pel.findParent('.dropdown-menu') || pel.findParent('.treeview-menu') ) { + Roo.log('is treeview or dropdown?'); + return; + } + + if(e.getTarget().nodeName.toLowerCase() !== 'i' && this.isLink){ + return; + } + + if (this.isVisible()) { + Roo.log('hide'); + this.hide(); + } else { + Roo.log('show'); + this.show(this.triggerEl, '?', false); + } + + if(this.stopEvent || e.getTarget().nodeName.toLowerCase() === 'i'){ + e.stopEvent(); + } + + }, + + + hideMenuItems : function() + { + Roo.log("hide Menu Items"); + if (!this.el) { + return; + } + //$(backdrop).remove() + this.el.select('.open',true).each(function(aa) { + + aa.removeClass('open'); + //var parent = getParent($(this)) + //var relatedTarget = { relatedTarget: this } + + //$parent.trigger(e = $.Event('hide.bs.dropdown', relatedTarget)) + //if (e.isDefaultPrevented()) return + //$parent.removeClass('open').trigger('hidden.bs.dropdown', relatedTarget) + }); + }, + addxtypeChild : function (tree, cntr) { + var comp= Roo.bootstrap.Menu.superclass.addxtypeChild.call(this, tree, cntr); + + this.menuitems.add(comp); + return comp; + + }, + getEl : function() + { + Roo.log(this.el); + return this.el; + }, + + clear : function() + { + this.getEl().dom.innerHTML = ''; + this.menuitems.clear(); + } +}); + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_MenuItem.js.html b/docs2/src/Roo_bootstrap_MenuItem.js.html new file mode 100644 index 0000000000..b7d679d72b --- /dev/null +++ b/docs2/src/Roo_bootstrap_MenuItem.js.html @@ -0,0 +1,132 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/MenuItem.js/* + * - LGPL + * + * menu item + * + */ + + +/** + * @class Roo.bootstrap.MenuItem + * @extends Roo.bootstrap.Component + * Bootstrap MenuItem class + * @cfg {String} html the menu label + * @cfg {String} href the link + * @cfg {Boolean} preventDefault do not trigger A href on clicks (default false). + * @cfg {Boolean} isContainer is it a container - just returns a drop down item.. + * @cfg {Boolean} active used on sidebars to highlight active itesm + * @cfg {String} fa favicon to show on left of menu item. + * @cfg {Roo.bootsrap.Menu} menu the child menu. + * + * + * @constructor + * Create a new MenuItem + * @param {Object} config The config object + */ + + +Roo.bootstrap.MenuItem = function(config){ + Roo.bootstrap.MenuItem.superclass.constructor.call(this, config); + this.addEvents({ + // raw events + /** + * @event click + * The raw click event for the entire grid. + * @param {Roo.bootstrap.MenuItem} this + * @param {Roo.EventObject} e + */ + "click" : true + }); +}; + +Roo.extend(Roo.bootstrap.MenuItem, Roo.bootstrap.Component, { + + href : false, + html : false, + preventDefault: false, + isContainer : false, + active : false, + fa: false, + + getAutoCreate : function(){ + + if(this.isContainer){ + return { + tag: 'li', + cls: 'dropdown-menu-item ' + }; + } + var ctag = { + tag: 'span', + html: 'Link' + }; + + var anc = { + tag : 'a', + cls : 'dropdown-item', + href : '#', + cn : [ ] + }; + + if (this.fa !== false) { + anc.cn.push({ + tag : 'i', + cls : 'fa fa-' + this.fa + }); + } + + anc.cn.push(ctag); + + + var cfg= { + tag: 'li', + cls: 'dropdown-menu-item', + cn: [ anc ] + }; + if (this.parent().type == 'treeview') { + cfg.cls = 'treeview-menu'; + } + if (this.active) { + cfg.cls += ' active'; + } + + + + anc.href = this.href || cfg.cn[0].href ; + ctag.html = this.html || cfg.cn[0].html ; + return cfg; + }, + + initEvents: function() + { + if (this.parent().type == 'treeview') { + this.el.select('a').on('click', this.onClick, this); + } + + if (this.menu) { + this.menu.parentType = this.xtype; + this.menu.triggerEl = this.el; + this.menu = this.addxtype(Roo.apply({}, this.menu)); + } + + }, + onClick : function(e) + { + Roo.log('item on click '); + + if(this.preventDefault){ + e.preventDefault(); + } + //this.parent().hideMenuItems(); + + this.fireEvent('click', this, e); + }, + getEl : function() + { + return this.el; + } +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_MenuMgr.js.html b/docs2/src/Roo_bootstrap_MenuMgr.js.html new file mode 100644 index 0000000000..896e60a5a6 --- /dev/null +++ b/docs2/src/Roo_bootstrap_MenuMgr.js.html @@ -0,0 +1,199 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/MenuMgr.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.bootstrap.MenuMgr + * Provides a common registry of all menu items on a page so that they can be easily accessed by id. + * @singleton + */ +Roo.bootstrap.MenuMgr = function(){ + var menus, active, groups = {}, attached = false, lastShow = new Date(); + + // private - called when first menu is created + function init(){ + menus = {}; + active = new Roo.util.MixedCollection(); + Roo.get(document).addKeyListener(27, function(){ + if(active.length > 0){ + hideAll(); + } + }); + } + + // private + function hideAll(){ + if(active && active.length > 0){ + var c = active.clone(); + c.each(function(m){ + m.hide(); + }); + } + } + + // private + function onHide(m){ + active.remove(m); + if(active.length < 1){ + Roo.get(document).un("mouseup", onMouseDown); + + attached = false; + } + } + + // private + function onShow(m){ + var last = active.last(); + lastShow = new Date(); + active.add(m); + if(!attached){ + Roo.get(document).on("mouseup", onMouseDown); + + attached = true; + } + if(m.parentMenu){ + //m.getEl().setZIndex(parseInt(m.parentMenu.getEl().getStyle("z-index"), 10) + 3); + m.parentMenu.activeChild = m; + }else if(last && last.isVisible()){ + //m.getEl().setZIndex(parseInt(last.getEl().getStyle("z-index"), 10) + 3); + } + } + + // private + function onBeforeHide(m){ + if(m.activeChild){ + m.activeChild.hide(); + } + if(m.autoHideTimer){ + clearTimeout(m.autoHideTimer); + delete m.autoHideTimer; + } + } + + // private + function onBeforeShow(m){ + var pm = m.parentMenu; + if(!pm && !m.allowOtherMenus){ + hideAll(); + }else if(pm && pm.activeChild && active != m){ + pm.activeChild.hide(); + } + } + + // private this should really trigger on mouseup.. + function onMouseDown(e){ + Roo.log("on Mouse Up"); + + if(lastShow.getElapsed() > 50 && active.length > 0 && !e.getTarget(".dropdown-menu") && !e.getTarget('.user-menu')){ + Roo.log("MenuManager hideAll"); + hideAll(); + e.stopEvent(); + } + + + } + + // private + function onBeforeCheck(mi, state){ + if(state){ + var g = groups[mi.group]; + for(var i = 0, l = g.length; i < l; i++){ + if(g[i] != mi){ + g[i].setChecked(false); + } + } + } + } + + return { + + /** + * Hides all menus that are currently visible + */ + hideAll : function(){ + hideAll(); + }, + + // private + register : function(menu){ + if(!menus){ + init(); + } + menus[menu.id] = menu; + menu.on("beforehide", onBeforeHide); + menu.on("hide", onHide); + menu.on("beforeshow", onBeforeShow); + menu.on("show", onShow); + var g = menu.group; + if(g && menu.events["checkchange"]){ + if(!groups[g]){ + groups[g] = []; + } + groups[g].push(menu); + menu.on("checkchange", onCheck); + } + }, + + /** + * Returns a {@link Roo.menu.Menu} object + * @param {String/Object} menu The string menu id, an existing menu object reference, or a Menu config that will + * be used to generate and return a new Menu instance. + */ + get : function(menu){ + if(typeof menu == "string"){ // menu id + return menus[menu]; + }else if(menu.events){ // menu instance + return menu; + } + /*else if(typeof menu.length == 'number'){ // array of menu items? + return new Roo.bootstrap.Menu({items:menu}); + }else{ // otherwise, must be a config + return new Roo.bootstrap.Menu(menu); + } + */ + return false; + }, + + // private + unregister : function(menu){ + delete menus[menu.id]; + menu.un("beforehide", onBeforeHide); + menu.un("hide", onHide); + menu.un("beforeshow", onBeforeShow); + menu.un("show", onShow); + var g = menu.group; + if(g && menu.events["checkchange"]){ + groups[g].remove(menu); + menu.un("checkchange", onCheck); + } + }, + + // private + registerCheckable : function(menuItem){ + var g = menuItem.group; + if(g){ + if(!groups[g]){ + groups[g] = []; + } + groups[g].push(menuItem); + menuItem.on("beforecheckchange", onBeforeCheck); + } + }, + + // private + unregisterCheckable : function(menuItem){ + var g = menuItem.group; + if(g){ + groups[g].remove(menuItem); + menuItem.un("beforecheckchange", onBeforeCheck); + } + } + }; +}(); \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_MenuSeparator.js.html b/docs2/src/Roo_bootstrap_MenuSeparator.js.html new file mode 100644 index 0000000000..efba4c7ff4 --- /dev/null +++ b/docs2/src/Roo_bootstrap_MenuSeparator.js.html @@ -0,0 +1,39 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/MenuSeparator.js/* + * - LGPL + * + * menu separator + * + */ + + +/** + * @class Roo.bootstrap.MenuSeparator + * @extends Roo.bootstrap.Component + * Bootstrap MenuSeparator class + * + * @constructor + * Create a new MenuItem + * @param {Object} config The config object + */ + + +Roo.bootstrap.MenuSeparator = function(config){ + Roo.bootstrap.MenuSeparator.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.MenuSeparator, Roo.bootstrap.Component, { + + getAutoCreate : function(){ + var cfg = { + cls: 'divider', + tag : 'li' + }; + + return cfg; + } + +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_MessageBar.js.html b/docs2/src/Roo_bootstrap_MessageBar.js.html new file mode 100644 index 0000000000..fef384f9b1 --- /dev/null +++ b/docs2/src/Roo_bootstrap_MessageBar.js.html @@ -0,0 +1,127 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/MessageBar.js/* + * - LGPL + * + * element + * + */ + +/** + * @class Roo.bootstrap.MessageBar + * @extends Roo.bootstrap.Component + * Bootstrap MessageBar class + * @cfg {String} html contents of the MessageBar + * @cfg {String} weight (info | success | warning | danger) default info + * @cfg {String} beforeClass insert the bar before the given class + * @cfg {Boolean} closable (true | false) default false + * @cfg {Boolean} fixed (true | false) default false, fix the bar at the top + * + * @constructor + * Create a new Element + * @param {Object} config The config object + */ + +Roo.bootstrap.MessageBar = function(config){ + Roo.bootstrap.MessageBar.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.MessageBar, Roo.bootstrap.Component, { + + html: '', + weight: 'info', + closable: false, + fixed: false, + beforeClass: 'bootstrap-sticky-wrap', + + getAutoCreate : function(){ + + var cfg = { + tag: 'div', + cls: 'alert alert-dismissable alert-' + this.weight, + cn: [ + { + tag: 'span', + cls: 'message', + html: this.html || '' + } + ] + }; + + if(this.fixed){ + cfg.cls += ' alert-messages-fixed'; + } + + if(this.closable){ + cfg.cn.push({ + tag: 'button', + cls: 'close', + html: 'x' + }); + } + + return cfg; + }, + + onRender : function(ct, position) + { + Roo.bootstrap.Component.superclass.onRender.call(this, ct, position); + + if(!this.el){ + var cfg = Roo.apply({}, this.getAutoCreate()); + cfg.id = Roo.id(); + + if (this.cls) { + cfg.cls += ' ' + this.cls; + } + if (this.style) { + cfg.style = this.style; + } + this.el = Roo.get(document.body).createChild(cfg, Roo.select('.'+this.beforeClass, true).first()); + + this.el.setVisibilityMode(Roo.Element.DISPLAY); + } + + this.el.select('>button.close').on('click', this.hide, this); + + }, + + show : function() + { + if (!this.rendered) { + this.render(); + } + + this.el.show(); + + this.fireEvent('show', this); + + }, + + hide : function() + { + if (!this.rendered) { + this.render(); + } + + this.el.hide(); + + this.fireEvent('hide', this); + }, + + update : function() + { +// var e = this.el.dom.firstChild; +// +// if(this.closable){ +// e = e.nextSibling; +// } +// +// e.data = this.html || ''; + + this.el.select('>.message', true).first().dom.innerHTML = this.html || ''; + } + +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_MessageBox.js.html b/docs2/src/Roo_bootstrap_MessageBox.js.html new file mode 100644 index 0000000000..70e787fc6d --- /dev/null +++ b/docs2/src/Roo_bootstrap_MessageBox.js.html @@ -0,0 +1,566 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/MessageBox.js/* + * - LGPL + * + * messagebox - can be used as a replace + * + */ +/** + * @class Roo.MessageBox + * Utility class for generating different styles of message boxes. The alias Roo.Msg can also be used. + * Example usage: + *<pre><code> +// Basic alert: +Roo.Msg.alert('Status', 'Changes saved successfully.'); + +// Prompt for user data: +Roo.Msg.prompt('Name', 'Please enter your name:', function(btn, text){ + if (btn == 'ok'){ + // process text value... + } +}); + +// Show a dialog using config options: +Roo.Msg.show({ + title:'Save Changes?', + msg: 'Your are closing a tab that has unsaved changes. Would you like to save your changes?', + buttons: Roo.Msg.YESNOCANCEL, + fn: processResult, + animEl: 'elId' +}); +</code></pre> + * @singleton + */ +Roo.bootstrap.MessageBox = function(){ + var dlg, opt, mask, waitTimer; + var bodyEl, msgEl, textboxEl, textareaEl, progressEl, pp; + var buttons, activeTextEl, bwidth; + + + // private + var handleButton = function(button){ + dlg.hide(); + Roo.callback(opt.fn, opt.scope||window, [button, activeTextEl.dom.value], 1); + }; + + // private + var handleHide = function(){ + if(opt && opt.cls){ + dlg.el.removeClass(opt.cls); + } + //if(waitTimer){ + // Roo.TaskMgr.stop(waitTimer); + // waitTimer = null; + //} + }; + + // private + var updateButtons = function(b){ + var width = 0; + if(!b){ + buttons["ok"].hide(); + buttons["cancel"].hide(); + buttons["yes"].hide(); + buttons["no"].hide(); + dlg.footerEl.hide(); + + return width; + } + dlg.footerEl.show(); + for(var k in buttons){ + if(typeof buttons[k] != "function"){ + if(b[k]){ + buttons[k].show(); + buttons[k].setText(typeof b[k] == "string" ? b[k] : Roo.bootstrap.MessageBox.buttonText[k]); + width += buttons[k].el.getWidth()+15; + }else{ + buttons[k].hide(); + } + } + } + return width; + }; + + // private + var handleEsc = function(d, k, e){ + if(opt && opt.closable !== false){ + dlg.hide(); + } + if(e){ + e.stopEvent(); + } + }; + + return { + /** + * Returns a reference to the underlying {@link Roo.BasicDialog} element + * @return {Roo.BasicDialog} The BasicDialog element + */ + getDialog : function(){ + if(!dlg){ + dlg = new Roo.bootstrap.Modal( { + //draggable: true, + //resizable:false, + //constraintoviewport:false, + //fixedcenter:true, + //collapsible : false, + //shim:true, + //modal: true, + // width: 'auto', + // height:100, + //buttonAlign:"center", + closeClick : function(){ + if(opt && opt.buttons && opt.buttons.no && !opt.buttons.cancel){ + handleButton("no"); + }else{ + handleButton("cancel"); + } + } + }); + dlg.render(); + dlg.on("hide", handleHide); + mask = dlg.mask; + //dlg.addKeyListener(27, handleEsc); + buttons = {}; + this.buttons = buttons; + var bt = this.buttonText; + buttons["ok"] = dlg.addButton(bt["ok"], handleButton.createCallback("ok")); + buttons["yes"] = dlg.addButton(bt["yes"], handleButton.createCallback("yes")); + buttons["no"] = dlg.addButton(bt["no"], handleButton.createCallback("no")); + buttons["cancel"] = dlg.addButton(bt["cancel"], handleButton.createCallback("cancel")); + //Roo.log(buttons); + bodyEl = dlg.bodyEl.createChild({ + + html:'<span class="roo-mb-text"></span><br /><input type="text" class="roo-mb-input" />' + + '<textarea class="roo-mb-textarea"></textarea>' + + '<div class="roo-mb-progress-wrap"><div class="roo-mb-progress"><div class="roo-mb-progress-bar">&#160;</div></div></div>' + }); + msgEl = bodyEl.dom.firstChild; + textboxEl = Roo.get(bodyEl.dom.childNodes[2]); + textboxEl.enableDisplayMode(); + textboxEl.addKeyListener([10,13], function(){ + if(dlg.isVisible() && opt && opt.buttons){ + if(opt.buttons.ok){ + handleButton("ok"); + }else if(opt.buttons.yes){ + handleButton("yes"); + } + } + }); + textareaEl = Roo.get(bodyEl.dom.childNodes[3]); + textareaEl.enableDisplayMode(); + progressEl = Roo.get(bodyEl.dom.childNodes[4]); + progressEl.enableDisplayMode(); + + // This is supposed to be the progessElement.. but I think it's controlling the height of everything.. + var pf = progressEl.dom.firstChild; + if (pf) { + pp = Roo.get(pf.firstChild); + pp.setHeight(pf.offsetHeight); + } + + } + return dlg; + }, + + /** + * Updates the message box body text + * @param {String} text (optional) Replaces the message box element's innerHTML with the specified string (defaults to + * the XHTML-compliant non-breaking space character '&amp;#160;') + * @return {Roo.MessageBox} This message box + */ + updateText : function(text) + { + if(!dlg.isVisible() && !opt.width){ + dlg.dialogEl.setStyle({ 'max-width' : this.maxWidth}); + // dlg.resizeTo(this.maxWidth, 100); // forcing the height breaks long alerts() + } + msgEl.innerHTML = text || '&#160;'; + + var cw = Math.max(msgEl.offsetWidth, msgEl.parentNode.scrollWidth); + //Roo.log("guesed size: " + JSON.stringify([cw,msgEl.offsetWidth, msgEl.parentNode.scrollWidth])); + var w = Math.max( + Math.min(opt.width || cw , this.maxWidth), + Math.max(opt.minWidth || this.minWidth, bwidth) + ); + if(opt.prompt){ + activeTextEl.setWidth(w); + } + if(dlg.isVisible()){ + dlg.fixedcenter = false; + } + // to big, make it scroll. = But as usual stupid IE does not support + // !important.. + + if ( bodyEl.getHeight() > (Roo.lib.Dom.getViewHeight() - 100)) { + bodyEl.setHeight ( Roo.lib.Dom.getViewHeight() - 100 ); + bodyEl.dom.style.overflowY = 'auto' + ( Roo.isIE ? '' : ' !important'); + } else { + bodyEl.dom.style.height = ''; + bodyEl.dom.style.overflowY = ''; + } + if (cw > w) { + bodyEl.dom.style.get = 'auto' + ( Roo.isIE ? '' : ' !important'); + } else { + bodyEl.dom.style.overflowX = ''; + } + + dlg.setContentSize(w, bodyEl.getHeight()); + if(dlg.isVisible()){ + dlg.fixedcenter = true; + } + return this; + }, + + /** + * Updates a progress-style message box's text and progress bar. Only relevant on message boxes + * initiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true. + * @param {Number} value Any number between 0 and 1 (e.g., .5) + * @param {String} text (optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined) + * @return {Roo.MessageBox} This message box + */ + updateProgress : function(value, text){ + if(text){ + this.updateText(text); + } + + if (pp) { // weird bug on my firefox - for some reason this is not defined + pp.setWidth(Math.floor(value*progressEl.dom.firstChild.offsetWidth)); + pp.setHeight(Math.floor(progressEl.dom.firstChild.offsetHeight)); + } + return this; + }, + + /** + * Returns true if the message box is currently displayed + * @return {Boolean} True if the message box is visible, else false + */ + isVisible : function(){ + return dlg && dlg.isVisible(); + }, + + /** + * Hides the message box if it is displayed + */ + hide : function(){ + if(this.isVisible()){ + dlg.hide(); + } + }, + + /** + * Displays a new message box, or reinitializes an existing message box, based on the config options + * passed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally. + * The following config object properties are supported: + * <pre> +Property Type Description +---------- --------------- ------------------------------------------------------------------------------------ +animEl String/Element An id or Element from which the message box should animate as it opens and + closes (defaults to undefined) +buttons Object/Boolean A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo', + cancel:'Bar'}), or false to not show any buttons (defaults to false) +closable Boolean False to hide the top-right close button (defaults to true). Note that + progress and wait dialogs will ignore this property and always hide the + close button as they can only be closed programmatically. +cls String A custom CSS class to apply to the message box element +defaultTextHeight Number The default height in pixels of the message box's multiline textarea if + displayed (defaults to 75) +fn Function A callback function to execute after closing the dialog. The arguments to the + function will be btn (the name of the button that was clicked, if applicable, + e.g. "ok"), and text (the value of the active text field, if applicable). + Progress and wait dialogs will ignore this option since they do not respond to + user actions and can only be closed programmatically, so any required function + should be called by the same code after it closes the dialog. +icon String A CSS class that provides a background image to be used as an icon for + the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '') +maxWidth Number The maximum width in pixels of the message box (defaults to 600) +minWidth Number The minimum width in pixels of the message box (defaults to 100) +modal Boolean False to allow user interaction with the page while the message box is + displayed (defaults to true) +msg String A string that will replace the existing message box body text (defaults + to the XHTML-compliant non-breaking space character '&#160;') +multiline Boolean True to prompt the user to enter multi-line text (defaults to false) +progress Boolean True to display a progress bar (defaults to false) +progressText String The text to display inside the progress bar if progress = true (defaults to '') +prompt Boolean True to prompt the user to enter single-line text (defaults to false) +proxyDrag Boolean True to display a lightweight proxy while dragging (defaults to false) +title String The title text +value String The string value to set into the active textbox element if displayed +wait Boolean True to display a progress bar (defaults to false) +width Number The width of the dialog in pixels +</pre> + * + * Example usage: + * <pre><code> +Roo.Msg.show({ + title: 'Address', + msg: 'Please enter your address:', + width: 300, + buttons: Roo.MessageBox.OKCANCEL, + multiline: true, + fn: saveAddress, + animEl: 'addAddressBtn' +}); +</code></pre> + * @param {Object} config Configuration options + * @return {Roo.MessageBox} This message box + */ + show : function(options) + { + + // this causes nightmares if you show one dialog after another + // especially on callbacks.. + + if(this.isVisible()){ + + this.hide(); + Roo.log("[Roo.Messagebox] Show called while message displayed:" ); + Roo.log("Old Dialog Message:" + msgEl.innerHTML ); + Roo.log("New Dialog Message:" + options.msg ) + //this.alert("ERROR", "Multiple dialogs where displayed at the same time"); + //throw "Roo.MessageBox ERROR : Multiple dialogs where displayed at the same time"; + + } + var d = this.getDialog(); + opt = options; + d.setTitle(opt.title || "&#160;"); + d.closeEl.setDisplayed(opt.closable !== false); + activeTextEl = textboxEl; + opt.prompt = opt.prompt || (opt.multiline ? true : false); + if(opt.prompt){ + if(opt.multiline){ + textboxEl.hide(); + textareaEl.show(); + textareaEl.setHeight(typeof opt.multiline == "number" ? + opt.multiline : this.defaultTextHeight); + activeTextEl = textareaEl; + }else{ + textboxEl.show(); + textareaEl.hide(); + } + }else{ + textboxEl.hide(); + textareaEl.hide(); + } + progressEl.setDisplayed(opt.progress === true); + if (opt.progress) { + d.animate = false; // do not animate progress, as it may not have finished animating before we close it.. + } + this.updateProgress(0); + activeTextEl.dom.value = opt.value || ""; + if(opt.prompt){ + dlg.setDefaultButton(activeTextEl); + }else{ + var bs = opt.buttons; + var db = null; + if(bs && bs.ok){ + db = buttons["ok"]; + }else if(bs && bs.yes){ + db = buttons["yes"]; + } + dlg.setDefaultButton(db); + } + bwidth = updateButtons(opt.buttons); + this.updateText(opt.msg); + if(opt.cls){ + d.el.addClass(opt.cls); + } + d.proxyDrag = opt.proxyDrag === true; + d.modal = opt.modal !== false; + d.mask = opt.modal !== false ? mask : false; + if(!d.isVisible()){ + // force it to the end of the z-index stack so it gets a cursor in FF + document.body.appendChild(dlg.el.dom); + d.animateTarget = null; + d.show(options.animEl); + } + return this; + }, + + /** + * Displays a message box with a progress bar. This message box has no buttons and is not closeable by + * the user. You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress} + * and closing the message box when the process is complete. + * @param {String} title The title bar text + * @param {String} msg The message box body text + * @return {Roo.MessageBox} This message box + */ + progress : function(title, msg){ + this.show({ + title : title, + msg : msg, + buttons: false, + progress:true, + closable:false, + minWidth: this.minProgressWidth, + modal : true + }); + return this; + }, + + /** + * Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert). + * If a callback function is passed it will be called after the user clicks the button, and the + * id of the button that was clicked will be passed as the only parameter to the callback + * (could also be the top-right close button). + * @param {String} title The title bar text + * @param {String} msg The message box body text + * @param {Function} fn (optional) The callback function invoked after the message box is closed + * @param {Object} scope (optional) The scope of the callback function + * @return {Roo.MessageBox} This message box + */ + alert : function(title, msg, fn, scope) + { + this.show({ + title : title, + msg : msg, + buttons: this.OK, + fn: fn, + closable : false, + scope : scope, + modal : true + }); + return this; + }, + + /** + * Displays a message box with an infinitely auto-updating progress bar. This can be used to block user + * interaction while waiting for a long-running process to complete that does not have defined intervals. + * You are responsible for closing the message box when the process is complete. + * @param {String} msg The message box body text + * @param {String} title (optional) The title bar text + * @return {Roo.MessageBox} This message box + */ + wait : function(msg, title){ + this.show({ + title : title, + msg : msg, + buttons: false, + closable:false, + progress:true, + modal:true, + width:300, + wait:true + }); + waitTimer = Roo.TaskMgr.start({ + run: function(i){ + Roo.MessageBox.updateProgress(((((i+20)%20)+1)*5)*.01); + }, + interval: 1000 + }); + return this; + }, + + /** + * Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm). + * If a callback function is passed it will be called after the user clicks either button, and the id of the + * button that was clicked will be passed as the only parameter to the callback (could also be the top-right close button). + * @param {String} title The title bar text + * @param {String} msg The message box body text + * @param {Function} fn (optional) The callback function invoked after the message box is closed + * @param {Object} scope (optional) The scope of the callback function + * @return {Roo.MessageBox} This message box + */ + confirm : function(title, msg, fn, scope){ + this.show({ + title : title, + msg : msg, + buttons: this.YESNO, + fn: fn, + scope : scope, + modal : true + }); + return this; + }, + + /** + * Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to + * JavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function + * is passed it will be called after the user clicks either button, and the id of the button that was clicked + * (could also be the top-right close button) and the text that was entered will be passed as the two + * parameters to the callback. + * @param {String} title The title bar text + * @param {String} msg The message box body text + * @param {Function} fn (optional) The callback function invoked after the message box is closed + * @param {Object} scope (optional) The scope of the callback function + * @param {Boolean/Number} multiline (optional) True to create a multiline textbox using the defaultTextHeight + * property, or the height in pixels to create the textbox (defaults to false / single-line) + * @return {Roo.MessageBox} This message box + */ + prompt : function(title, msg, fn, scope, multiline){ + this.show({ + title : title, + msg : msg, + buttons: this.OKCANCEL, + fn: fn, + minWidth:250, + scope : scope, + prompt:true, + multiline: multiline, + modal : true + }); + return this; + }, + + /** + * Button config that displays a single OK button + * @type Object + */ + OK : {ok:true}, + /** + * Button config that displays Yes and No buttons + * @type Object + */ + YESNO : {yes:true, no:true}, + /** + * Button config that displays OK and Cancel buttons + * @type Object + */ + OKCANCEL : {ok:true, cancel:true}, + /** + * Button config that displays Yes, No and Cancel buttons + * @type Object + */ + YESNOCANCEL : {yes:true, no:true, cancel:true}, + + /** + * The default height in pixels of the message box's multiline textarea if displayed (defaults to 75) + * @type Number + */ + defaultTextHeight : 75, + /** + * The maximum width in pixels of the message box (defaults to 600) + * @type Number + */ + maxWidth : 600, + /** + * The minimum width in pixels of the message box (defaults to 100) + * @type Number + */ + minWidth : 100, + /** + * The minimum width in pixels of the message box if it is a progress-style dialog. This is useful + * for setting a different minimum width than text-only dialogs may need (defaults to 250) + * @type Number + */ + minProgressWidth : 250, + /** + * An object containing the default button text strings that can be overriden for localized language support. + * Supported properties are: ok, cancel, yes and no. + * Customize the default text like so: Roo.MessageBox.buttonText.yes = "S?"; + * @type Object + */ + buttonText : { + ok : "OK", + cancel : "Cancel", + yes : "Yes", + no : "No" + } + }; +}(); + +/** + * Shorthand for {@link Roo.MessageBox} + */ +Roo.MessageBox = Roo.MessageBox || Roo.bootstrap.MessageBox; +Roo.Msg = Roo.Msg || Roo.MessageBox; + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Modal.js.html b/docs2/src/Roo_bootstrap_Modal.js.html new file mode 100644 index 0000000000..60a9542d70 --- /dev/null +++ b/docs2/src/Roo_bootstrap_Modal.js.html @@ -0,0 +1,633 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Modal.js +/* +* Licence: LGPL +*/ + +/** + * @class Roo.bootstrap.Modal + * @extends Roo.bootstrap.Component + * Bootstrap Modal class + * @cfg {String} title Title of dialog + * @cfg {String} html - the body of the dialog (for simple ones) - you can also use template.. + * @cfg {Roo.Template} tmpl - a template with variables. to use it, add a handler in show:method adn + * @cfg {Boolean} specificTitle default false + * @cfg {Array} buttons Array of buttons or standard button set.. + * @cfg {String} buttonPosition (left|right|center) default right (DEPRICATED) - use mr-auto on buttons to put them on the left + * @cfg {Boolean} animate default true + * @cfg {Boolean} allow_close default true + * @cfg {Boolean} fitwindow default false + * @cfg {String} size (sm|lg) default empty + * @cfg {Number} max_width set the max width of modal + * + * + * @constructor + * Create a new Modal Dialog + * @param {Object} config The config object + */ + +Roo.bootstrap.Modal = function(config){ + Roo.bootstrap.Modal.superclass.constructor.call(this, config); + this.addEvents({ + // raw events + /** + * @event btnclick + * The raw btnclick event for the button + * @param {Roo.EventObject} e + */ + "btnclick" : true, + /** + * @event resize + * Fire when dialog resize + * @param {Roo.bootstrap.Modal} this + * @param {Roo.EventObject} e + */ + "resize" : true + }); + this.buttons = this.buttons || []; + + if (this.tmpl) { + this.tmpl = Roo.factory(this.tmpl); + } + +}; + +Roo.extend(Roo.bootstrap.Modal, Roo.bootstrap.Component, { + + title : 'test dialog', + + buttons : false, + + // set on load... + + html: false, + + tmp: false, + + specificTitle: false, + + buttonPosition: 'right', + + allow_close : true, + + animate : true, + + fitwindow: false, + + // private + dialogEl: false, + bodyEl: false, + footerEl: false, + titleEl: false, + closeEl: false, + + size: '', + + max_width: 0, + + max_height: 0, + + fit_content: false, + + onRender : function(ct, position) + { + Roo.bootstrap.Component.superclass.onRender.call(this, ct, position); + + if(!this.el){ + var cfg = Roo.apply({}, this.getAutoCreate()); + cfg.id = Roo.id(); + //if(!cfg.name){ + // cfg.name = typeof(this.name) == 'undefined' ? this.id : this.name; + //} + //if (!cfg.name.length) { + // delete cfg.name; + // } + if (this.cls) { + cfg.cls += ' ' + this.cls; + } + if (this.style) { + cfg.style = this.style; + } + this.el = Roo.get(document.body).createChild(cfg, position); + } + //var type = this.el.dom.type; + + + if(this.tabIndex !== undefined){ + this.el.dom.setAttribute('tabIndex', this.tabIndex); + } + + this.dialogEl = this.el.select('.modal-dialog',true).first(); + this.bodyEl = this.el.select('.modal-body',true).first(); + this.closeEl = this.el.select('.modal-header .close', true).first(); + this.headerEl = this.el.select('.modal-header',true).first(); + this.titleEl = this.el.select('.modal-title',true).first(); + this.footerEl = this.el.select('.modal-footer',true).first(); + + this.maskEl = Roo.DomHelper.append(document.body, {tag: "div", cls:"x-dlg-mask"}, true); + + //this.el.addClass("x-dlg-modal"); + + if (this.buttons.length) { + Roo.each(this.buttons, function(bb) { + var b = Roo.apply({}, bb); + b.xns = b.xns || Roo.bootstrap; + b.xtype = b.xtype || 'Button'; + if (typeof(b.listeners) == 'undefined') { + b.listeners = { click : this.onButtonClick.createDelegate(this) }; + } + + var btn = Roo.factory(b); + + btn.render(this.getButtonContainer()); + + },this); + } + // render the children. + var nitems = []; + + if(typeof(this.items) != 'undefined'){ + var items = this.items; + delete this.items; + + for(var i =0;i < items.length;i++) { + nitems.push(this.addxtype(Roo.apply({}, items[i]))); + } + } + + this.items = nitems; + + // where are these used - they used to be body/close/footer + + + this.initEvents(); + //this.el.addClass([this.fieldClass, this.cls]); + + }, + + getAutoCreate : function() + { + var bdy = { + cls : 'modal-body', + html : this.html || '' + }; + + var title = { + tag: 'h4', + cls : 'modal-title', + html : this.title + }; + + if(this.specificTitle){ + title = this.title; + + } + + var header = []; + if (this.allow_close && Roo.bootstrap.version == 3) { + header.push({ + tag: 'button', + cls : 'close', + html : '&times' + }); + } + + header.push(title); + + if (this.allow_close && Roo.bootstrap.version == 4) { + header.push({ + tag: 'button', + cls : 'close', + html : '&times' + }); + } + + var size = ''; + + if(this.size.length){ + size = 'modal-' + this.size; + } + + var footer = Roo.bootstrap.version == 3 ? + { + cls : 'modal-footer', + cn : [ + { + tag: 'div', + cls: 'btn-' + this.buttonPosition + } + ] + + } : + { // BS4 uses mr-auto on left buttons.... + cls : 'modal-footer' + }; + + + + + + var modal = { + cls: "modal", + cn : [ + { + cls: "modal-dialog " + size, + cn : [ + { + cls : "modal-content", + cn : [ + { + cls : 'modal-header', + cn : header + }, + bdy, + footer + ] + + } + ] + + } + ] + }; + + if(this.animate){ + modal.cls += ' fade'; + } + + return modal; + + }, + getChildContainer : function() { + + return this.bodyEl; + + }, + getButtonContainer : function() { + + return Roo.bootstrap.version == 4 ? + this.el.select('.modal-footer',true).first() + : this.el.select('.modal-footer div',true).first(); + + }, + initEvents : function() + { + if (this.allow_close) { + this.closeEl.on('click', this.hide, this); + } + Roo.EventManager.onWindowResize(this.resize, this, true); + + + }, + + + resize : function() + { + this.maskEl.setSize( + Roo.lib.Dom.getViewWidth(true), + Roo.lib.Dom.getViewHeight(true) + ); + + if (this.fitwindow) { + + + this.setSize( + this.width || Roo.lib.Dom.getViewportWidth(true) - 30, + this.height || Roo.lib.Dom.getViewportHeight(true) // catering margin-top 30 margin-bottom 30 + ); + return; + } + + if(this.max_width !== 0) { + + var w = Math.min(this.max_width, Roo.lib.Dom.getViewportWidth(true) - 30); + + if(this.height) { + this.setSize(w, this.height); + return; + } + + if(this.max_height) { + this.setSize(w,Math.min( + this.max_height, + Roo.lib.Dom.getViewportHeight(true) - 60 + )); + + return; + } + + if(!this.fit_content) { + this.setSize(w, Roo.lib.Dom.getViewportHeight(true) - 60); + return; + } + + this.setSize(w, Math.min( + 60 + + this.headerEl.getHeight() + + this.footerEl.getHeight() + + this.getChildHeight(this.bodyEl.dom.childNodes), + Roo.lib.Dom.getViewportHeight(true) - 60) + ); + } + + }, + + setSize : function(w,h) + { + if (!w && !h) { + return; + } + + this.resizeTo(w,h); + }, + + show : function() { + + if (!this.rendered) { + this.render(); + } + + //this.el.setStyle('display', 'block'); + this.el.removeClass('hideing'); + this.el.dom.style.display='block'; + + Roo.get(document.body).addClass('modal-open'); + + if(this.animate){ // element has 'fade' - so stuff happens after .3s ?- not sure why the delay? + + (function(){ + this.el.addClass('show'); + this.el.addClass('in'); + }).defer(50, this); + }else{ + this.el.addClass('show'); + this.el.addClass('in'); + } + + // not sure how we can show data in here.. + //if (this.tmpl) { + // this.getChildContainer().dom.innerHTML = this.tmpl.applyTemplate(this); + //} + + Roo.get(document.body).addClass("x-body-masked"); + + this.maskEl.setSize(Roo.lib.Dom.getViewWidth(true), Roo.lib.Dom.getViewHeight(true)); + this.maskEl.setStyle('z-index', Roo.bootstrap.Modal.zIndex++); + this.maskEl.dom.style.display = 'block'; + this.maskEl.addClass('show'); + + + this.resize(); + + this.fireEvent('show', this); + + // set zindex here - otherwise it appears to be ignored... + this.el.setStyle('z-index', Roo.bootstrap.Modal.zIndex++); + + (function () { + this.items.forEach( function(e) { + e.layout ? e.layout() : false; + + }); + }).defer(100,this); + + }, + hide : function() + { + if(this.fireEvent("beforehide", this) !== false){ + + this.maskEl.removeClass('show'); + + this.maskEl.dom.style.display = ''; + Roo.get(document.body).removeClass("x-body-masked"); + this.el.removeClass('in'); + this.el.select('.modal-dialog', true).first().setStyle('transform',''); + + if(this.animate){ // why + this.el.addClass('hideing'); + this.el.removeClass('show'); + (function(){ + if (!this.el.hasClass('hideing')) { + return; // it's been shown again... + } + + this.el.dom.style.display=''; + + Roo.get(document.body).removeClass('modal-open'); + this.el.removeClass('hideing'); + }).defer(150,this); + + }else{ + this.el.removeClass('show'); + this.el.dom.style.display=''; + Roo.get(document.body).removeClass('modal-open'); + + } + this.fireEvent('hide', this); + } + }, + isVisible : function() + { + + return this.el.hasClass('show') && !this.el.hasClass('hideing'); + + }, + + addButton : function(str, cb) + { + + + var b = Roo.apply({}, { html : str } ); + b.xns = b.xns || Roo.bootstrap; + b.xtype = b.xtype || 'Button'; + if (typeof(b.listeners) == 'undefined') { + b.listeners = { click : cb.createDelegate(this) }; + } + + var btn = Roo.factory(b); + + btn.render(this.getButtonContainer()); + + return btn; + + }, + + setDefaultButton : function(btn) + { + //this.el.select('.modal-footer').() + }, + + resizeTo: function(w,h) + { + this.dialogEl.setWidth(w); + + var diff = this.headerEl.getHeight() + this.footerEl.getHeight() + 60; // dialog margin-bottom: 30 + + this.bodyEl.setHeight(h - diff); + + this.fireEvent('resize', this); + }, + + setContentSize : function(w, h) + { + + }, + onButtonClick: function(btn,e) + { + //Roo.log([a,b,c]); + this.fireEvent('btnclick', btn.name, e); + }, + /** + * Set the title of the Dialog + * @param {String} str new Title + */ + setTitle: function(str) { + this.titleEl.dom.innerHTML = str; + }, + /** + * Set the body of the Dialog + * @param {String} str new Title + */ + setBody: function(str) { + this.bodyEl.dom.innerHTML = str; + }, + /** + * Set the body of the Dialog using the template + * @param {Obj} data - apply this data to the template and replace the body contents. + */ + applyBody: function(obj) + { + if (!this.tmpl) { + Roo.log("Error - using apply Body without a template"); + //code + } + this.tmpl.overwrite(this.bodyEl, obj); + }, + + getChildHeight : function(child_nodes) + { + if( + !child_nodes || + child_nodes.length == 0 + ) { + return; + } + + var child_height = 0; + + for(var i = 0; i < child_nodes.length; i++) { + + /* + * for modal with tabs... + if(child_nodes[i].classList.contains('roo-layout-panel')) { + + var layout_childs = child_nodes[i].childNodes; + + for(var j = 0; j < layout_childs.length; j++) { + + if(layout_childs[j].classList.contains('roo-layout-panel-body')) { + + var layout_body_childs = layout_childs[j].childNodes; + + for(var k = 0; k < layout_body_childs.length; k++) { + + if(layout_body_childs[k].classList.contains('navbar')) { + child_height += layout_body_childs[k].offsetHeight; + continue; + } + + if(layout_body_childs[k].classList.contains('roo-layout-tabs-body')) { + + var layout_body_tab_childs = layout_body_childs[k].childNodes; + + for(var m = 0; m < layout_body_tab_childs.length; m++) { + + if(layout_body_tab_childs[m].classList.contains('roo-layout-active-content')) { + child_height += this.getChildHeight(layout_body_tab_childs[m].childNodes); + continue; + } + + } + + } + + } + } + } + continue; + } + */ + + child_height += child_nodes[i].offsetHeight; + // Roo.log(child_nodes[i].offsetHeight); + } + + return child_height; + } + +}); + + +Roo.apply(Roo.bootstrap.Modal, { + /** + * Button config that displays a single OK button + * @type Object + */ + OK : [{ + name : 'ok', + weight : 'primary', + html : 'OK' + }], + /** + * Button config that displays Yes and No buttons + * @type Object + */ + YESNO : [ + { + name : 'no', + html : 'No' + }, + { + name :'yes', + weight : 'primary', + html : 'Yes' + } + ], + + /** + * Button config that displays OK and Cancel buttons + * @type Object + */ + OKCANCEL : [ + { + name : 'cancel', + html : 'Cancel' + }, + { + name : 'ok', + weight : 'primary', + html : 'OK' + } + ], + /** + * Button config that displays Yes, No and Cancel buttons + * @type Object + */ + YESNOCANCEL : [ + { + name : 'yes', + weight : 'primary', + html : 'Yes' + }, + { + name : 'no', + html : 'No' + }, + { + name : 'cancel', + html : 'Cancel' + } + ], + + zIndex : 10001 +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_MoneyField.js.html b/docs2/src/Roo_bootstrap_MoneyField.js.html new file mode 100644 index 0000000000..489ea795c2 --- /dev/null +++ b/docs2/src/Roo_bootstrap_MoneyField.js.html @@ -0,0 +1,720 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/MoneyField.js +/** + * @class Roo.bootstrap.MoneyField + * @extends Roo.bootstrap.ComboBox + * Bootstrap MoneyField class + * + * @constructor + * Create a new MoneyField. + * @param {Object} config Configuration options + */ + +Roo.bootstrap.MoneyField = function(config) { + + Roo.bootstrap.MoneyField.superclass.constructor.call(this, config); + +}; + +Roo.extend(Roo.bootstrap.MoneyField, Roo.bootstrap.ComboBox, { + + /** + * @cfg {Boolean} allowDecimals False to disallow decimal values (defaults to true) + */ + allowDecimals : true, + /** + * @cfg {String} decimalSeparator Character(s) to allow as the decimal separator (defaults to '.') + */ + decimalSeparator : ".", + /** + * @cfg {Number} decimalPrecision The maximum precision to display after the decimal separator (defaults to 2) + */ + decimalPrecision : 0, + /** + * @cfg {Boolean} allowNegative False to prevent entering a negative sign (defaults to true) + */ + allowNegative : true, + /** + * @cfg {Boolean} allowZero False to blank out if the user enters '0' (defaults to true) + */ + allowZero: true, + /** + * @cfg {Number} minValue The minimum allowed value (defaults to Number.NEGATIVE_INFINITY) + */ + minValue : Number.NEGATIVE_INFINITY, + /** + * @cfg {Number} maxValue The maximum allowed value (defaults to Number.MAX_VALUE) + */ + maxValue : Number.MAX_VALUE, + /** + * @cfg {String} minText Error text to display if the minimum value validation fails (defaults to "The minimum value for this field is {minValue}") + */ + minText : "The minimum value for this field is {0}", + /** + * @cfg {String} maxText Error text to display if the maximum value validation fails (defaults to "The maximum value for this field is {maxValue}") + */ + maxText : "The maximum value for this field is {0}", + /** + * @cfg {String} nanText Error text to display if the value is not a valid number. For example, this can happen + * if a valid character like '.' or '-' is left in the field with no number (defaults to "{value} is not a valid number") + */ + nanText : "{0} is not a valid number", + /** + * @cfg {Boolean} castInt (true|false) cast int if true (defalut true) + */ + castInt : true, + /** + * @cfg {String} defaults currency of the MoneyField + * value should be in lkey + */ + defaultCurrency : false, + /** + * @cfg {String} thousandsDelimiter Symbol of thousandsDelimiter + */ + thousandsDelimiter : false, + /** + * @cfg {Number} max_length Maximum input field length allowed (defaults to Number.MAX_VALUE) + */ + max_length: false, + + inputlg : 9, + inputmd : 9, + inputsm : 9, + inputxs : 6, + + store : false, + + getAutoCreate : function() + { + var align = this.labelAlign || this.parentLabelAlign(); + + var id = Roo.id(); + + var cfg = { + cls: 'form-group', + cn: [] + }; + + var input = { + tag: 'input', + id : id, + cls : 'form-control roo-money-amount-input', + autocomplete: 'new-password' + }; + + var hiddenInput = { + tag: 'input', + type: 'hidden', + id: Roo.id(), + cls: 'hidden-number-input' + }; + + if(this.max_length) { + input.maxlength = this.max_length; + } + + if (this.name) { + hiddenInput.name = this.name; + } + + if (this.disabled) { + input.disabled = true; + } + + var clg = 12 - this.inputlg; + var cmd = 12 - this.inputmd; + var csm = 12 - this.inputsm; + var cxs = 12 - this.inputxs; + + var container = { + tag : 'div', + cls : 'row roo-money-field', + cn : [ + { + tag : 'div', + cls : 'roo-money-currency column col-lg-' + clg + ' col-md-' + cmd + ' col-sm-' + csm + ' col-xs-' + cxs, + cn : [ + { + tag : 'div', + cls: 'roo-select2-container input-group', + cn: [ + { + tag : 'input', + cls : 'form-control roo-money-currency-input', + autocomplete: 'new-password', + readOnly : 1, + name : this.currencyName + }, + { + tag :'span', + cls : 'input-group-addon', + cn : [ + { + tag: 'span', + cls: 'caret' + } + ] + } + ] + } + ] + }, + { + tag : 'div', + cls : 'roo-money-amount column col-lg-' + this.inputlg + ' col-md-' + this.inputmd + ' col-sm-' + this.inputsm + ' col-xs-' + this.inputxs, + cn : [ + { + tag: 'div', + cls: this.hasFeedback ? 'has-feedback' : '', + cn: [ + input + ] + } + ] + } + ] + + }; + + if (this.fieldLabel.length) { + var indicator = { + tag: 'i', + tooltip: 'This field is required' + }; + + var label = { + tag: 'label', + 'for': id, + cls: 'control-label', + cn: [] + }; + + var label_text = { + tag: 'span', + html: this.fieldLabel + }; + + indicator.cls = 'roo-required-indicator text-danger fa fa-lg fa-star left-indicator'; + label.cn = [ + indicator, + label_text + ]; + + if(this.indicatorpos == 'right') { + indicator.cls = 'roo-required-indicator text-danger fa fa-lg fa-star right-indicator'; + label.cn = [ + label_text, + indicator + ]; + } + + if(align == 'left') { + container = { + tag: 'div', + cn: [ + container + ] + }; + + if(this.labelWidth > 12){ + label.style = "width: " + this.labelWidth + 'px'; + } + if(this.labelWidth < 13 && this.labelmd == 0){ + this.labelmd = this.labelWidth; + } + if(this.labellg > 0){ + label.cls += ' col-lg-' + this.labellg; + input.cls += ' col-lg-' + (12 - this.labellg); + } + if(this.labelmd > 0){ + label.cls += ' col-md-' + this.labelmd; + container.cls += ' col-md-' + (12 - this.labelmd); + } + if(this.labelsm > 0){ + label.cls += ' col-sm-' + this.labelsm; + container.cls += ' col-sm-' + (12 - this.labelsm); + } + if(this.labelxs > 0){ + label.cls += ' col-xs-' + this.labelxs; + container.cls += ' col-xs-' + (12 - this.labelxs); + } + } + } + + cfg.cn = [ + label, + container, + hiddenInput + ]; + + var settings = this; + + ['xs','sm','md','lg'].map(function(size){ + if (settings[size]) { + cfg.cls += ' col-' + size + '-' + settings[size]; + } + }); + + return cfg; + }, + + initEvents : function() + { + this.indicator = this.indicatorEl(); + + this.initCurrencyEvent(); + + this.initNumberEvent(); + }, + + initCurrencyEvent : function() + { + if (!this.store) { + throw "can not find store for combo"; + } + + this.store = Roo.factory(this.store, Roo.data); + this.store.parent = this; + + this.createList(); + + this.triggerEl = this.el.select('.input-group-addon', true).first(); + + this.triggerEl.on("click", this.onTriggerClick, this, { preventDefault : true }); + + var _this = this; + + (function(){ + var lw = _this.listWidth || Math.max(_this.inputEl().getWidth(), _this.minListWidth); + _this.list.setWidth(lw); + }).defer(100); + + this.list.on('mouseover', this.onViewOver, this); + this.list.on('mousemove', this.onViewMove, this); + this.list.on('scroll', this.onViewScroll, this); + + if(!this.tpl){ + this.tpl = '<li><a href="#">{' + this.currencyField + '}</a></li>'; + } + + this.view = new Roo.View(this.list, this.tpl, { + singleSelect:true, store: this.store, selectedClass: this.selectedClass + }); + + this.view.on('click', this.onViewClick, this); + + this.store.on('beforeload', this.onBeforeLoad, this); + this.store.on('load', this.onLoad, this); + this.store.on('loadexception', this.onLoadException, this); + + this.keyNav = new Roo.KeyNav(this.currencyEl(), { + "up" : function(e){ + this.inKeyMode = true; + this.selectPrev(); + }, + + "down" : function(e){ + if(!this.isExpanded()){ + this.onTriggerClick(); + }else{ + this.inKeyMode = true; + this.selectNext(); + } + }, + + "enter" : function(e){ + this.collapse(); + + if(this.fireEvent("specialkey", this, e)){ + this.onViewClick(false); + } + + return true; + }, + + "esc" : function(e){ + this.collapse(); + }, + + "tab" : function(e){ + this.collapse(); + + if(this.fireEvent("specialkey", this, e)){ + this.onViewClick(false); + } + + return true; + }, + + scope : this, + + doRelay : function(foo, bar, hname){ + if(hname == 'down' || this.scope.isExpanded()){ + return Roo.KeyNav.prototype.doRelay.apply(this, arguments); + } + return true; + }, + + forceKeyDown: true + }); + + this.currencyEl().on("click", this.onTriggerClick, this, { preventDefault : true }); + + }, + + initNumberEvent : function(e) + { + this.inputEl().on("keydown" , this.fireKey, this); + this.inputEl().on("focus", this.onFocus, this); + this.inputEl().on("blur", this.onBlur, this); + + this.inputEl().relayEvent('keyup', this); + + if(this.indicator){ + this.indicator.addClass('invisible'); + } + + this.originalValue = this.getValue(); + + if(this.validationEvent == 'keyup'){ + this.validationTask = new Roo.util.DelayedTask(this.validate, this); + this.inputEl().on('keyup', this.filterValidation, this); + } + else if(this.validationEvent !== false){ + this.inputEl().on(this.validationEvent, this.validate, this, {buffer: this.validationDelay}); + } + + if(this.selectOnFocus){ + this.on("focus", this.preFocus, this); + + } + if(this.maskRe || (this.vtype && this.disableKeyFilter !== true && (this.maskRe = Roo.form.VTypes[this.vtype+'Mask']))){ + this.inputEl().on("keypress", this.filterKeys, this); + } else { + this.inputEl().relayEvent('keypress', this); + } + + var allowed = "0123456789"; + + if(this.allowDecimals){ + allowed += this.decimalSeparator; + } + + if(this.allowNegative){ + allowed += "-"; + } + + if(this.thousandsDelimiter) { + allowed += ","; + } + + this.stripCharsRe = new RegExp('[^'+allowed+']', 'gi'); + + var keyPress = function(e){ + + var k = e.getKey(); + + var c = e.getCharCode(); + + if( + (String.fromCharCode(c) == '.' || String.fromCharCode(c) == '-') && + allowed.indexOf(String.fromCharCode(c)) === -1 + ){ + e.stopEvent(); + return; + } + + if(!Roo.isIE && (e.isSpecialKey() || k == e.BACKSPACE || k == e.DELETE)){ + return; + } + + if(allowed.indexOf(String.fromCharCode(c)) === -1){ + e.stopEvent(); + } + }; + + this.inputEl().on("keypress", keyPress, this); + + }, + + onTriggerClick : function(e) + { + if(this.disabled){ + return; + } + + this.page = 0; + this.loadNext = false; + + if(this.isExpanded()){ + this.collapse(); + return; + } + + this.hasFocus = true; + + if(this.triggerAction == 'all') { + this.doQuery(this.allQuery, true); + return; + } + + this.doQuery(this.getRawValue()); + }, + + getCurrency : function() + { + var v = this.currencyEl().getValue(); + + return v; + }, + + restrictHeight : function() + { + this.list.alignTo(this.currencyEl(), this.listAlign); + this.list.alignTo(this.currencyEl(), this.listAlign); + }, + + onViewClick : function(view, doFocus, el, e) + { + var index = this.view.getSelectedIndexes()[0]; + + var r = this.store.getAt(index); + + if(r){ + this.onSelect(r, index); + } + }, + + onSelect : function(record, index){ + + if(this.fireEvent('beforeselect', this, record, index) !== false){ + + this.setFromCurrencyData(index > -1 ? record.data : false); + + this.collapse(); + + this.fireEvent('select', this, record, index); + } + }, + + setFromCurrencyData : function(o) + { + var currency = ''; + + this.lastCurrency = o; + + if (this.currencyField) { + currency = !o || typeof(o[this.currencyField]) == 'undefined' ? '' : o[this.currencyField]; + } else { + Roo.log('no currencyField value set for '+ (this.name ? this.name : this.id)); + } + + this.lastSelectionText = currency; + + //setting default currency + if(o[this.currencyField] * 1 == 0 && this.defaultCurrency) { + this.setCurrency(this.defaultCurrency); + return; + } + + this.setCurrency(currency); + }, + + setFromData : function(o) + { + var c = {}; + + c[this.currencyField] = !o || typeof(o[this.currencyName]) == 'undefined' ? '' : o[this.currencyName]; + + this.setFromCurrencyData(c); + + var value = ''; + + if (this.name) { + value = !o || typeof(o[this.name]) == 'undefined' ? '' : o[this.name]; + } else { + Roo.log('no value set for '+ (this.name ? this.name : this.id)); + } + + this.setValue(value); + + }, + + setCurrency : function(v) + { + this.currencyValue = v; + + if(this.rendered){ + this.currencyEl().dom.value = (v === null || v === undefined ? '' : v); + this.validate(); + } + }, + + setValue : function(v) + { + v = String(this.fixPrecision(v)).replace(".", this.decimalSeparator); + + this.value = v; + + if(this.rendered){ + + this.hiddenEl().dom.value = (v === null || v === undefined ? '' : v); + + this.inputEl().dom.value = (v == '') ? '' : + Roo.util.Format.number(v, this.decimalPrecision, this.thousandsDelimiter || ''); + + if(!this.allowZero && v === '0') { + this.hiddenEl().dom.value = ''; + this.inputEl().dom.value = ''; + } + + this.validate(); + } + }, + + getRawValue : function() + { + var v = this.inputEl().getValue(); + + return v; + }, + + getValue : function() + { + return this.fixPrecision(this.parseValue(this.getRawValue())); + }, + + parseValue : function(value) + { + if(this.thousandsDelimiter) { + value += ""; + r = new RegExp(",", "g"); + value = value.replace(r, ""); + } + + value = parseFloat(String(value).replace(this.decimalSeparator, ".")); + return isNaN(value) ? '' : value; + + }, + + fixPrecision : function(value) + { + if(this.thousandsDelimiter) { + value += ""; + r = new RegExp(",", "g"); + value = value.replace(r, ""); + } + + var nan = isNaN(value); + + if(!this.allowDecimals || this.decimalPrecision == -1 || nan || !value){ + return nan ? '' : value; + } + return parseFloat(value).toFixed(this.decimalPrecision); + }, + + decimalPrecisionFcn : function(v) + { + return Math.floor(v); + }, + + validateValue : function(value) + { + if(!Roo.bootstrap.MoneyField.superclass.validateValue.call(this, value)){ + return false; + } + + var num = this.parseValue(value); + + if(isNaN(num)){ + this.markInvalid(String.format(this.nanText, value)); + return false; + } + + if(num < this.minValue){ + this.markInvalid(String.format(this.minText, this.minValue)); + return false; + } + + if(num > this.maxValue){ + this.markInvalid(String.format(this.maxText, this.maxValue)); + return false; + } + + return true; + }, + + validate : function() + { + if(this.disabled || this.allowBlank){ + this.markValid(); + return true; + } + + var currency = this.getCurrency(); + + if(this.validateValue(this.getRawValue()) && currency.length){ + this.markValid(); + return true; + } + + this.markInvalid(); + return false; + }, + + getName: function() + { + return this.name; + }, + + beforeBlur : function() + { + if(!this.castInt){ + return; + } + + var v = this.parseValue(this.getRawValue()); + + if(v || v == 0){ + this.setValue(v); + } + }, + + onBlur : function() + { + this.beforeBlur(); + + if(!Roo.isOpera && this.focusClass){ // don't touch in Opera + //this.el.removeClass(this.focusClass); + } + + this.hasFocus = false; + + if(this.validationEvent !== false && this.validateOnBlur && this.validationEvent != "blur"){ + this.validate(); + } + + var v = this.getValue(); + + if(String(v) !== String(this.startValue)){ + this.fireEvent('change', this, v, this.startValue); + } + + this.fireEvent("blur", this); + }, + + inputEl : function() + { + return this.el.select('.roo-money-amount-input', true).first(); + }, + + currencyEl : function() + { + return this.el.select('.roo-money-currency-input', true).first(); + }, + + hiddenEl : function() + { + return this.el.select('input.hidden-number-input',true).first(); + } + +}); \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_MonthField.js.html b/docs2/src/Roo_bootstrap_MonthField.js.html new file mode 100644 index 0000000000..cddee841a1 --- /dev/null +++ b/docs2/src/Roo_bootstrap_MonthField.js.html @@ -0,0 +1,393 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/MonthField.js/* + * - LGPL + * + * MonthField + * + */ + +/** + * @class Roo.bootstrap.MonthField + * @extends Roo.bootstrap.Input + * Bootstrap MonthField class + * + * @cfg {String} language default en + * + * @constructor + * Create a new MonthField + * @param {Object} config The config object + */ + +Roo.bootstrap.MonthField = function(config){ + Roo.bootstrap.MonthField.superclass.constructor.call(this, config); + + this.addEvents({ + /** + * @event show + * Fires when this field show. + * @param {Roo.bootstrap.MonthField} this + * @param {Mixed} date The date value + */ + show : true, + /** + * @event show + * Fires when this field hide. + * @param {Roo.bootstrap.MonthField} this + * @param {Mixed} date The date value + */ + hide : true, + /** + * @event select + * Fires when select a date. + * @param {Roo.bootstrap.MonthField} this + * @param {String} oldvalue The old value + * @param {String} newvalue The new value + */ + select : true + }); +}; + +Roo.extend(Roo.bootstrap.MonthField, Roo.bootstrap.Input, { + + onRender: function(ct, position) + { + + Roo.bootstrap.MonthField.superclass.onRender.call(this, ct, position); + + this.language = this.language || 'en'; + this.language = this.language in Roo.bootstrap.MonthField.dates ? this.language : this.language.split('-')[0]; + this.language = this.language in Roo.bootstrap.MonthField.dates ? this.language : "en"; + + this.isRTL = Roo.bootstrap.MonthField.dates[this.language].rtl || false; + this.isInline = false; + this.isInput = true; + this.component = this.el.select('.add-on', true).first() || false; + this.component = (this.component && this.component.length === 0) ? false : this.component; + this.hasInput = this.component && this.inputEL().length; + + this.pickerEl = Roo.get(document.body).createChild(Roo.bootstrap.MonthField.template); + + this.picker().setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + + this.picker().on('mousedown', this.onMousedown, this); + this.picker().on('click', this.onClick, this); + + this.picker().addClass('datepicker-dropdown'); + + Roo.each(this.picker().select('tbody > tr > td', true).elements, function(v){ + v.setStyle('width', '189px'); + }); + + this.fillMonths(); + + this.update(); + + if(this.isInline) { + this.show(); + } + + }, + + setValue: function(v, suppressEvent) + { + var o = this.getValue(); + + Roo.bootstrap.MonthField.superclass.setValue.call(this, v); + + this.update(); + + if(suppressEvent !== true){ + this.fireEvent('select', this, o, v); + } + + }, + + getValue: function() + { + return this.value; + }, + + onClick: function(e) + { + e.stopPropagation(); + e.preventDefault(); + + var target = e.getTarget(); + + if(target.nodeName.toLowerCase() === 'i'){ + target = Roo.get(target).dom.parentNode; + } + + var nodeName = target.nodeName; + var className = target.className; + var html = target.innerHTML; + + if(nodeName.toLowerCase() != 'span' || className.indexOf('disabled') > -1 || className.indexOf('month') == -1){ + return; + } + + this.vIndex = Roo.bootstrap.MonthField.dates[this.language].monthsShort.indexOf(html); + + this.setValue(Roo.bootstrap.MonthField.dates[this.language].months[this.vIndex]); + + this.hide(); + + }, + + picker : function() + { + return this.pickerEl; + }, + + fillMonths: function() + { + var i = 0; + var months = this.picker().select('>.datepicker-months td', true).first(); + + months.dom.innerHTML = ''; + + while (i < 12) { + var month = { + tag: 'span', + cls: 'month', + html: Roo.bootstrap.MonthField.dates[this.language].monthsShort[i++] + }; + + months.createChild(month); + } + + }, + + update: function() + { + var _this = this; + + if(typeof(this.vIndex) == 'undefined' && this.value.length){ + this.vIndex = Roo.bootstrap.MonthField.dates[this.language].months.indexOf(this.value); + } + + Roo.each(this.pickerEl.select('> .datepicker-months tbody > tr > td > span', true).elements, function(e, k){ + e.removeClass('active'); + + if(typeof(_this.vIndex) != 'undefined' && k == _this.vIndex){ + e.addClass('active'); + } + }) + }, + + place: function() + { + if(this.isInline) { + return; + } + + this.picker().removeClass(['bottom', 'top']); + + if((Roo.lib.Dom.getViewHeight() + Roo.get(document.body).getScroll().top) - (this.inputEl().getBottom() + this.picker().getHeight()) < 0){ + /* + * place to the top of element! + * + */ + + this.picker().addClass('top'); + this.picker().setTop(this.inputEl().getTop() - this.picker().getHeight()).setLeft(this.inputEl().getLeft()); + + return; + } + + this.picker().addClass('bottom'); + + this.picker().setTop(this.inputEl().getBottom()).setLeft(this.inputEl().getLeft()); + }, + + onFocus : function() + { + Roo.bootstrap.MonthField.superclass.onFocus.call(this); + this.show(); + }, + + onBlur : function() + { + Roo.bootstrap.MonthField.superclass.onBlur.call(this); + + var d = this.inputEl().getValue(); + + this.setValue(d); + + this.hide(); + }, + + show : function() + { + this.picker().show(); + this.picker().select('>.datepicker-months', true).first().show(); + this.update(); + this.place(); + + this.fireEvent('show', this, this.date); + }, + + hide : function() + { + if(this.isInline) { + return; + } + this.picker().hide(); + this.fireEvent('hide', this, this.date); + + }, + + onMousedown: function(e) + { + e.stopPropagation(); + e.preventDefault(); + }, + + keyup: function(e) + { + Roo.bootstrap.MonthField.superclass.keyup.call(this); + this.update(); + }, + + fireKey: function(e) + { + if (!this.picker().isVisible()){ + if (e.keyCode == 27) {// allow escape to hide and re-show picker + this.show(); + } + return; + } + + var dir; + + switch(e.keyCode){ + case 27: // escape + this.hide(); + e.preventDefault(); + break; + case 37: // left + case 39: // right + dir = e.keyCode == 37 ? -1 : 1; + + this.vIndex = this.vIndex + dir; + + if(this.vIndex < 0){ + this.vIndex = 0; + } + + if(this.vIndex > 11){ + this.vIndex = 11; + } + + if(isNaN(this.vIndex)){ + this.vIndex = 0; + } + + this.setValue(Roo.bootstrap.MonthField.dates[this.language].months[this.vIndex]); + + break; + case 38: // up + case 40: // down + + dir = e.keyCode == 38 ? -1 : 1; + + this.vIndex = this.vIndex + dir * 4; + + if(this.vIndex < 0){ + this.vIndex = 0; + } + + if(this.vIndex > 11){ + this.vIndex = 11; + } + + if(isNaN(this.vIndex)){ + this.vIndex = 0; + } + + this.setValue(Roo.bootstrap.MonthField.dates[this.language].months[this.vIndex]); + break; + + case 13: // enter + + if(typeof(this.vIndex) != 'undefined' && !isNaN(this.vIndex)){ + this.setValue(Roo.bootstrap.MonthField.dates[this.language].months[this.vIndex]); + } + + this.hide(); + e.preventDefault(); + break; + case 9: // tab + if(typeof(this.vIndex) != 'undefined' && !isNaN(this.vIndex)){ + this.setValue(Roo.bootstrap.MonthField.dates[this.language].months[this.vIndex]); + } + this.hide(); + break; + case 16: // shift + case 17: // ctrl + case 18: // alt + break; + default : + this.hide(); + + } + }, + + remove: function() + { + this.picker().remove(); + } + +}); + +Roo.apply(Roo.bootstrap.MonthField, { + + content : { + tag: 'tbody', + cn: [ + { + tag: 'tr', + cn: [ + { + tag: 'td', + colspan: '7' + } + ] + } + ] + }, + + dates:{ + en: { + months: ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"], + monthsShort: ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"] + } + } +}); + +Roo.apply(Roo.bootstrap.MonthField, { + + template : { + tag: 'div', + cls: 'datepicker dropdown-menu roo-dynamic', + cn: [ + { + tag: 'div', + cls: 'datepicker-months', + cn: [ + { + tag: 'table', + cls: 'table-condensed', + cn:[ + Roo.bootstrap.DateField.content + ] + } + ] + } + ] + } +}); + + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_NavGroup.js.html b/docs2/src/Roo_bootstrap_NavGroup.js.html new file mode 100644 index 0000000000..49146f6106 --- /dev/null +++ b/docs2/src/Roo_bootstrap_NavGroup.js.html @@ -0,0 +1,293 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/NavGroup.js/* + * - LGPL + * + * nav group + * + */ + +/** + * @class Roo.bootstrap.NavGroup + * @extends Roo.bootstrap.Component + * Bootstrap NavGroup class + * @cfg {String} align (left|right) + * @cfg {Boolean} inverse + * @cfg {String} type (nav|pills|tab) default nav + * @cfg {String} navId - reference Id for navbar. + + * + * @constructor + * Create a new nav group + * @param {Object} config The config object + */ + +Roo.bootstrap.NavGroup = function(config){ + Roo.bootstrap.NavGroup.superclass.constructor.call(this, config); + this.navItems = []; + + Roo.bootstrap.NavGroup.register(this); + this.addEvents({ + /** + * @event changed + * Fires when the active item changes + * @param {Roo.bootstrap.NavGroup} this + * @param {Roo.bootstrap.Navbar.Item} selected The item selected + * @param {Roo.bootstrap.Navbar.Item} prev The previously selected item + */ + 'changed': true + }); + +}; + +Roo.extend(Roo.bootstrap.NavGroup, Roo.bootstrap.Component, { + + align: '', + inverse: false, + form: false, + type: 'nav', + navId : '', + // private + + navItems : false, + + getAutoCreate : function() + { + var cfg = Roo.apply({}, Roo.bootstrap.NavGroup.superclass.getAutoCreate.call(this)); + + cfg = { + tag : 'ul', + cls: 'nav' + }; + if (Roo.bootstrap.version == 4) { + if (['tabs','pills'].indexOf(this.type) != -1) { + cfg.cls += ' nav-' + this.type; + } else { + cfg.cls += ' navbar-nav'; + } + } else { + if (['tabs','pills'].indexOf(this.type) != -1) { + cfg.cls += ' nav-' + this.type + } else { + if (this.type !== 'nav') { + Roo.log('nav type must be nav/tabs/pills') + } + cfg.cls += ' navbar-nav' + } + } + + if (this.parent() && this.parent().sidebar) { + cfg = { + tag: 'ul', + cls: 'dashboard-menu sidebar-menu' + }; + + return cfg; + } + + if (this.form === true) { + cfg = { + tag: 'form', + cls: 'navbar-form form-inline' + }; + + if (this.align === 'right') { + cfg.cls += ' navbar-right ml-md-auto'; + } else { + cfg.cls += ' navbar-left'; + } + } + + if (this.align === 'right') { + cfg.cls += ' navbar-right ml-md-auto'; + } else { + cfg.cls += ' mr-auto'; + } + + if (this.inverse) { + cfg.cls += ' navbar-inverse'; + + } + + + return cfg; + }, + /** + * sets the active Navigation item + * @param {Roo.bootstrap.NavItem} the new current navitem + */ + setActiveItem : function(item) + { + var prev = false; + Roo.each(this.navItems, function(v){ + if (v == item) { + return ; + } + if (v.isActive()) { + v.setActive(false, true); + prev = v; + + } + + }); + + item.setActive(true, true); + this.fireEvent('changed', this, item, prev); + + + }, + /** + * gets the active Navigation item + * @return {Roo.bootstrap.NavItem} the current navitem + */ + getActive : function() + { + + var prev = false; + Roo.each(this.navItems, function(v){ + + if (v.isActive()) { + prev = v; + + } + + }); + return prev; + }, + + indexOfNav : function() + { + + var prev = false; + Roo.each(this.navItems, function(v,i){ + + if (v.isActive()) { + prev = i; + + } + + }); + return prev; + }, + /** + * adds a Navigation item + * @param {Roo.bootstrap.NavItem} the navitem to add + */ + addItem : function(cfg) + { + if (this.form && Roo.bootstrap.version == 4) { + cfg.tag = 'div'; + } + var cn = new Roo.bootstrap.NavItem(cfg); + this.register(cn); + cn.parentId = this.id; + cn.onRender(this.el, null); + return cn; + }, + /** + * register a Navigation item + * @param {Roo.bootstrap.NavItem} the navitem to add + */ + register : function(item) + { + this.navItems.push( item); + item.navId = this.navId; + + }, + + /** + * clear all the Navigation item + */ + + clearAll : function() + { + this.navItems = []; + this.el.dom.innerHTML = ''; + }, + + getNavItem: function(tabId) + { + var ret = false; + Roo.each(this.navItems, function(e) { + if (e.tabId == tabId) { + ret = e; + return false; + } + return true; + + }); + return ret; + }, + + setActiveNext : function() + { + var i = this.indexOfNav(this.getActive()); + if (i > this.navItems.length) { + return; + } + this.setActiveItem(this.navItems[i+1]); + }, + setActivePrev : function() + { + var i = this.indexOfNav(this.getActive()); + if (i < 1) { + return; + } + this.setActiveItem(this.navItems[i-1]); + }, + clearWasActive : function(except) { + Roo.each(this.navItems, function(e) { + if (e.tabId != except.tabId && e.was_active) { + e.was_active = false; + return false; + } + return true; + + }); + }, + getWasActive : function () + { + var r = false; + Roo.each(this.navItems, function(e) { + if (e.was_active) { + r = e; + return false; + } + return true; + + }); + return r; + } + + +}); + + +Roo.apply(Roo.bootstrap.NavGroup, { + + groups: {}, + /** + * register a Navigation Group + * @param {Roo.bootstrap.NavGroup} the navgroup to add + */ + register : function(navgrp) + { + this.groups[navgrp.navId] = navgrp; + + }, + /** + * fetch a Navigation Group based on the navigation ID + * @param {string} the navgroup to add + * @returns {Roo.bootstrap.NavGroup} the navgroup + */ + get: function(navId) { + if (typeof(this.groups[navId]) == 'undefined') { + return false; + //this.register(new Roo.bootstrap.NavGroup({ navId : navId })); + } + return this.groups[navId] ; + } + + + +}); + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_NavHeaderbar.js.html b/docs2/src/Roo_bootstrap_NavHeaderbar.js.html new file mode 100644 index 0000000000..60a96dce70 --- /dev/null +++ b/docs2/src/Roo_bootstrap_NavHeaderbar.js.html @@ -0,0 +1,180 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/NavHeaderbar.js/* + * - LGPL + * + * navbar + * navbar-fixed-top + * navbar-expand-md fixed-top + */ + +/** + * @class Roo.bootstrap.NavHeaderbar + * @extends Roo.bootstrap.NavSimplebar + * Bootstrap Sidebar class + * + * @cfg {String} brand what is brand + * @cfg {String} position (fixed-top|fixed-bottom|static-top) position + * @cfg {String} brand_href href of the brand + * @cfg {Boolean} srButton generate the (screen reader / mobile) sr-only button default true + * @cfg {Boolean} autohide a top nav bar header that hides on scroll. + * @cfg {Boolean} desktopCenter should the header be centered on desktop using a container class + * @cfg {Roo.bootstrap.Row} mobilerow - a row to display on mobile only.. + * + * @constructor + * Create a new Sidebar + * @param {Object} config The config object + */ + + +Roo.bootstrap.NavHeaderbar = function(config){ + Roo.bootstrap.NavHeaderbar.superclass.constructor.call(this, config); + +}; + +Roo.extend(Roo.bootstrap.NavHeaderbar, Roo.bootstrap.NavSimplebar, { + + position: '', + brand: '', + brand_href: false, + srButton : true, + autohide : false, + desktopCenter : false, + + + getAutoCreate : function(){ + + var cfg = { + tag: this.nav || 'nav', + cls: 'navbar navbar-expand-md', + role: 'navigation', + cn: [] + }; + + var cn = cfg.cn; + if (this.desktopCenter) { + cn.push({cls : 'container', cn : []}); + cn = cn[0].cn; + } + + if(this.srButton){ + var btn = { + tag: 'button', + type: 'button', + cls: 'navbar-toggle navbar-toggler', + 'data-toggle': 'collapse', + cn: [ + { + tag: 'span', + cls: 'sr-only', + html: 'Toggle navigation' + }, + { + tag: 'span', + cls: 'icon-bar navbar-toggler-icon' + }, + { + tag: 'span', + cls: 'icon-bar' + }, + { + tag: 'span', + cls: 'icon-bar' + } + ] + }; + + cn.push( Roo.bootstrap.version == 4 ? btn : { + tag: 'div', + cls: 'navbar-header', + cn: [ + btn + ] + }); + } + + cn.push({ + tag: 'div', + cls: 'collapse navbar-collapse', + cn : [] + }); + + cfg.cls += this.inverse ? ' navbar-inverse navbar-dark bg-dark' : ' navbar-default'; + + if (['light','white'].indexOf(this.weight) > -1) { + cfg.cls += ['light','white'].indexOf(this.weight) > -1 ? ' navbar-light' : ' navbar-dark'; + } + cfg.cls += ' bg-' + this.weight; + + + if (['fixed-top','fixed-bottom','static-top'].indexOf(this.position)>-1) { + cfg.cls += ' navbar-' + this.position + ' ' + this.position ; + + // tag can override this.. + + cfg.tag = this.tag || (this.position == 'fixed-bottom' ? 'footer' : 'header'); + } + + if (this.brand !== '') { + var cp = Roo.bootstrap.version == 4 ? cn : cn[0].cn; + cp.unshift({ // changed from push ?? BS4 needs it at the start? - does this break or exsiting? + tag: 'a', + href: this.brand_href ? this.brand_href : '#', + cls: 'navbar-brand', + cn: [ + this.brand + ] + }); + } + + if(this.main){ + cfg.cls += ' main-nav'; + } + + + return cfg; + + + }, + getHeaderChildContainer : function() + { + if (this.srButton && this.el.select('.navbar-header').getCount()) { + return this.el.select('.navbar-header',true).first(); + } + + return this.getChildContainer(); + }, + + + initEvents : function() + { + Roo.bootstrap.NavHeaderbar.superclass.initEvents.call(this); + + if (this.autohide) { + + var prevScroll = 0; + var ft = this.el; + + Roo.get(document).on('scroll',function(e) { + var ns = Roo.get(document).getScroll().top; + var os = prevScroll; + prevScroll = ns; + + if(ns > os){ + ft.removeClass('slideDown'); + ft.addClass('slideUp'); + return; + } + ft.removeClass('slideUp'); + ft.addClass('slideDown'); + + + },this); + } + } + +}); + + + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_NavItem.js.html b/docs2/src/Roo_bootstrap_NavItem.js.html new file mode 100644 index 0000000000..37a6fc71f1 --- /dev/null +++ b/docs2/src/Roo_bootstrap_NavItem.js.html @@ -0,0 +1,367 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/NavItem.js/* + * - LGPL + * + * row + * + */ + +/** + * @class Roo.bootstrap.NavItem + * @extends Roo.bootstrap.Component + * Bootstrap Navbar.NavItem class + * @cfg {String} href link to + * @cfg {String} button_weight (default | primary | secondary | success | info | warning | danger | link ) default none + + * @cfg {String} html content of button + * @cfg {String} badge text inside badge + * @cfg {String} badgecls (bg-green|bg-red|bg-yellow)the extra classes for the badge + * @cfg {String} glyphicon DEPRICATED - use fa + * @cfg {String} icon DEPRICATED - use fa + * @cfg {String} fa - Fontawsome icon name (can add stuff to it like fa-2x) + * @cfg {Boolean} active Is item active + * @cfg {Boolean} disabled Is item disabled + + * @cfg {Boolean} preventDefault (true | false) default false + * @cfg {String} tabId the tab that this item activates. + * @cfg {String} tagtype (a|span) render as a href or span? + * @cfg {Boolean} animateRef (true|false) link to element default false + + * @constructor + * Create a new Navbar Item + * @param {Object} config The config object + */ +Roo.bootstrap.NavItem = function(config){ + Roo.bootstrap.NavItem.superclass.constructor.call(this, config); + this.addEvents({ + // raw events + /** + * @event click + * The raw click event for the entire grid. + * @param {Roo.EventObject} e + */ + "click" : true, + /** + * @event changed + * Fires when the active item active state changes + * @param {Roo.bootstrap.NavItem} this + * @param {boolean} state the new state + + */ + 'changed': true, + /** + * @event scrollto + * Fires when scroll to element + * @param {Roo.bootstrap.NavItem} this + * @param {Object} options + * @param {Roo.EventObject} e + + */ + 'scrollto': true + }); + +}; + +Roo.extend(Roo.bootstrap.NavItem, Roo.bootstrap.Component, { + + href: false, + html: '', + badge: '', + icon: false, + fa : false, + glyphicon: false, + active: false, + preventDefault : false, + tabId : false, + tagtype : 'a', + tag: 'li', + disabled : false, + animateRef : false, + was_active : false, + button_weight : '', + button_outline : false, + + navLink: false, + + getAutoCreate : function(){ + + var cfg = { + tag: this.tag, + cls: 'nav-item' + }; + + if (this.active) { + cfg.cls = typeof(cfg.cls) == 'undefined' ? 'active' : cfg.cls + ' active'; + } + if (this.disabled) { + cfg.cls += ' disabled'; + } + + // BS4 only? + if (this.button_weight.length) { + cfg.tag = this.href ? 'a' : 'button'; + cfg.html = this.html || ''; + cfg.cls += ' btn btn' + (this.button_outline ? '-outline' : '') + '-' + this.button_weight; + if (this.href) { + cfg.href = this.href; + } + if (this.fa) { + cfg.html = '<i class="fa fas fa-'+this.fa+'"></i> <span>' + this.html + '</span>'; + } + + // menu .. should add dropdown-menu class - so no need for carat.. + + if (this.badge !== '') { + + cfg.html += ' <span class="badge badge-secondary">' + this.badge + '</span>'; + } + return cfg; + } + + if (this.href || this.html || this.glyphicon || this.icon || this.fa) { + cfg.cn = [ + { + tag: this.tagtype, + href : this.href || "#", + html: this.html || '' + } + ]; + if (this.tagtype == 'a') { + cfg.cn[0].cls = 'nav-link'; + } + if (this.icon) { + cfg.cn[0].html = '<i class="'+this.icon+'"></i> <span>' + cfg.cn[0].html + '</span>'; + } + if (this.fa) { + cfg.cn[0].html = '<i class="fa fas fa-'+this.fa+'"></i> <span>' + cfg.cn[0].html + '</span>'; + } + if(this.glyphicon) { + cfg.cn[0].html = '<span class="glyphicon glyphicon-' + this.glyphicon + '"></span> ' + cfg.cn[0].html; + } + + if (this.menu) { + + cfg.cn[0].html += " <span class='caret'></span>"; + + } + + if (this.badge !== '') { + + cfg.cn[0].html += ' <span class="badge badge-secondary">' + this.badge + '</span>'; + } + } + + + + return cfg; + }, + onRender : function(ct, position) + { + // Roo.log("Call onRender: " + this.xtype); + if (Roo.bootstrap.version == 4 && ct.dom.type != 'ul') { + this.tag = 'div'; + } + + var ret = Roo.bootstrap.NavItem.superclass.onRender.call(this, ct, position); + this.navLink = this.el.select('.nav-link',true).first(); + return ret; + }, + + + initEvents: function() + { + if (typeof (this.menu) != 'undefined') { + this.menu.parentType = this.xtype; + this.menu.triggerEl = this.el; + this.menu = this.addxtype(Roo.apply({}, this.menu)); + } + + this.el.select('a',true).on('click', this.onClick, this); + + if(this.tagtype == 'span'){ + this.el.select('span',true).on('click', this.onClick, this); + } + + // at this point parent should be available.. + this.parent().register(this); + }, + + onClick : function(e) + { + if (e.getTarget('.dropdown-menu-item')) { + // did you click on a menu itemm.... - then don't trigger onclick.. + return; + } + + if( + this.preventDefault || + this.href == '#' + ){ + Roo.log("NavItem - prevent Default?"); + e.preventDefault(); + } + + if (this.disabled) { + return; + } + + var tg = Roo.bootstrap.TabGroup.get(this.navId); + if (tg && tg.transition) { + Roo.log("waiting for the transitionend"); + return; + } + + + + //Roo.log("fire event clicked"); + if(this.fireEvent('click', this, e) === false){ + return; + }; + + if(this.tagtype == 'span'){ + return; + } + + //Roo.log(this.href); + var ael = this.el.select('a',true).first(); + //Roo.log(ael); + + if(ael && this.animateRef && this.href.indexOf('#') > -1){ + //Roo.log(["test:",ael.dom.href.split("#")[0], document.location.toString().split("#")[0]]); + if (ael.dom.href.split("#")[0] != document.location.toString().split("#")[0]) { + return; // ignore... - it's a 'hash' to another page. + } + Roo.log("NavItem - prevent Default?"); + e.preventDefault(); + this.scrollToElement(e); + } + + + var p = this.parent(); + + if (['tabs','pills'].indexOf(p.type)!==-1) { + if (typeof(p.setActiveItem) !== 'undefined') { + p.setActiveItem(this); + } + } + + // if parent is a navbarheader....- and link is probably a '#' page ref.. then remove the expanded menu. + if (p.parentType == 'NavHeaderbar' && !this.menu) { + // remove the collapsed menu expand... + p.parent().el.select('.navbar-collapse',true).removeClass('in'); + } + }, + + isActive: function () { + return this.active + }, + setActive : function(state, fire, is_was_active) + { + if (this.active && !state && this.navId) { + this.was_active = true; + var nv = Roo.bootstrap.NavGroup.get(this.navId); + if (nv) { + nv.clearWasActive(this); + } + + } + this.active = state; + + if (!state ) { + this.el.removeClass('active'); + this.navLink ? this.navLink.removeClass('active') : false; + } else if (!this.el.hasClass('active')) { + + this.el.addClass('active'); + if (Roo.bootstrap.version == 4 && this.navLink ) { + this.navLink.addClass('active'); + } + + } + if (fire) { + this.fireEvent('changed', this, state); + } + + // show a panel if it's registered and related.. + + if (!this.navId || !this.tabId || !state || is_was_active) { + return; + } + + var tg = Roo.bootstrap.TabGroup.get(this.navId); + if (!tg) { + return; + } + var pan = tg.getPanelByName(this.tabId); + if (!pan) { + return; + } + // if we can not flip to new panel - go back to old nav highlight.. + if (false == tg.showPanel(pan)) { + var nv = Roo.bootstrap.NavGroup.get(this.navId); + if (nv) { + var onav = nv.getWasActive(); + if (onav) { + onav.setActive(true, false, true); + } + } + + } + + + + }, + // this should not be here... + setDisabled : function(state) + { + this.disabled = state; + if (!state ) { + this.el.removeClass('disabled'); + } else if (!this.el.hasClass('disabled')) { + this.el.addClass('disabled'); + } + + }, + + /** + * Fetch the element to display the tooltip on. + * @return {Roo.Element} defaults to this.el + */ + tooltipEl : function() + { + return this.el.select('' + this.tagtype + '', true).first(); + }, + + scrollToElement : function(e) + { + var c = document.body; + + /* + * Firefox / IE places the overflow at the html level, unless specifically styled to behave differently. + */ + if(Roo.isFirefox || Roo.isIE || Roo.isIE11){ + c = document.documentElement; + } + + var target = Roo.get(c).select('a[name=' + this.href.split('#')[1] +']', true).first(); + + if(!target){ + return; + } + + var o = target.calcOffsetsTo(c); + + var options = { + target : target, + value : o[1] + }; + + this.fireEvent('scrollto', this, options, e); + + Roo.get(c).scrollTo('top', options.value, true); + + return; + } +}); + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_NavProgressBar.js.html b/docs2/src/Roo_bootstrap_NavProgressBar.js.html new file mode 100644 index 0000000000..648c5b5bc4 --- /dev/null +++ b/docs2/src/Roo_bootstrap_NavProgressBar.js.html @@ -0,0 +1,249 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/NavProgressBar.js/* + * - LGPL + * + * nav progress bar + * + */ + +/** + * @class Roo.bootstrap.NavProgressBar + * @extends Roo.bootstrap.Component + * Bootstrap NavProgressBar class + * + * @constructor + * Create a new nav progress bar + * @param {Object} config The config object + */ + +Roo.bootstrap.NavProgressBar = function(config){ + Roo.bootstrap.NavProgressBar.superclass.constructor.call(this, config); + + this.bullets = this.bullets || []; + +// Roo.bootstrap.NavProgressBar.register(this); + this.addEvents({ + /** + * @event changed + * Fires when the active item changes + * @param {Roo.bootstrap.NavProgressBar} this + * @param {Roo.bootstrap.NavProgressItem} selected The item selected + * @param {Roo.bootstrap.NavProgressItem} prev The previously selected item + */ + 'changed': true + }); + +}; + +Roo.extend(Roo.bootstrap.NavProgressBar, Roo.bootstrap.Component, { + + bullets : [], + barItems : [], + + getAutoCreate : function() + { + var cfg = Roo.apply({}, Roo.bootstrap.NavProgressBar.superclass.getAutoCreate.call(this)); + + cfg = { + tag : 'div', + cls : 'roo-navigation-bar-group', + cn : [ + { + tag : 'div', + cls : 'roo-navigation-top-bar' + }, + { + tag : 'div', + cls : 'roo-navigation-bullets-bar', + cn : [ + { + tag : 'ul', + cls : 'roo-navigation-bar' + } + ] + }, + + { + tag : 'div', + cls : 'roo-navigation-bottom-bar' + } + ] + + }; + + return cfg; + + }, + + initEvents: function() + { + + }, + + onRender : function(ct, position) + { + Roo.bootstrap.NavProgressBar.superclass.onRender.call(this, ct, position); + + if(this.bullets.length){ + Roo.each(this.bullets, function(b){ + this.addItem(b); + }, this); + } + + this.format(); + + }, + + addItem : function(cfg) + { + var item = new Roo.bootstrap.NavProgressItem(cfg); + + item.parentId = this.id; + item.render(this.el.select('.roo-navigation-bar', true).first(), null); + + if(cfg.html){ + var top = new Roo.bootstrap.Element({ + tag : 'div', + cls : 'roo-navigation-bar-text' + }); + + var bottom = new Roo.bootstrap.Element({ + tag : 'div', + cls : 'roo-navigation-bar-text' + }); + + top.onRender(this.el.select('.roo-navigation-top-bar', true).first(), null); + bottom.onRender(this.el.select('.roo-navigation-bottom-bar', true).first(), null); + + var topText = new Roo.bootstrap.Element({ + tag : 'span', + html : (typeof(cfg.position) != 'undefined' && cfg.position == 'top') ? cfg.html : '' + }); + + var bottomText = new Roo.bootstrap.Element({ + tag : 'span', + html : (typeof(cfg.position) != 'undefined' && cfg.position == 'top') ? '' : cfg.html + }); + + topText.onRender(top.el, null); + bottomText.onRender(bottom.el, null); + + item.topEl = top; + item.bottomEl = bottom; + } + + this.barItems.push(item); + + return item; + }, + + getActive : function() + { + var active = false; + + Roo.each(this.barItems, function(v){ + + if (!v.isActive()) { + return; + } + + active = v; + return false; + + }); + + return active; + }, + + setActiveItem : function(item) + { + var prev = false; + + Roo.each(this.barItems, function(v){ + if (v.rid == item.rid) { + return ; + } + + if (v.isActive()) { + v.setActive(false); + prev = v; + } + }); + + item.setActive(true); + + this.fireEvent('changed', this, item, prev); + }, + + getBarItem: function(rid) + { + var ret = false; + + Roo.each(this.barItems, function(e) { + if (e.rid != rid) { + return; + } + + ret = e; + return false; + }); + + return ret; + }, + + indexOfItem : function(item) + { + var index = false; + + Roo.each(this.barItems, function(v, i){ + + if (v.rid != item.rid) { + return; + } + + index = i; + return false + }); + + return index; + }, + + setActiveNext : function() + { + var i = this.indexOfItem(this.getActive()); + + if (i > this.barItems.length) { + return; + } + + this.setActiveItem(this.barItems[i+1]); + }, + + setActivePrev : function() + { + var i = this.indexOfItem(this.getActive()); + + if (i < 1) { + return; + } + + this.setActiveItem(this.barItems[i-1]); + }, + + format : function() + { + if(!this.barItems.length){ + return; + } + + var width = 100 / this.barItems.length; + + Roo.each(this.barItems, function(i){ + i.el.setStyle('width', width + '%'); + i.topEl.el.setStyle('width', width + '%'); + i.bottomEl.el.setStyle('width', width + '%'); + }, this); + + } + +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_NavProgressItem.js.html b/docs2/src/Roo_bootstrap_NavProgressItem.js.html new file mode 100644 index 0000000000..3594ba5c3a --- /dev/null +++ b/docs2/src/Roo_bootstrap_NavProgressItem.js.html @@ -0,0 +1,152 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/NavProgressItem.js/* + * - LGPL + * + * Nav Progress Item + * + */ + +/** + * @class Roo.bootstrap.NavProgressItem + * @extends Roo.bootstrap.Component + * Bootstrap NavProgressItem class + * @cfg {String} rid the reference id + * @cfg {Boolean} active (true|false) Is item active default false + * @cfg {Boolean} disabled (true|false) Is item active default false + * @cfg {String} html + * @cfg {String} position (top|bottom) text position default bottom + * @cfg {String} icon show icon instead of number + * + * @constructor + * Create a new NavProgressItem + * @param {Object} config The config object + */ +Roo.bootstrap.NavProgressItem = function(config){ + Roo.bootstrap.NavProgressItem.superclass.constructor.call(this, config); + this.addEvents({ + // raw events + /** + * @event click + * The raw click event for the entire grid. + * @param {Roo.bootstrap.NavProgressItem} this + * @param {Roo.EventObject} e + */ + "click" : true + }); + +}; + +Roo.extend(Roo.bootstrap.NavProgressItem, Roo.bootstrap.Component, { + + rid : '', + active : false, + disabled : false, + html : '', + position : 'bottom', + icon : false, + + getAutoCreate : function() + { + var iconCls = 'roo-navigation-bar-item-icon'; + + iconCls += ((this.icon) ? (' ' + this.icon) : (' step-number')) ; + + var cfg = { + tag: 'li', + cls: 'roo-navigation-bar-item', + cn : [ + { + tag : 'i', + cls : iconCls + } + ] + }; + + if(this.active){ + cfg.cls += ' active'; + } + if(this.disabled){ + cfg.cls += ' disabled'; + } + + return cfg; + }, + + disable : function() + { + this.setDisabled(true); + }, + + enable : function() + { + this.setDisabled(false); + }, + + initEvents: function() + { + this.iconEl = this.el.select('.roo-navigation-bar-item-icon', true).first(); + + this.iconEl.on('click', this.onClick, this); + }, + + onClick : function(e) + { + e.preventDefault(); + + if(this.disabled){ + return; + } + + if(this.fireEvent('click', this, e) === false){ + return; + }; + + this.parent().setActiveItem(this); + }, + + isActive: function () + { + return this.active; + }, + + setActive : function(state) + { + if(this.active == state){ + return; + } + + this.active = state; + + if (state) { + this.el.addClass('active'); + return; + } + + this.el.removeClass('active'); + + return; + }, + + setDisabled : function(state) + { + if(this.disabled == state){ + return; + } + + this.disabled = state; + + if (state) { + this.el.addClass('disabled'); + return; + } + + this.el.removeClass('disabled'); + }, + + tooltipEl : function() + { + return this.el.select('.roo-navigation-bar-item-icon', true).first();; + } +}); + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_NavSidebar.js.html b/docs2/src/Roo_bootstrap_NavSidebar.js.html new file mode 100644 index 0000000000..8c3bb57f6b --- /dev/null +++ b/docs2/src/Roo_bootstrap_NavSidebar.js.html @@ -0,0 +1,46 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/NavSidebar.js/* + * - LGPL + * + * navbar + * + */ + +/** + * @class Roo.bootstrap.NavSidebar + * @extends Roo.bootstrap.Navbar + * Bootstrap Sidebar class + * + * @constructor + * Create a new Sidebar + * @param {Object} config The config object + */ + + +Roo.bootstrap.NavSidebar = function(config){ + Roo.bootstrap.NavSidebar.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.NavSidebar, Roo.bootstrap.Navbar, { + + sidebar : true, // used by Navbar Item and NavbarGroup at present... + + getAutoCreate : function(){ + + + return { + tag: 'div', + cls: 'sidebar sidebar-nav' + }; + + + } + + + +}); + + + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_NavSidebarItem.js.html b/docs2/src/Roo_bootstrap_NavSidebarItem.js.html new file mode 100644 index 0000000000..bb24169b0c --- /dev/null +++ b/docs2/src/Roo_bootstrap_NavSidebarItem.js.html @@ -0,0 +1,227 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/NavSidebarItem.js/* + * - LGPL + * + * sidebar item + * + * li + * <span> icon </span> + * <span> text </span> + * <span>badge </span> + */ + +/** + * @class Roo.bootstrap.NavSidebarItem + * @extends Roo.bootstrap.NavItem + * Bootstrap Navbar.NavSidebarItem class + * {String} badgeWeight (default|primary|success|info|warning|danger)the extra classes for the badge + * {Boolean} open is the menu open + * {Boolean} buttonView use button as the tigger el rather that a (default false) + * {String} buttonWeight (default|primary|success|info|warning|danger)the extra classes for the button + * {String} buttonSize (sm|md|lg)the extra classes for the button + * {Boolean} showArrow show arrow next to the text (default true) + * @constructor + * Create a new Navbar Button + * @param {Object} config The config object + */ +Roo.bootstrap.NavSidebarItem = function(config){ + Roo.bootstrap.NavSidebarItem.superclass.constructor.call(this, config); + this.addEvents({ + // raw events + /** + * @event click + * The raw click event for the entire grid. + * @param {Roo.EventObject} e + */ + "click" : true, + /** + * @event changed + * Fires when the active item active state changes + * @param {Roo.bootstrap.NavSidebarItem} this + * @param {boolean} state the new state + + */ + 'changed': true + }); + +}; + +Roo.extend(Roo.bootstrap.NavSidebarItem, Roo.bootstrap.NavItem, { + + badgeWeight : 'default', + + open: false, + + buttonView : false, + + buttonWeight : 'default', + + buttonSize : 'md', + + showArrow : true, + + getAutoCreate : function(){ + + + var a = { + tag: 'a', + href : this.href || '#', + cls: '', + html : '', + cn : [] + }; + + if(this.buttonView){ + a = { + tag: 'button', + href : this.href || '#', + cls: 'btn btn-' + this.buttonWeight + ' btn-' + this.buttonSize + 'roo-button-dropdown-toggle', + html : this.html, + cn : [] + }; + } + + var cfg = { + tag: 'li', + cls: '', + cn: [ a ] + }; + + if (this.active) { + cfg.cls += ' active'; + } + + if (this.disabled) { + cfg.cls += ' disabled'; + } + if (this.open) { + cfg.cls += ' open x-open'; + } + // left icon.. + if (this.glyphicon || this.icon) { + var c = this.glyphicon ? ('glyphicon glyphicon-'+this.glyphicon) : this.icon; + a.cn.push({ tag : 'i', cls : c }) ; + } + + if(!this.buttonView){ + var span = { + tag: 'span', + html : this.html || '' + }; + + a.cn.push(span); + + } + + if (this.badge !== '') { + a.cn.push({ tag: 'span', cls : 'badge pull-right badge-' + this.badgeWeight, html: this.badge }); + } + + if (this.menu) { + + if(this.showArrow){ + a.cn.push({ tag : 'i', cls : 'glyphicon glyphicon-chevron-down pull-right'}); + } + + a.cls += ' dropdown-toggle treeview' ; + } + + return cfg; + }, + + initEvents : function() + { + if (typeof (this.menu) != 'undefined') { + this.menu.parentType = this.xtype; + this.menu.triggerEl = this.el; + this.menu = this.addxtype(Roo.apply({}, this.menu)); + } + + this.el.on('click', this.onClick, this); + + if(this.badge !== ''){ + this.badgeEl = this.el.select('.badge', true).first().setVisibilityMode(Roo.Element.DISPLAY); + } + + }, + + onClick : function(e) + { + if(this.disabled){ + e.preventDefault(); + return; + } + + if(this.preventDefault){ + e.preventDefault(); + } + + this.fireEvent('click', this); + }, + + disable : function() + { + this.setDisabled(true); + }, + + enable : function() + { + this.setDisabled(false); + }, + + setDisabled : function(state) + { + if(this.disabled == state){ + return; + } + + this.disabled = state; + + if (state) { + this.el.addClass('disabled'); + return; + } + + this.el.removeClass('disabled'); + + return; + }, + + setActive : function(state) + { + if(this.active == state){ + return; + } + + this.active = state; + + if (state) { + this.el.addClass('active'); + return; + } + + this.el.removeClass('active'); + + return; + }, + + isActive: function () + { + return this.active; + }, + + setBadge : function(str) + { + if(!this.badgeEl){ + return; + } + + this.badgeEl.dom.innerHTML = str; + } + + + + +}); + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_NavSimplebar.js.html b/docs2/src/Roo_bootstrap_NavSimplebar.js.html new file mode 100644 index 0000000000..25b7d70fb7 --- /dev/null +++ b/docs2/src/Roo_bootstrap_NavSimplebar.js.html @@ -0,0 +1,125 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/NavSimplebar.js/* + * - LGPL + * + * navbar + * + */ + +/** + * @class Roo.bootstrap.NavSimplebar + * @extends Roo.bootstrap.Navbar + * Bootstrap Sidebar class + * + * @cfg {Boolean} inverse is inverted color + * + * @cfg {String} type (nav | pills | tabs) + * @cfg {Boolean} arrangement stacked | justified + * @cfg {String} align (left | right) alignment + * + * @cfg {Boolean} main (true|false) main nav bar? default false + * @cfg {Boolean} loadMask (true|false) loadMask on the bar + * + * @cfg {String} tag (header|footer|nav|div) default is nav + + * @cfg {String} weight (light|primary|secondary|success|danger|warning|info|dark|white) default is light. + * + * + * @constructor + * Create a new Sidebar + * @param {Object} config The config object + */ + + +Roo.bootstrap.NavSimplebar = function(config){ + Roo.bootstrap.NavSimplebar.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.NavSimplebar, Roo.bootstrap.Navbar, { + + inverse: false, + + type: false, + arrangement: '', + align : false, + + weight : 'light', + + main : false, + + + tag : false, + + + getAutoCreate : function(){ + + + var cfg = { + tag : this.tag || 'div', + cls : 'navbar navbar-expand-lg roo-navbar-simple' + }; + if (['light','white'].indexOf(this.weight) > -1) { + cfg.cls += ['light','white'].indexOf(this.weight) > -1 ? ' navbar-light' : ' navbar-dark'; + } + cfg.cls += ' bg-' + this.weight; + + if (this.inverse) { + cfg.cls += ' navbar-inverse'; + + } + + // i'm not actually sure these are really used - normally we add a navGroup to a navbar + + //if (Roo.bootstrap.version == 4) { + // return cfg; + //} + + cfg.cn = [ + { + cls: 'nav', + tag : 'ul' + } + ]; + + + this.type = this.type || 'nav'; + if (['tabs','pills'].indexOf(this.type) != -1) { + cfg.cn[0].cls += ' nav-' + this.type + + + } else { + if (this.type!=='nav') { + Roo.log('nav type must be nav/tabs/pills') + } + cfg.cn[0].cls += ' navbar-nav' + } + + + + + if (['stacked','justified'].indexOf(this.arrangement) != -1) { + cfg.cn[0].cls += ' nav-' + this.arrangement; + } + + + if (this.align === 'right') { + cfg.cn[0].cls += ' navbar-right'; + } + + + + + return cfg; + + + } + + + +}); + + + + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Navbar.js.html b/docs2/src/Roo_bootstrap_Navbar.js.html new file mode 100644 index 0000000000..af55ad4c84 --- /dev/null +++ b/docs2/src/Roo_bootstrap_Navbar.js.html @@ -0,0 +1,138 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Navbar.js/* + * - LGPL + * + * navbar + * + */ + +/** + * @class Roo.bootstrap.Navbar + * @extends Roo.bootstrap.Component + * Bootstrap Navbar class + + * @constructor + * Create a new Navbar + * @param {Object} config The config object + */ + + +Roo.bootstrap.Navbar = function(config){ + Roo.bootstrap.Navbar.superclass.constructor.call(this, config); + this.addEvents({ + // raw events + /** + * @event beforetoggle + * Fire before toggle the menu + * @param {Roo.EventObject} e + */ + "beforetoggle" : true + }); +}; + +Roo.extend(Roo.bootstrap.Navbar, Roo.bootstrap.Component, { + + + + // private + navItems : false, + loadMask : false, + + + getAutoCreate : function(){ + + + throw { message : "nav bar is now a abstract base class - use NavSimplebar / NavHeaderbar / NavSidebar etc..."}; + + }, + + initEvents :function () + { + //Roo.log(this.el.select('.navbar-toggle',true)); + this.el.select('.navbar-toggle',true).on('click', function() { + if(this.fireEvent('beforetoggle', this) !== false){ + var ce = this.el.select('.navbar-collapse',true).first(); + ce.toggleClass('in'); // old... + if (ce.hasClass('collapse')) { + // show it... + ce.removeClass('collapse'); + ce.addClass('show'); + var h = ce.getHeight(); + Roo.log(h); + ce.removeClass('show'); + // at this point we should be able to see it.. + ce.addClass('collapsing'); + + ce.setHeight(0); // resize it ... + ce.on('transitionend', function() { + Roo.log('done transition'); + ce.removeClass('collapsing'); + ce.addClass('show'); + ce.removeClass('collapse'); + + ce.dom.style.height = ''; + }, this, { single: true} ); + ce.setHeight(h); + + } else { + ce.setHeight(ce.getHeight()); + ce.removeClass('show'); + ce.addClass('collapsing'); + + ce.on('transitionend', function() { + ce.dom.style.height = ''; + ce.removeClass('collapsing'); + ce.addClass('collapse'); + }, this, { single: true} ); + ce.setHeight(0); + } + } + + }, this); + + var mark = { + tag: "div", + cls:"x-dlg-mask" + }; + + this.maskEl = Roo.DomHelper.append(this.el, mark, true); + + var size = this.el.getSize(); + this.maskEl.setSize(size.width, size.height); + this.maskEl.enableDisplayMode("block"); + this.maskEl.hide(); + + if(this.loadMask){ + this.maskEl.show(); + } + }, + + + getChildContainer : function() + { + if (this.el && this.el.select('.collapse').getCount()) { + return this.el.select('.collapse',true).first(); + } + + return this.el; + }, + + mask : function() + { + this.maskEl.show(); + }, + + unmask : function() + { + this.maskEl.hide(); + } + + + + +}); + + + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_NumberField.js.html b/docs2/src/Roo_bootstrap_NumberField.js.html new file mode 100644 index 0000000000..8fe68c1f64 --- /dev/null +++ b/docs2/src/Roo_bootstrap_NumberField.js.html @@ -0,0 +1,256 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/NumberField.js/* + * - LGPL + * + * Number field + */ + +/** + * @class Roo.bootstrap.NumberField + * @extends Roo.bootstrap.Input + * Bootstrap NumberField class + * + * + * + * + * @constructor + * Create a new NumberField + * @param {Object} config The config object + */ + +Roo.bootstrap.NumberField = function(config){ + Roo.bootstrap.NumberField.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.NumberField, Roo.bootstrap.Input, { + + /** + * @cfg {Boolean} allowDecimals False to disallow decimal values (defaults to true) + */ + allowDecimals : true, + /** + * @cfg {String} decimalSeparator Character(s) to allow as the decimal separator (defaults to '.') + */ + decimalSeparator : ".", + /** + * @cfg {Number} decimalPrecision The maximum precision to display after the decimal separator (defaults to 2) + */ + decimalPrecision : 2, + /** + * @cfg {Boolean} allowNegative False to prevent entering a negative sign (defaults to true) + */ + allowNegative : true, + + /** + * @cfg {Boolean} allowZero False to blank out if the user enters '0' (defaults to true) + */ + allowZero: true, + /** + * @cfg {Number} minValue The minimum allowed value (defaults to Number.NEGATIVE_INFINITY) + */ + minValue : Number.NEGATIVE_INFINITY, + /** + * @cfg {Number} maxValue The maximum allowed value (defaults to Number.MAX_VALUE) + */ + maxValue : Number.MAX_VALUE, + /** + * @cfg {String} minText Error text to display if the minimum value validation fails (defaults to "The minimum value for this field is {minValue}") + */ + minText : "The minimum value for this field is {0}", + /** + * @cfg {String} maxText Error text to display if the maximum value validation fails (defaults to "The maximum value for this field is {maxValue}") + */ + maxText : "The maximum value for this field is {0}", + /** + * @cfg {String} nanText Error text to display if the value is not a valid number. For example, this can happen + * if a valid character like '.' or '-' is left in the field with no number (defaults to "{value} is not a valid number") + */ + nanText : "{0} is not a valid number", + /** + * @cfg {String} thousandsDelimiter Symbol of thousandsDelimiter + */ + thousandsDelimiter : false, + /** + * @cfg {String} valueAlign alignment of value + */ + valueAlign : "left", + + getAutoCreate : function() + { + var hiddenInput = { + tag: 'input', + type: 'hidden', + id: Roo.id(), + cls: 'hidden-number-input' + }; + + if (this.name) { + hiddenInput.name = this.name; + } + + this.name = ''; + + var cfg = Roo.bootstrap.NumberField.superclass.getAutoCreate.call(this); + + this.name = hiddenInput.name; + + if(cfg.cn.length > 0) { + cfg.cn.push(hiddenInput); + } + + return cfg; + }, + + // private + initEvents : function() + { + Roo.bootstrap.NumberField.superclass.initEvents.call(this); + + var allowed = "0123456789"; + + if(this.allowDecimals){ + allowed += this.decimalSeparator; + } + + if(this.allowNegative){ + allowed += "-"; + } + + if(this.thousandsDelimiter) { + allowed += ","; + } + + this.stripCharsRe = new RegExp('[^'+allowed+']', 'gi'); + + var keyPress = function(e){ + + var k = e.getKey(); + + var c = e.getCharCode(); + + if( + (String.fromCharCode(c) == '.' || String.fromCharCode(c) == '-') && + allowed.indexOf(String.fromCharCode(c)) === -1 + ){ + e.stopEvent(); + return; + } + + if(!Roo.isIE && (e.isSpecialKey() || k == e.BACKSPACE || k == e.DELETE)){ + return; + } + + if(allowed.indexOf(String.fromCharCode(c)) === -1){ + e.stopEvent(); + } + }; + + this.el.on("keypress", keyPress, this); + }, + + validateValue : function(value) + { + + if(!Roo.bootstrap.NumberField.superclass.validateValue.call(this, value)){ + return false; + } + + var num = this.parseValue(value); + + if(isNaN(num)){ + this.markInvalid(String.format(this.nanText, value)); + return false; + } + + if(num < this.minValue){ + this.markInvalid(String.format(this.minText, this.minValue)); + return false; + } + + if(num > this.maxValue){ + this.markInvalid(String.format(this.maxText, this.maxValue)); + return false; + } + + return true; + }, + + getValue : function() + { + var v = this.hiddenEl().getValue(); + + return this.fixPrecision(this.parseValue(v)); + }, + + parseValue : function(value) + { + if(this.thousandsDelimiter) { + value += ""; + r = new RegExp(",", "g"); + value = value.replace(r, ""); + } + + value = parseFloat(String(value).replace(this.decimalSeparator, ".")); + return isNaN(value) ? '' : value; + }, + + fixPrecision : function(value) + { + if(this.thousandsDelimiter) { + value += ""; + r = new RegExp(",", "g"); + value = value.replace(r, ""); + } + + var nan = isNaN(value); + + if(!this.allowDecimals || this.decimalPrecision == -1 || nan || !value){ + return nan ? '' : value; + } + return parseFloat(value).toFixed(this.decimalPrecision); + }, + + setValue : function(v) + { + v = String(this.fixPrecision(v)).replace(".", this.decimalSeparator); + + this.value = v; + + if(this.rendered){ + + this.hiddenEl().dom.value = (v === null || v === undefined ? '' : v); + + this.inputEl().dom.value = (v == '') ? '' : + Roo.util.Format.number(v, this.decimalPrecision, this.thousandsDelimiter || ''); + + if(!this.allowZero && v === '0') { + this.hiddenEl().dom.value = ''; + this.inputEl().dom.value = ''; + } + + this.validate(); + } + }, + + decimalPrecisionFcn : function(v) + { + return Math.floor(v); + }, + + beforeBlur : function() + { + var v = this.parseValue(this.getRawValue()); + + if(v || v === 0 || v === ''){ + this.setValue(v); + } + }, + + hiddenEl : function() + { + return this.el.select('input.hidden-number-input',true).first(); + } + +}); + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Pagination.js.html b/docs2/src/Roo_bootstrap_Pagination.js.html new file mode 100644 index 0000000000..efa0929363 --- /dev/null +++ b/docs2/src/Roo_bootstrap_Pagination.js.html @@ -0,0 +1,51 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Pagination.js/* + * - LGPL + * + * pagination + * + */ + +/** + * @class Roo.bootstrap.Pagination + * @extends Roo.bootstrap.Component + * Bootstrap Pagination class + * @cfg {String} size xs | sm | md | lg + * @cfg {Boolean} inverse false | true + * + * @constructor + * Create a new Pagination + * @param {Object} config The config object + */ + +Roo.bootstrap.Pagination = function(config){ + Roo.bootstrap.Pagination.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.Pagination, Roo.bootstrap.Component, { + + cls: false, + size: false, + inverse: false, + + getAutoCreate : function(){ + var cfg = { + tag: 'ul', + cls: 'pagination' + }; + if (this.inverse) { + cfg.cls += ' inverse'; + } + if (this.html) { + cfg.html=this.html; + } + if (this.cls) { + cfg.cls += " " + this.cls; + } + return cfg; + } + +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_PaginationItem.js.html b/docs2/src/Roo_bootstrap_PaginationItem.js.html new file mode 100644 index 0000000000..fff5b0de93 --- /dev/null +++ b/docs2/src/Roo_bootstrap_PaginationItem.js.html @@ -0,0 +1,98 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/PaginationItem.js/* + * - LGPL + * + * Pagination item + * + */ + + +/** + * @class Roo.bootstrap.PaginationItem + * @extends Roo.bootstrap.Component + * Bootstrap PaginationItem class + * @cfg {String} html text + * @cfg {String} href the link + * @cfg {Boolean} preventDefault (true | false) default true + * @cfg {Boolean} active (true | false) default false + * @cfg {Boolean} disabled default false + * + * + * @constructor + * Create a new PaginationItem + * @param {Object} config The config object + */ + + +Roo.bootstrap.PaginationItem = function(config){ + Roo.bootstrap.PaginationItem.superclass.constructor.call(this, config); + this.addEvents({ + // raw events + /** + * @event click + * The raw click event for the entire grid. + * @param {Roo.EventObject} e + */ + "click" : true + }); +}; + +Roo.extend(Roo.bootstrap.PaginationItem, Roo.bootstrap.Component, { + + href : false, + html : false, + preventDefault: true, + active : false, + cls : false, + disabled: false, + + getAutoCreate : function(){ + var cfg= { + tag: 'li', + cn: [ + { + tag : 'a', + href : this.href ? this.href : '#', + html : this.html ? this.html : '' + } + ] + }; + + if(this.cls){ + cfg.cls = this.cls; + } + + if(this.disabled){ + cfg.cls = typeof(cfg.cls) !== 'undefined' ? cfg.cls + ' disabled' : 'disabled'; + } + + if(this.active){ + cfg.cls = typeof(cfg.cls) !== 'undefined' ? cfg.cls + ' active' : 'active'; + } + + return cfg; + }, + + initEvents: function() { + + this.el.on('click', this.onClick, this); + + }, + onClick : function(e) + { + Roo.log('PaginationItem on click '); + if(this.preventDefault){ + e.preventDefault(); + } + + if(this.disabled){ + return; + } + + this.fireEvent('click', this, e); + } + +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_PagingToolbar.js.html b/docs2/src/Roo_bootstrap_PagingToolbar.js.html new file mode 100644 index 0000000000..4da459afe6 --- /dev/null +++ b/docs2/src/Roo_bootstrap_PagingToolbar.js.html @@ -0,0 +1,365 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/PagingToolbar.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.bootstrap.PagingToolbar + * @extends Roo.bootstrap.NavSimplebar + * A specialized toolbar that is bound to a {@link Roo.data.Store} and provides automatic paging controls. + * @constructor + * Create a new PagingToolbar + * @param {Object} config The config object + * @param {Roo.data.Store} store + */ +Roo.bootstrap.PagingToolbar = function(config) +{ + // old args format still supported... - xtype is prefered.. + // created from xtype... + + this.ds = config.dataSource; + + if (config.store && !this.ds) { + this.store= Roo.factory(config.store, Roo.data); + this.ds = this.store; + this.ds.xmodule = this.xmodule || false; + } + + this.toolbarItems = []; + if (config.items) { + this.toolbarItems = config.items; + } + + Roo.bootstrap.PagingToolbar.superclass.constructor.call(this, config); + + this.cursor = 0; + + if (this.ds) { + this.bind(this.ds); + } + + if (Roo.bootstrap.version == 4) { + this.navgroup = new Roo.bootstrap.ButtonGroup({ cls: 'pagination' }); + } else { + this.navgroup = new Roo.bootstrap.NavGroup({ cls: 'pagination' }); + } + +}; + +Roo.extend(Roo.bootstrap.PagingToolbar, Roo.bootstrap.NavSimplebar, { + /** + * @cfg {Roo.data.Store} dataSource + * The underlying data store providing the paged data + */ + /** + * @cfg {String/HTMLElement/Element} container + * container The id or element that will contain the toolbar + */ + /** + * @cfg {Boolean} displayInfo + * True to display the displayMsg (defaults to false) + */ + /** + * @cfg {Number} pageSize + * The number of records to display per page (defaults to 20) + */ + pageSize: 20, + /** + * @cfg {String} displayMsg + * The paging status message to display (defaults to "Displaying {start} - {end} of {total}") + */ + displayMsg : 'Displaying {0} - {1} of {2}', + /** + * @cfg {String} emptyMsg + * The message to display when no records are found (defaults to "No data to display") + */ + emptyMsg : 'No data to display', + /** + * Customizable piece of the default paging text (defaults to "Page") + * @type String + */ + beforePageText : "Page", + /** + * Customizable piece of the default paging text (defaults to "of %0") + * @type String + */ + afterPageText : "of {0}", + /** + * Customizable piece of the default paging text (defaults to "First Page") + * @type String + */ + firstText : "First Page", + /** + * Customizable piece of the default paging text (defaults to "Previous Page") + * @type String + */ + prevText : "Previous Page", + /** + * Customizable piece of the default paging text (defaults to "Next Page") + * @type String + */ + nextText : "Next Page", + /** + * Customizable piece of the default paging text (defaults to "Last Page") + * @type String + */ + lastText : "Last Page", + /** + * Customizable piece of the default paging text (defaults to "Refresh") + * @type String + */ + refreshText : "Refresh", + + buttons : false, + // private + onRender : function(ct, position) + { + Roo.bootstrap.PagingToolbar.superclass.onRender.call(this, ct, position); + this.navgroup.parentId = this.id; + this.navgroup.onRender(this.el, null); + // add the buttons to the navgroup + + if(this.displayInfo){ + this.el.select('ul.navbar-nav',true).first().createChild({cls:'x-paging-info'}); + this.displayEl = this.el.select('.x-paging-info', true).first(); +// var navel = this.navgroup.addItem( { tagtype : 'span', html : '', cls : 'x-paging-info', preventDefault : true } ); +// this.displayEl = navel.el.select('span',true).first(); + } + + var _this = this; + + if(this.buttons){ + Roo.each(_this.buttons, function(e){ // this might need to use render???? + Roo.factory(e).render(_this.el); + }); + } + + Roo.each(_this.toolbarItems, function(e) { + _this.navgroup.addItem(e); + }); + + + this.first = this.navgroup.addItem({ + tooltip: this.firstText, + cls: "prev btn-outline-secondary", + html : ' <i class="fa fa-step-backward"></i>', + disabled: true, + preventDefault: true, + listeners : { click : this.onClick.createDelegate(this, ["first"]) } + }); + + this.prev = this.navgroup.addItem({ + tooltip: this.prevText, + cls: "prev btn-outline-secondary", + html : ' <i class="fa fa-backward"></i>', + disabled: true, + preventDefault: true, + listeners : { click : this.onClick.createDelegate(this, ["prev"]) } + }); + //this.addSeparator(); + + + var field = this.navgroup.addItem( { + tagtype : 'span', + cls : 'x-paging-position btn-outline-secondary', + disabled: true, + html : this.beforePageText + + '<input type="text" size="3" value="1" class="x-grid-page-number">' + + '<span class="x-paging-after">' + String.format(this.afterPageText, 1) + '</span>' + } ); //?? escaped? + + this.field = field.el.select('input', true).first(); + this.field.on("keydown", this.onPagingKeydown, this); + this.field.on("focus", function(){this.dom.select();}); + + + this.afterTextEl = field.el.select('.x-paging-after',true).first(); + //this.field.setHeight(18); + //this.addSeparator(); + this.next = this.navgroup.addItem({ + tooltip: this.nextText, + cls: "next btn-outline-secondary", + html : ' <i class="fa fa-forward"></i>', + disabled: true, + preventDefault: true, + listeners : { click : this.onClick.createDelegate(this, ["next"]) } + }); + this.last = this.navgroup.addItem({ + tooltip: this.lastText, + html : ' <i class="fa fa-step-forward"></i>', + cls: "next btn-outline-secondary", + disabled: true, + preventDefault: true, + listeners : { click : this.onClick.createDelegate(this, ["last"]) } + }); + //this.addSeparator(); + this.loading = this.navgroup.addItem({ + tooltip: this.refreshText, + cls: "btn-outline-secondary", + html : ' <i class="fa fa-refresh"></i>', + preventDefault: true, + listeners : { click : this.onClick.createDelegate(this, ["refresh"]) } + }); + + }, + + // private + updateInfo : function(){ + if(this.displayEl){ + var count = (typeof(this.getCount) == 'undefined') ? this.ds.getCount() : this.getCount(); + var msg = count == 0 ? + this.emptyMsg : + String.format( + this.displayMsg, + this.cursor+1, this.cursor+count, this.ds.getTotalCount() + ); + this.displayEl.update(msg); + } + }, + + // private + onLoad : function(ds, r, o) + { + this.cursor = o.params.start ? o.params.start : 0; + + var d = this.getPageData(), + ap = d.activePage, + ps = d.pages; + + + this.afterTextEl.dom.innerHTML = String.format(this.afterPageText, d.pages); + this.field.dom.value = ap; + this.first.setDisabled(ap == 1); + this.prev.setDisabled(ap == 1); + this.next.setDisabled(ap == ps); + this.last.setDisabled(ap == ps); + this.loading.enable(); + this.updateInfo(); + }, + + // private + getPageData : function(){ + var total = this.ds.getTotalCount(); + return { + total : total, + activePage : Math.ceil((this.cursor+this.pageSize)/this.pageSize), + pages : total < this.pageSize ? 1 : Math.ceil(total/this.pageSize) + }; + }, + + // private + onLoadError : function(){ + this.loading.enable(); + }, + + // private + onPagingKeydown : function(e){ + var k = e.getKey(); + var d = this.getPageData(); + if(k == e.RETURN){ + var v = this.field.dom.value, pageNum; + if(!v || isNaN(pageNum = parseInt(v, 10))){ + this.field.dom.value = d.activePage; + return; + } + pageNum = Math.min(Math.max(1, pageNum), d.pages) - 1; + this.ds.load({params:{start: pageNum * this.pageSize, limit: this.pageSize}}); + e.stopEvent(); + } + else if(k == e.HOME || (k == e.UP && e.ctrlKey) || (k == e.PAGEUP && e.ctrlKey) || (k == e.RIGHT && e.ctrlKey) || k == e.END || (k == e.DOWN && e.ctrlKey) || (k == e.LEFT && e.ctrlKey) || (k == e.PAGEDOWN && e.ctrlKey)) + { + var pageNum = (k == e.HOME || (k == e.DOWN && e.ctrlKey) || (k == e.LEFT && e.ctrlKey) || (k == e.PAGEDOWN && e.ctrlKey)) ? 1 : d.pages; + this.field.dom.value = pageNum; + this.ds.load({params:{start: (pageNum - 1) * this.pageSize, limit: this.pageSize}}); + e.stopEvent(); + } + else if(k == e.UP || k == e.RIGHT || k == e.PAGEUP || k == e.DOWN || k == e.LEFT || k == e.PAGEDOWN) + { + var v = this.field.dom.value, pageNum; + var increment = (e.shiftKey) ? 10 : 1; + if(k == e.DOWN || k == e.LEFT || k == e.PAGEDOWN) { + increment *= -1; + } + if(!v || isNaN(pageNum = parseInt(v, 10))) { + this.field.dom.value = d.activePage; + return; + } + else if(parseInt(v, 10) + increment >= 1 & parseInt(v, 10) + increment <= d.pages) + { + this.field.dom.value = parseInt(v, 10) + increment; + pageNum = Math.min(Math.max(1, pageNum + increment), d.pages) - 1; + this.ds.load({params:{start: pageNum * this.pageSize, limit: this.pageSize}}); + } + e.stopEvent(); + } + }, + + // private + beforeLoad : function(){ + if(this.loading){ + this.loading.disable(); + } + }, + + // private + onClick : function(which){ + + var ds = this.ds; + if (!ds) { + return; + } + + switch(which){ + case "first": + ds.load({params:{start: 0, limit: this.pageSize}}); + break; + case "prev": + ds.load({params:{start: Math.max(0, this.cursor-this.pageSize), limit: this.pageSize}}); + break; + case "next": + ds.load({params:{start: this.cursor+this.pageSize, limit: this.pageSize}}); + break; + case "last": + var total = ds.getTotalCount(); + var extra = total % this.pageSize; + var lastStart = extra ? (total - extra) : total-this.pageSize; + ds.load({params:{start: lastStart, limit: this.pageSize}}); + break; + case "refresh": + ds.load({params:{start: this.cursor, limit: this.pageSize}}); + break; + } + }, + + /** + * Unbinds the paging toolbar from the specified {@link Roo.data.Store} + * @param {Roo.data.Store} store The data store to unbind + */ + unbind : function(ds){ + ds.un("beforeload", this.beforeLoad, this); + ds.un("load", this.onLoad, this); + ds.un("loadexception", this.onLoadError, this); + ds.un("remove", this.updateInfo, this); + ds.un("add", this.updateInfo, this); + this.ds = undefined; + }, + + /** + * Binds the paging toolbar to the specified {@link Roo.data.Store} + * @param {Roo.data.Store} store The data store to bind + */ + bind : function(ds){ + ds.on("beforeload", this.beforeLoad, this); + ds.on("load", this.onLoad, this); + ds.on("loadexception", this.onLoadError, this); + ds.on("remove", this.updateInfo, this); + ds.on("add", this.updateInfo, this); + this.ds = ds; + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_PhoneInput.js.html b/docs2/src/Roo_bootstrap_PhoneInput.js.html new file mode 100644 index 0000000000..ddb794072d --- /dev/null +++ b/docs2/src/Roo_bootstrap_PhoneInput.js.html @@ -0,0 +1,560 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/PhoneInput.js/** +* This script refer to: +* Title: International Telephone Input +* Author: Jack O'Connor +* Code version: v12.1.12 +* Availability: https://github.com/jackocnr/intl-tel-input.git +**/ + +/** + * @class Roo.bootstrap.PhoneInput + * @extends Roo.bootstrap.TriggerField + * An input with International dial-code selection + + * @cfg {String} defaultDialCode default '+852' + * @cfg {Array} preferedCountries default [] + + * @constructor + * Create a new PhoneInput. + * @param {Object} config Configuration options + */ + +Roo.bootstrap.PhoneInput = function(config) { + Roo.bootstrap.PhoneInput.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.PhoneInput, Roo.bootstrap.TriggerField, { + + listWidth: undefined, + + selectedClass: 'active', + + invalidClass : "has-warning", + + validClass: 'has-success', + + allowed: '0123456789', + + max_length: 15, + + /** + * @cfg {String} defaultDialCode The default dial code when initializing the input + */ + defaultDialCode: '+852', + + /** + * @cfg {Array} preferedCountries A list of iso2 in array (e.g. ['hk','us']). Those related countries will show at the top of the input's choices + */ + preferedCountries: false, + + getAutoCreate : function() + { + var data = Roo.bootstrap.PhoneInputData(); + var align = this.labelAlign || this.parentLabelAlign(); + var id = Roo.id(); + + this.allCountries = []; + this.dialCodeMapping = []; + + for (var i = 0; i < data.length; i++) { + var c = data[i]; + this.allCountries[i] = { + name: c[0], + iso2: c[1], + dialCode: c[2], + priority: c[3] || 0, + areaCodes: c[4] || null + }; + this.dialCodeMapping[c[2]] = { + name: c[0], + iso2: c[1], + priority: c[3] || 0, + areaCodes: c[4] || null + }; + } + + var cfg = { + cls: 'form-group', + cn: [] + }; + + var input = { + tag: 'input', + id : id, + // type: 'number', -- do not use number - we get the flaky up/down arrows. + maxlength: this.max_length, + cls : 'form-control tel-input', + autocomplete: 'new-password' + }; + + var hiddenInput = { + tag: 'input', + type: 'hidden', + cls: 'hidden-tel-input' + }; + + if (this.name) { + hiddenInput.name = this.name; + } + + if (this.disabled) { + input.disabled = true; + } + + var flag_container = { + tag: 'div', + cls: 'flag-box', + cn: [ + { + tag: 'div', + cls: 'flag' + }, + { + tag: 'div', + cls: 'caret' + } + ] + }; + + var box = { + tag: 'div', + cls: this.hasFeedback ? 'has-feedback' : '', + cn: [ + hiddenInput, + input, + { + tag: 'input', + cls: 'dial-code-holder', + disabled: true + } + ] + }; + + var container = { + cls: 'roo-select2-container input-group', + cn: [ + flag_container, + box + ] + }; + + if (this.fieldLabel.length) { + var indicator = { + tag: 'i', + tooltip: 'This field is required' + }; + + var label = { + tag: 'label', + 'for': id, + cls: 'control-label', + cn: [] + }; + + var label_text = { + tag: 'span', + html: this.fieldLabel + }; + + indicator.cls = 'roo-required-indicator text-danger fa fa-lg fa-star left-indicator'; + label.cn = [ + indicator, + label_text + ]; + + if(this.indicatorpos == 'right') { + indicator.cls = 'roo-required-indicator text-danger fa fa-lg fa-star right-indicator'; + label.cn = [ + label_text, + indicator + ]; + } + + if(align == 'left') { + container = { + tag: 'div', + cn: [ + container + ] + }; + + if(this.labelWidth > 12){ + label.style = "width: " + this.labelWidth + 'px'; + } + if(this.labelWidth < 13 && this.labelmd == 0){ + this.labelmd = this.labelWidth; + } + if(this.labellg > 0){ + label.cls += ' col-lg-' + this.labellg; + input.cls += ' col-lg-' + (12 - this.labellg); + } + if(this.labelmd > 0){ + label.cls += ' col-md-' + this.labelmd; + container.cls += ' col-md-' + (12 - this.labelmd); + } + if(this.labelsm > 0){ + label.cls += ' col-sm-' + this.labelsm; + container.cls += ' col-sm-' + (12 - this.labelsm); + } + if(this.labelxs > 0){ + label.cls += ' col-xs-' + this.labelxs; + container.cls += ' col-xs-' + (12 - this.labelxs); + } + } + } + + cfg.cn = [ + label, + container + ]; + + var settings = this; + + ['xs','sm','md','lg'].map(function(size){ + if (settings[size]) { + cfg.cls += ' col-' + size + '-' + settings[size]; + } + }); + + this.store = new Roo.data.Store({ + proxy : new Roo.data.MemoryProxy({}), + reader : new Roo.data.JsonReader({ + fields : [ + { + 'name' : 'name', + 'type' : 'string' + }, + { + 'name' : 'iso2', + 'type' : 'string' + }, + { + 'name' : 'dialCode', + 'type' : 'string' + }, + { + 'name' : 'priority', + 'type' : 'string' + }, + { + 'name' : 'areaCodes', + 'type' : 'string' + } + ] + }) + }); + + if(!this.preferedCountries) { + this.preferedCountries = [ + 'hk', + 'gb', + 'us' + ]; + } + + var p = this.preferedCountries.reverse(); + + if(p) { + for (var i = 0; i < p.length; i++) { + for (var j = 0; j < this.allCountries.length; j++) { + if(this.allCountries[j].iso2 == p[i]) { + var t = this.allCountries[j]; + this.allCountries.splice(j,1); + this.allCountries.unshift(t); + } + } + } + } + + this.store.proxy.data = { + success: true, + data: this.allCountries + }; + + return cfg; + }, + + initEvents : function() + { + this.createList(); + Roo.bootstrap.PhoneInput.superclass.initEvents.call(this); + + this.indicator = this.indicatorEl(); + this.flag = this.flagEl(); + this.dialCodeHolder = this.dialCodeHolderEl(); + + this.trigger = this.el.select('div.flag-box',true).first(); + this.trigger.on("click", this.onTriggerClick, this, {preventDefault:true}); + + var _this = this; + + (function(){ + var lw = _this.listWidth || Math.max(_this.inputEl().getWidth(), _this.minListWidth); + _this.list.setWidth(lw); + }).defer(100); + + this.list.on('mouseover', this.onViewOver, this); + this.list.on('mousemove', this.onViewMove, this); + this.inputEl().on("keyup", this.onKeyUp, this); + this.inputEl().on("keypress", this.onKeyPress, this); + + this.tpl = '<li><a href="#"><div class="flag {iso2}"></div>{name} <span class="dial-code">+{dialCode}</span></a></li>'; + + this.view = new Roo.View(this.list, this.tpl, { + singleSelect:true, store: this.store, selectedClass: this.selectedClass + }); + + this.view.on('click', this.onViewClick, this); + this.setValue(this.defaultDialCode); + }, + + onTriggerClick : function(e) + { + Roo.log('trigger click'); + if(this.disabled){ + return; + } + + if(this.isExpanded()){ + this.collapse(); + this.hasFocus = false; + }else { + this.store.load({}); + this.hasFocus = true; + this.expand(); + } + }, + + isExpanded : function() + { + return this.list.isVisible(); + }, + + collapse : function() + { + if(!this.isExpanded()){ + return; + } + this.list.hide(); + Roo.get(document).un('mousedown', this.collapseIf, this); + Roo.get(document).un('mousewheel', this.collapseIf, this); + this.fireEvent('collapse', this); + this.validate(); + }, + + expand : function() + { + Roo.log('expand'); + + if(this.isExpanded() || !this.hasFocus){ + return; + } + + var lw = this.listWidth || Math.max(this.inputEl().getWidth(), this.minListWidth); + this.list.setWidth(lw); + + this.list.show(); + this.restrictHeight(); + + Roo.get(document).on('mousedown', this.collapseIf, this); + Roo.get(document).on('mousewheel', this.collapseIf, this); + + this.fireEvent('expand', this); + }, + + restrictHeight : function() + { + this.list.alignTo(this.inputEl(), this.listAlign); + this.list.alignTo(this.inputEl(), this.listAlign); + }, + + onViewOver : function(e, t) + { + if(this.inKeyMode){ + return; + } + var item = this.view.findItemFromChild(t); + + if(item){ + var index = this.view.indexOf(item); + this.select(index, false); + } + }, + + // private + onViewClick : function(view, doFocus, el, e) + { + var index = this.view.getSelectedIndexes()[0]; + + var r = this.store.getAt(index); + + if(r){ + this.onSelect(r, index); + } + if(doFocus !== false && !this.blockFocus){ + this.inputEl().focus(); + } + }, + + onViewMove : function(e, t) + { + this.inKeyMode = false; + }, + + select : function(index, scrollIntoView) + { + this.selectedIndex = index; + this.view.select(index); + if(scrollIntoView !== false){ + var el = this.view.getNode(index); + if(el){ + this.list.scrollChildIntoView(el, false); + } + } + }, + + createList : function() + { + this.list = Roo.get(document.body).createChild({ + tag: 'ul', + cls: 'typeahead typeahead-long dropdown-menu tel-list', + style: 'display:none' + }); + + this.list.setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + }, + + collapseIf : function(e) + { + var in_combo = e.within(this.el); + var in_list = e.within(this.list); + var is_list = (Roo.get(e.getTarget()).id == this.list.id) ? true : false; + + if (in_combo || in_list || is_list) { + return; + } + this.collapse(); + }, + + onSelect : function(record, index) + { + if(this.fireEvent('beforeselect', this, record, index) !== false){ + + this.setFlagClass(record.data.iso2); + this.setDialCode(record.data.dialCode); + this.hasFocus = false; + this.collapse(); + this.fireEvent('select', this, record, index); + } + }, + + flagEl : function() + { + var flag = this.el.select('div.flag',true).first(); + if(!flag){ + return false; + } + return flag; + }, + + dialCodeHolderEl : function() + { + var d = this.el.select('input.dial-code-holder',true).first(); + if(!d){ + return false; + } + return d; + }, + + setDialCode : function(v) + { + this.dialCodeHolder.dom.value = '+'+v; + }, + + setFlagClass : function(n) + { + this.flag.dom.className = 'flag '+n; + }, + + getValue : function() + { + var v = this.inputEl().getValue(); + if(this.dialCodeHolder) { + v = this.dialCodeHolder.dom.value+this.inputEl().getValue(); + } + return v; + }, + + setValue : function(v) + { + var d = this.getDialCode(v); + + //invalid dial code + if(v.length == 0 || !d || d.length == 0) { + if(this.rendered){ + this.inputEl().dom.value = (v === null || v === undefined ? '' : v); + this.hiddenEl().dom.value = (v === null || v === undefined ? '' : v); + } + return; + } + + //valid dial code + this.setFlagClass(this.dialCodeMapping[d].iso2); + this.setDialCode(d); + this.inputEl().dom.value = v.replace('+'+d,''); + this.hiddenEl().dom.value = this.getValue(); + + this.validate(); + }, + + getDialCode : function(v) + { + v = v || ''; + + if (v.length == 0) { + return this.dialCodeHolder.dom.value; + } + + var dialCode = ""; + if (v.charAt(0) != "+") { + return false; + } + var numericChars = ""; + for (var i = 1; i < v.length; i++) { + var c = v.charAt(i); + if (!isNaN(c)) { + numericChars += c; + if (this.dialCodeMapping[numericChars]) { + dialCode = v.substr(1, i); + } + if (numericChars.length == 4) { + break; + } + } + } + return dialCode; + }, + + reset : function() + { + this.setValue(this.defaultDialCode); + this.validate(); + }, + + hiddenEl : function() + { + return this.el.select('input.hidden-tel-input',true).first(); + }, + + // after setting val + onKeyUp : function(e){ + this.setValue(this.getValue()); + }, + + onKeyPress : function(e){ + if(this.allowed.indexOf(String.fromCharCode(e.getCharCode())) === -1){ + e.stopEvent(); + } + } + +}); \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_PhoneInputData.js.html b/docs2/src/Roo_bootstrap_PhoneInputData.js.html new file mode 100644 index 0000000000..1d7a18b6f2 --- /dev/null +++ b/docs2/src/Roo_bootstrap_PhoneInputData.js.html @@ -0,0 +1,1260 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/PhoneInputData.js/** +* This script refer to: +* Title: International Telephone Input +* Author: Jack O'Connor +* Code version: v12.1.12 +* Availability: https://github.com/jackocnr/intl-tel-input.git +**/ + +Roo.bootstrap.PhoneInputData = function() { + var d = [ + [ + "Afghanistan (‫افغانستان‬‎)", + "af", + "93" + ], + [ + "Albania (Shqipëri)", + "al", + "355" + ], + [ + "Algeria (‫الجزائر‬‎)", + "dz", + "213" + ], + [ + "American Samoa", + "as", + "1684" + ], + [ + "Andorra", + "ad", + "376" + ], + [ + "Angola", + "ao", + "244" + ], + [ + "Anguilla", + "ai", + "1264" + ], + [ + "Antigua and Barbuda", + "ag", + "1268" + ], + [ + "Argentina", + "ar", + "54" + ], + [ + "Armenia (Հայաստան)", + "am", + "374" + ], + [ + "Aruba", + "aw", + "297" + ], + [ + "Australia", + "au", + "61", + 0 + ], + [ + "Austria (Österreich)", + "at", + "43" + ], + [ + "Azerbaijan (Azərbaycan)", + "az", + "994" + ], + [ + "Bahamas", + "bs", + "1242" + ], + [ + "Bahrain (‫البحرين‬‎)", + "bh", + "973" + ], + [ + "Bangladesh (বাংলাদেশ)", + "bd", + "880" + ], + [ + "Barbados", + "bb", + "1246" + ], + [ + "Belarus (Беларусь)", + "by", + "375" + ], + [ + "Belgium (België)", + "be", + "32" + ], + [ + "Belize", + "bz", + "501" + ], + [ + "Benin (Bénin)", + "bj", + "229" + ], + [ + "Bermuda", + "bm", + "1441" + ], + [ + "Bhutan (འབྲུག)", + "bt", + "975" + ], + [ + "Bolivia", + "bo", + "591" + ], + [ + "Bosnia and Herzegovina (Босна и Херцеговина)", + "ba", + "387" + ], + [ + "Botswana", + "bw", + "267" + ], + [ + "Brazil (Brasil)", + "br", + "55" + ], + [ + "British Indian Ocean Territory", + "io", + "246" + ], + [ + "British Virgin Islands", + "vg", + "1284" + ], + [ + "Brunei", + "bn", + "673" + ], + [ + "Bulgaria (България)", + "bg", + "359" + ], + [ + "Burkina Faso", + "bf", + "226" + ], + [ + "Burundi (Uburundi)", + "bi", + "257" + ], + [ + "Cambodia (កម្ពុជា)", + "kh", + "855" + ], + [ + "Cameroon (Cameroun)", + "cm", + "237" + ], + [ + "Canada", + "ca", + "1", + 1, + ["204", "226", "236", "249", "250", "289", "306", "343", "365", "387", "403", "416", "418", "431", "437", "438", "450", "506", "514", "519", "548", "579", "581", "587", "604", "613", "639", "647", "672", "705", "709", "742", "778", "780", "782", "807", "819", "825", "867", "873", "902", "905"] + ], + [ + "Cape Verde (Kabu Verdi)", + "cv", + "238" + ], + [ + "Caribbean Netherlands", + "bq", + "599", + 1 + ], + [ + "Cayman Islands", + "ky", + "1345" + ], + [ + "Central African Republic (République centrafricaine)", + "cf", + "236" + ], + [ + "Chad (Tchad)", + "td", + "235" + ], + [ + "Chile", + "cl", + "56" + ], + [ + "China (中国)", + "cn", + "86" + ], + [ + "Christmas Island", + "cx", + "61", + 2 + ], + [ + "Cocos (Keeling) Islands", + "cc", + "61", + 1 + ], + [ + "Colombia", + "co", + "57" + ], + [ + "Comoros (‫جزر القمر‬‎)", + "km", + "269" + ], + [ + "Congo (DRC) (Jamhuri ya Kidemokrasia ya Kongo)", + "cd", + "243" + ], + [ + "Congo (Republic) (Congo-Brazzaville)", + "cg", + "242" + ], + [ + "Cook Islands", + "ck", + "682" + ], + [ + "Costa Rica", + "cr", + "506" + ], + [ + "Côte d’Ivoire", + "ci", + "225" + ], + [ + "Croatia (Hrvatska)", + "hr", + "385" + ], + [ + "Cuba", + "cu", + "53" + ], + [ + "Curaçao", + "cw", + "599", + 0 + ], + [ + "Cyprus (Κύπρος)", + "cy", + "357" + ], + [ + "Czech Republic (Česká republika)", + "cz", + "420" + ], + [ + "Denmark (Danmark)", + "dk", + "45" + ], + [ + "Djibouti", + "dj", + "253" + ], + [ + "Dominica", + "dm", + "1767" + ], + [ + "Dominican Republic (República Dominicana)", + "do", + "1", + 2, + ["809", "829", "849"] + ], + [ + "Ecuador", + "ec", + "593" + ], + [ + "Egypt (‫مصر‬‎)", + "eg", + "20" + ], + [ + "El Salvador", + "sv", + "503" + ], + [ + "Equatorial Guinea (Guinea Ecuatorial)", + "gq", + "240" + ], + [ + "Eritrea", + "er", + "291" + ], + [ + "Estonia (Eesti)", + "ee", + "372" + ], + [ + "Ethiopia", + "et", + "251" + ], + [ + "Falkland Islands (Islas Malvinas)", + "fk", + "500" + ], + [ + "Faroe Islands (Føroyar)", + "fo", + "298" + ], + [ + "Fiji", + "fj", + "679" + ], + [ + "Finland (Suomi)", + "fi", + "358", + 0 + ], + [ + "France", + "fr", + "33" + ], + [ + "French Guiana (Guyane française)", + "gf", + "594" + ], + [ + "French Polynesia (Polynésie française)", + "pf", + "689" + ], + [ + "Gabon", + "ga", + "241" + ], + [ + "Gambia", + "gm", + "220" + ], + [ + "Georgia (საქართველო)", + "ge", + "995" + ], + [ + "Germany (Deutschland)", + "de", + "49" + ], + [ + "Ghana (Gaana)", + "gh", + "233" + ], + [ + "Gibraltar", + "gi", + "350" + ], + [ + "Greece (Ελλάδα)", + "gr", + "30" + ], + [ + "Greenland (Kalaallit Nunaat)", + "gl", + "299" + ], + [ + "Grenada", + "gd", + "1473" + ], + [ + "Guadeloupe", + "gp", + "590", + 0 + ], + [ + "Guam", + "gu", + "1671" + ], + [ + "Guatemala", + "gt", + "502" + ], + [ + "Guernsey", + "gg", + "44", + 1 + ], + [ + "Guinea (Guinée)", + "gn", + "224" + ], + [ + "Guinea-Bissau (Guiné Bissau)", + "gw", + "245" + ], + [ + "Guyana", + "gy", + "592" + ], + [ + "Haiti", + "ht", + "509" + ], + [ + "Honduras", + "hn", + "504" + ], + [ + "Hong Kong (香港)", + "hk", + "852" + ], + [ + "Hungary (Magyarország)", + "hu", + "36" + ], + [ + "Iceland (Ísland)", + "is", + "354" + ], + [ + "India (भारत)", + "in", + "91" + ], + [ + "Indonesia", + "id", + "62" + ], + [ + "Iran (‫ایران‬‎)", + "ir", + "98" + ], + [ + "Iraq (‫العراق‬‎)", + "iq", + "964" + ], + [ + "Ireland", + "ie", + "353" + ], + [ + "Isle of Man", + "im", + "44", + 2 + ], + [ + "Israel (‫ישראל‬‎)", + "il", + "972" + ], + [ + "Italy (Italia)", + "it", + "39", + 0 + ], + [ + "Jamaica", + "jm", + "1876" + ], + [ + "Japan (日本)", + "jp", + "81" + ], + [ + "Jersey", + "je", + "44", + 3 + ], + [ + "Jordan (‫الأردن‬‎)", + "jo", + "962" + ], + [ + "Kazakhstan (Казахстан)", + "kz", + "7", + 1 + ], + [ + "Kenya", + "ke", + "254" + ], + [ + "Kiribati", + "ki", + "686" + ], + [ + "Kosovo", + "xk", + "383" + ], + [ + "Kuwait (‫الكويت‬‎)", + "kw", + "965" + ], + [ + "Kyrgyzstan (Кыргызстан)", + "kg", + "996" + ], + [ + "Laos (ລາວ)", + "la", + "856" + ], + [ + "Latvia (Latvija)", + "lv", + "371" + ], + [ + "Lebanon (‫لبنان‬‎)", + "lb", + "961" + ], + [ + "Lesotho", + "ls", + "266" + ], + [ + "Liberia", + "lr", + "231" + ], + [ + "Libya (‫ليبيا‬‎)", + "ly", + "218" + ], + [ + "Liechtenstein", + "li", + "423" + ], + [ + "Lithuania (Lietuva)", + "lt", + "370" + ], + [ + "Luxembourg", + "lu", + "352" + ], + [ + "Macau (澳門)", + "mo", + "853" + ], + [ + "Macedonia (FYROM) (Македонија)", + "mk", + "389" + ], + [ + "Madagascar (Madagasikara)", + "mg", + "261" + ], + [ + "Malawi", + "mw", + "265" + ], + [ + "Malaysia", + "my", + "60" + ], + [ + "Maldives", + "mv", + "960" + ], + [ + "Mali", + "ml", + "223" + ], + [ + "Malta", + "mt", + "356" + ], + [ + "Marshall Islands", + "mh", + "692" + ], + [ + "Martinique", + "mq", + "596" + ], + [ + "Mauritania (‫موريتانيا‬‎)", + "mr", + "222" + ], + [ + "Mauritius (Moris)", + "mu", + "230" + ], + [ + "Mayotte", + "yt", + "262", + 1 + ], + [ + "Mexico (México)", + "mx", + "52" + ], + [ + "Micronesia", + "fm", + "691" + ], + [ + "Moldova (Republica Moldova)", + "md", + "373" + ], + [ + "Monaco", + "mc", + "377" + ], + [ + "Mongolia (Монгол)", + "mn", + "976" + ], + [ + "Montenegro (Crna Gora)", + "me", + "382" + ], + [ + "Montserrat", + "ms", + "1664" + ], + [ + "Morocco (‫المغرب‬‎)", + "ma", + "212", + 0 + ], + [ + "Mozambique (Moçambique)", + "mz", + "258" + ], + [ + "Myanmar (Burma) (မြန်မာ)", + "mm", + "95" + ], + [ + "Namibia (Namibië)", + "na", + "264" + ], + [ + "Nauru", + "nr", + "674" + ], + [ + "Nepal (नेपाल)", + "np", + "977" + ], + [ + "Netherlands (Nederland)", + "nl", + "31" + ], + [ + "New Caledonia (Nouvelle-Calédonie)", + "nc", + "687" + ], + [ + "New Zealand", + "nz", + "64" + ], + [ + "Nicaragua", + "ni", + "505" + ], + [ + "Niger (Nijar)", + "ne", + "227" + ], + [ + "Nigeria", + "ng", + "234" + ], + [ + "Niue", + "nu", + "683" + ], + [ + "Norfolk Island", + "nf", + "672" + ], + [ + "North Korea (조선 민주주의 인민 공화국)", + "kp", + "850" + ], + [ + "Northern Mariana Islands", + "mp", + "1670" + ], + [ + "Norway (Norge)", + "no", + "47", + 0 + ], + [ + "Oman (‫عُمان‬‎)", + "om", + "968" + ], + [ + "Pakistan (‫پاکستان‬‎)", + "pk", + "92" + ], + [ + "Palau", + "pw", + "680" + ], + [ + "Palestine (‫فلسطين‬‎)", + "ps", + "970" + ], + [ + "Panama (Panamá)", + "pa", + "507" + ], + [ + "Papua New Guinea", + "pg", + "675" + ], + [ + "Paraguay", + "py", + "595" + ], + [ + "Peru (Perú)", + "pe", + "51" + ], + [ + "Philippines", + "ph", + "63" + ], + [ + "Poland (Polska)", + "pl", + "48" + ], + [ + "Portugal", + "pt", + "351" + ], + [ + "Puerto Rico", + "pr", + "1", + 3, + ["787", "939"] + ], + [ + "Qatar (‫قطر‬‎)", + "qa", + "974" + ], + [ + "Réunion (La Réunion)", + "re", + "262", + 0 + ], + [ + "Romania (România)", + "ro", + "40" + ], + [ + "Russia (Россия)", + "ru", + "7", + 0 + ], + [ + "Rwanda", + "rw", + "250" + ], + [ + "Saint Barthélemy", + "bl", + "590", + 1 + ], + [ + "Saint Helena", + "sh", + "290" + ], + [ + "Saint Kitts and Nevis", + "kn", + "1869" + ], + [ + "Saint Lucia", + "lc", + "1758" + ], + [ + "Saint Martin (Saint-Martin (partie française))", + "mf", + "590", + 2 + ], + [ + "Saint Pierre and Miquelon (Saint-Pierre-et-Miquelon)", + "pm", + "508" + ], + [ + "Saint Vincent and the Grenadines", + "vc", + "1784" + ], + [ + "Samoa", + "ws", + "685" + ], + [ + "San Marino", + "sm", + "378" + ], + [ + "São Tomé and Príncipe (São Tomé e Príncipe)", + "st", + "239" + ], + [ + "Saudi Arabia (‫المملكة العربية السعودية‬‎)", + "sa", + "966" + ], + [ + "Senegal (Sénégal)", + "sn", + "221" + ], + [ + "Serbia (Србија)", + "rs", + "381" + ], + [ + "Seychelles", + "sc", + "248" + ], + [ + "Sierra Leone", + "sl", + "232" + ], + [ + "Singapore", + "sg", + "65" + ], + [ + "Sint Maarten", + "sx", + "1721" + ], + [ + "Slovakia (Slovensko)", + "sk", + "421" + ], + [ + "Slovenia (Slovenija)", + "si", + "386" + ], + [ + "Solomon Islands", + "sb", + "677" + ], + [ + "Somalia (Soomaaliya)", + "so", + "252" + ], + [ + "South Africa", + "za", + "27" + ], + [ + "South Korea (대한민국)", + "kr", + "82" + ], + [ + "South Sudan (‫جنوب السودان‬‎)", + "ss", + "211" + ], + [ + "Spain (España)", + "es", + "34" + ], + [ + "Sri Lanka (ශ්‍රී ලංකාව)", + "lk", + "94" + ], + [ + "Sudan (‫السودان‬‎)", + "sd", + "249" + ], + [ + "Suriname", + "sr", + "597" + ], + [ + "Svalbard and Jan Mayen", + "sj", + "47", + 1 + ], + [ + "Swaziland", + "sz", + "268" + ], + [ + "Sweden (Sverige)", + "se", + "46" + ], + [ + "Switzerland (Schweiz)", + "ch", + "41" + ], + [ + "Syria (‫سوريا‬‎)", + "sy", + "963" + ], + [ + "Taiwan (台灣)", + "tw", + "886" + ], + [ + "Tajikistan", + "tj", + "992" + ], + [ + "Tanzania", + "tz", + "255" + ], + [ + "Thailand (ไทย)", + "th", + "66" + ], + [ + "Timor-Leste", + "tl", + "670" + ], + [ + "Togo", + "tg", + "228" + ], + [ + "Tokelau", + "tk", + "690" + ], + [ + "Tonga", + "to", + "676" + ], + [ + "Trinidad and Tobago", + "tt", + "1868" + ], + [ + "Tunisia (‫تونس‬‎)", + "tn", + "216" + ], + [ + "Turkey (Türkiye)", + "tr", + "90" + ], + [ + "Turkmenistan", + "tm", + "993" + ], + [ + "Turks and Caicos Islands", + "tc", + "1649" + ], + [ + "Tuvalu", + "tv", + "688" + ], + [ + "U.S. Virgin Islands", + "vi", + "1340" + ], + [ + "Uganda", + "ug", + "256" + ], + [ + "Ukraine (Україна)", + "ua", + "380" + ], + [ + "United Arab Emirates (‫الإمارات العربية المتحدة‬‎)", + "ae", + "971" + ], + [ + "United Kingdom", + "gb", + "44", + 0 + ], + [ + "United States", + "us", + "1", + 0 + ], + [ + "Uruguay", + "uy", + "598" + ], + [ + "Uzbekistan (Oʻzbekiston)", + "uz", + "998" + ], + [ + "Vanuatu", + "vu", + "678" + ], + [ + "Vatican City (Città del Vaticano)", + "va", + "39", + 1 + ], + [ + "Venezuela", + "ve", + "58" + ], + [ + "Vietnam (Việt Nam)", + "vn", + "84" + ], + [ + "Wallis and Futuna (Wallis-et-Futuna)", + "wf", + "681" + ], + [ + "Western Sahara (‫الصحراء الغربية‬‎)", + "eh", + "212", + 1 + ], + [ + "Yemen (‫اليمن‬‎)", + "ye", + "967" + ], + [ + "Zambia", + "zm", + "260" + ], + [ + "Zimbabwe", + "zw", + "263" + ], + [ + "Åland Islands", + "ax", + "358", + 1 + ] + ]; + + return d; +} \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Popover.js.html b/docs2/src/Roo_bootstrap_Popover.js.html new file mode 100644 index 0000000000..ae14009966 --- /dev/null +++ b/docs2/src/Roo_bootstrap_Popover.js.html @@ -0,0 +1,278 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Popover.js/* + * - LGPL + * + * element + * + */ + +/** + * @class Roo.bootstrap.Popover + * @extends Roo.bootstrap.Component + * Bootstrap Popover class + * @cfg {String} html contents of the popover (or false to use children..) + * @cfg {String} title of popover (or false to hide) + * @cfg {String} placement how it is placed + * @cfg {String} trigger click || hover (or false to trigger manually) + * @cfg {String} over what (parent or false to trigger manually.) + * @cfg {Number} delay - delay before showing + + * @constructor + * Create a new Popover + * @param {Object} config The config object + */ + +Roo.bootstrap.Popover = function(config){ + Roo.bootstrap.Popover.superclass.constructor.call(this, config); + + this.addEvents({ + // raw events + /** + * @event show + * After the popover show + * + * @param {Roo.bootstrap.Popover} this + */ + "show" : true, + /** + * @event hide + * After the popover hide + * + * @param {Roo.bootstrap.Popover} this + */ + "hide" : true + }); +}; + +Roo.extend(Roo.bootstrap.Popover, Roo.bootstrap.Component, { + + title: 'Fill in a title', + html: false, + + placement : 'right', + trigger : 'hover', // hover + + delay : 0, + + over: 'parent', + + can_build_overlaid : false, + + getChildContainer : function() + { + return this.el.select('.popover-content',true).first(); + }, + + getAutoCreate : function(){ + + var cfg = { + cls : 'popover roo-dynamic', + style: 'display:block', + cn : [ + { + cls : 'arrow' + }, + { + cls : 'popover-inner', + cn : [ + { + tag: 'h3', + cls: 'popover-title popover-header', + html : this.title + }, + { + cls : 'popover-content popover-body', + html : this.html + } + ] + + } + ] + }; + + return cfg; + }, + setTitle: function(str) + { + this.title = str; + this.el.select('.popover-title',true).first().dom.innerHTML = str; + }, + setContent: function(str) + { + this.html = str; + this.el.select('.popover-content',true).first().dom.innerHTML = str; + }, + // as it get's added to the bottom of the page. + onRender : function(ct, position) + { + Roo.bootstrap.Component.superclass.onRender.call(this, ct, position); + if(!this.el){ + var cfg = Roo.apply({}, this.getAutoCreate()); + cfg.id = Roo.id(); + + if (this.cls) { + cfg.cls += ' ' + this.cls; + } + if (this.style) { + cfg.style = this.style; + } + //Roo.log("adding to "); + this.el = Roo.get(document.body).createChild(cfg, position); +// Roo.log(this.el); + } + this.initEvents(); + }, + + initEvents : function() + { + this.el.select('.popover-title',true).setVisibilityMode(Roo.Element.DISPLAY); + this.el.enableDisplayMode('block'); + this.el.hide(); + if (this.over === false) { + return; + } + if (this.triggers === false) { + return; + } + var on_el = (this.over == 'parent') ? this.parent().el : Roo.get(this.over); + var triggers = this.trigger ? this.trigger.split(' ') : []; + Roo.each(triggers, function(trigger) { + + if (trigger == 'click') { + on_el.on('click', this.toggle, this); + } else if (trigger != 'manual') { + var eventIn = trigger == 'hover' ? 'mouseenter' : 'focusin'; + var eventOut = trigger == 'hover' ? 'mouseleave' : 'focusout'; + + on_el.on(eventIn ,this.enter, this); + on_el.on(eventOut, this.leave, this); + } + }, this); + + }, + + + // private + timeout : null, + hoverState : null, + + toggle : function () { + this.hoverState == 'in' ? this.leave() : this.enter(); + }, + + enter : function () { + + clearTimeout(this.timeout); + + this.hoverState = 'in'; + + if (!this.delay || !this.delay.show) { + this.show(); + return; + } + var _t = this; + this.timeout = setTimeout(function () { + if (_t.hoverState == 'in') { + _t.show(); + } + }, this.delay.show) + }, + + leave : function() { + clearTimeout(this.timeout); + + this.hoverState = 'out'; + + if (!this.delay || !this.delay.hide) { + this.hide(); + return; + } + var _t = this; + this.timeout = setTimeout(function () { + if (_t.hoverState == 'out') { + _t.hide(); + } + }, this.delay.hide) + }, + + show : function (on_el) + { + if (!on_el) { + on_el= (this.over == 'parent') ? this.parent().el : Roo.get(this.over); + } + + // set content. + this.el.select('.popover-title',true).first().dom.innerHtml = this.title; + if (this.html !== false) { + this.el.select('.popover-content',true).first().dom.innerHtml = this.html; + } + this.el.removeClass([ + 'fade','top','bottom', 'left', 'right','in', + 'bs-popover-top','bs-popover-bottom', 'bs-popover-left', 'bs-popover-right' + ]); + if (!this.title.length) { + this.el.select('.popover-title',true).hide(); + } + + var placement = typeof this.placement == 'function' ? + this.placement.call(this, this.el, on_el) : + this.placement; + + var autoToken = /\s?auto?\s?/i; + var autoPlace = autoToken.test(placement); + if (autoPlace) { + placement = placement.replace(autoToken, '') || 'top'; + } + + //this.el.detach() + //this.el.setXY([0,0]); + this.el.show(); + this.el.dom.style.display='block'; + this.el.addClass(placement); + + //this.el.appendTo(on_el); + + var p = this.getPosition(); + var box = this.el.getBox(); + + if (autoPlace) { + // fixme.. + } + var align = Roo.bootstrap.Popover.alignment[placement]; + +// Roo.log(align); + this.el.alignTo(on_el, align[0],align[1]); + //var arrow = this.el.select('.arrow',true).first(); + //arrow.set(align[2], + + this.el.addClass('in'); + + + if (this.el.hasClass('fade')) { + // fade it? + } + + this.hoverState = 'in'; + + this.fireEvent('show', this); + + }, + hide : function() + { + this.el.setXY([0,0]); + this.el.removeClass('in'); + this.el.hide(); + this.hoverState = null; + + this.fireEvent('hide', this); + } + +}); + +Roo.bootstrap.Popover.alignment = { + 'left' : ['r-l', [-10,0], 'right bs-popover-right'], + 'right' : ['l-r', [10,0], 'left bs-popover-left'], + 'bottom' : ['t-b', [0,10], 'top bs-popover-top'], + 'top' : [ 'b-t', [0,-10], 'bottom bs-popover-bottom'] +}; + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Progress.js.html b/docs2/src/Roo_bootstrap_Progress.js.html new file mode 100644 index 0000000000..16d76bcae3 --- /dev/null +++ b/docs2/src/Roo_bootstrap_Progress.js.html @@ -0,0 +1,53 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Progress.js/* + * - LGPL + * + * Progress + * + */ + +/** + * @class Roo.bootstrap.Progress + * @extends Roo.bootstrap.Component + * Bootstrap Progress class + * @cfg {Boolean} striped striped of the progress bar + * @cfg {Boolean} active animated of the progress bar + * + * + * @constructor + * Create a new Progress + * @param {Object} config The config object + */ + +Roo.bootstrap.Progress = function(config){ + Roo.bootstrap.Progress.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.Progress, Roo.bootstrap.Component, { + + striped : false, + active: false, + + getAutoCreate : function(){ + var cfg = { + tag: 'div', + cls: 'progress' + }; + + + if(this.striped){ + cfg.cls += ' progress-striped'; + } + + if(this.active){ + cfg.cls += ' active'; + } + + + return cfg; + } + +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_ProgressBar.js.html b/docs2/src/Roo_bootstrap_ProgressBar.js.html new file mode 100644 index 0000000000..0485bef1dd --- /dev/null +++ b/docs2/src/Roo_bootstrap_ProgressBar.js.html @@ -0,0 +1,95 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/ProgressBar.js/* + * - LGPL + * + * ProgressBar + * + */ + +/** + * @class Roo.bootstrap.ProgressBar + * @extends Roo.bootstrap.Component + * Bootstrap ProgressBar class + * @cfg {Number} aria_valuenow aria-value now + * @cfg {Number} aria_valuemin aria-value min + * @cfg {Number} aria_valuemax aria-value max + * @cfg {String} label label for the progress bar + * @cfg {String} panel (success | info | warning | danger ) + * @cfg {String} role role of the progress bar + * @cfg {String} sr_only text + * + * + * @constructor + * Create a new ProgressBar + * @param {Object} config The config object + */ + +Roo.bootstrap.ProgressBar = function(config){ + Roo.bootstrap.ProgressBar.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.ProgressBar, Roo.bootstrap.Component, { + + aria_valuenow : 0, + aria_valuemin : 0, + aria_valuemax : 100, + label : false, + panel : false, + role : false, + sr_only: false, + + getAutoCreate : function() + { + + var cfg = { + tag: 'div', + cls: 'progress-bar', + style: 'width:' + Math.ceil((this.aria_valuenow / this.aria_valuemax) * 100) + '%' + }; + + if(this.sr_only){ + cfg.cn = { + tag: 'span', + cls: 'sr-only', + html: this.sr_only + } + } + + if(this.role){ + cfg.role = this.role; + } + + if(this.aria_valuenow){ + cfg['aria-valuenow'] = this.aria_valuenow; + } + + if(this.aria_valuemin){ + cfg['aria-valuemin'] = this.aria_valuemin; + } + + if(this.aria_valuemax){ + cfg['aria-valuemax'] = this.aria_valuemax; + } + + if(this.label && !this.sr_only){ + cfg.html = this.label; + } + + if(this.panel){ + cfg.cls += ' progress-bar-' + this.panel; + } + + return cfg; + }, + + update : function(aria_valuenow) + { + this.aria_valuenow = aria_valuenow; + + this.el.setStyle('width', Math.ceil((this.aria_valuenow / this.aria_valuemax) * 100) + '%'); + } + +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Radio.js.html b/docs2/src/Roo_bootstrap_Radio.js.html new file mode 100644 index 0000000000..a3ed6bcb9a --- /dev/null +++ b/docs2/src/Roo_bootstrap_Radio.js.html @@ -0,0 +1,80 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Radio.js/* + * - LGPL + * + * RadioItem + * + */ + +/** + * @class Roo.bootstrap.Radio + * @extends Roo.bootstrap.Component + * Bootstrap Radio class + * @cfg {String} boxLabel - the label associated + * @cfg {String} value - the value of radio + * + * @constructor + * Create a new Radio + * @param {Object} config The config object + */ +Roo.bootstrap.Radio = function(config){ + Roo.bootstrap.Radio.superclass.constructor.call(this, config); + +}; + +Roo.extend(Roo.bootstrap.Radio, Roo.bootstrap.Component, { + + boxLabel : '', + + value : '', + + getAutoCreate : function() + { + var cfg = { + tag : 'div', + cls : 'form-group radio', + cn : [ + { + tag : 'label', + cls : 'box-label', + html : this.boxLabel + } + ] + }; + + return cfg; + }, + + initEvents : function() + { + this.parent().register(this); + + this.el.on('click', this.onClick, this); + + }, + + onClick : function(e) + { + if(this.parent().fireEvent('click', this.parent(), this, e) !== false){ + this.setChecked(true); + } + }, + + setChecked : function(state, suppressEvent) + { + this.parent().setValue(this.value, suppressEvent); + + }, + + setBoxLabel : function(v) + { + this.boxLabel = v; + + if(this.rendered){ + this.el.select('label.box-label',true).first().dom.innerHTML = (v === null || v === undefined ? '' : v); + } + } + +}); + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_RadioSet.js.html b/docs2/src/Roo_bootstrap_RadioSet.js.html new file mode 100644 index 0000000000..c14fc175b4 --- /dev/null +++ b/docs2/src/Roo_bootstrap_RadioSet.js.html @@ -0,0 +1,344 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/RadioSet.js/* + * - LGPL + * + * RadioSet + * + * + */ + +/** + * @class Roo.bootstrap.RadioSet + * @extends Roo.bootstrap.Input + * Bootstrap RadioSet class + * @cfg {String} indicatorpos (left|right) default left + * @cfg {Boolean} inline (true|false) inline the element (default true) + * @cfg {String} weight (primary|warning|info|danger|success) The text that appears beside the radio + * @constructor + * Create a new RadioSet + * @param {Object} config The config object + */ + +Roo.bootstrap.RadioSet = function(config){ + + Roo.bootstrap.RadioSet.superclass.constructor.call(this, config); + + this.radioes = []; + + Roo.bootstrap.RadioSet.register(this); + + this.addEvents({ + /** + * @event check + * Fires when the element is checked or unchecked. + * @param {Roo.bootstrap.RadioSet} this This radio + * @param {Roo.bootstrap.Radio} item The checked item + */ + check : true, + /** + * @event click + * Fires when the element is click. + * @param {Roo.bootstrap.RadioSet} this This radio set + * @param {Roo.bootstrap.Radio} item The checked item + * @param {Roo.EventObject} e The event object + */ + click : true + }); + +}; + +Roo.extend(Roo.bootstrap.RadioSet, Roo.bootstrap.Input, { + + radioes : false, + + inline : true, + + weight : '', + + indicatorpos : 'left', + + getAutoCreate : function() + { + var label = { + tag : 'label', + cls : 'roo-radio-set-label', + cn : [ + { + tag : 'span', + html : this.fieldLabel + } + ] + }; + if (Roo.bootstrap.version == 3) { + + + if(this.indicatorpos == 'left'){ + label.cn.unshift({ + tag : 'i', + cls : 'roo-required-indicator left-indicator text-danger fa fa-lg fa-star', + tooltip : 'This field is required' + }); + } else { + label.cn.push({ + tag : 'i', + cls : 'roo-required-indicator right-indicator text-danger fa fa-lg fa-star', + tooltip : 'This field is required' + }); + } + } + var items = { + tag : 'div', + cls : 'roo-radio-set-items' + }; + + var align = (!this.labelAlign) ? this.parentLabelAlign() : this.labelAlign; + + if (align === 'left' && this.fieldLabel.length) { + + items = { + cls : "roo-radio-set-right", + cn: [ + items + ] + }; + + if(this.labelWidth > 12){ + label.style = "width: " + this.labelWidth + 'px'; + } + + if(this.labelWidth < 13 && this.labelmd == 0){ + this.labelmd = this.labelWidth; + } + + if(this.labellg > 0){ + label.cls += ' col-lg-' + this.labellg; + items.cls += ' col-lg-' + (12 - this.labellg); + } + + if(this.labelmd > 0){ + label.cls += ' col-md-' + this.labelmd; + items.cls += ' col-md-' + (12 - this.labelmd); + } + + if(this.labelsm > 0){ + label.cls += ' col-sm-' + this.labelsm; + items.cls += ' col-sm-' + (12 - this.labelsm); + } + + if(this.labelxs > 0){ + label.cls += ' col-xs-' + this.labelxs; + items.cls += ' col-xs-' + (12 - this.labelxs); + } + } + + var cfg = { + tag : 'div', + cls : 'roo-radio-set', + cn : [ + { + tag : 'input', + cls : 'roo-radio-set-input', + type : 'hidden', + name : this.name, + value : this.value ? this.value : '' + }, + label, + items + ] + }; + + if(this.weight.length){ + cfg.cls += ' roo-radio-' + this.weight; + } + + if(this.inline) { + cfg.cls += ' roo-radio-set-inline'; + } + + var settings=this; + ['xs','sm','md','lg'].map(function(size){ + if (settings[size]) { + cfg.cls += ' col-' + size + '-' + settings[size]; + } + }); + + return cfg; + + }, + + initEvents : function() + { + this.labelEl = this.el.select('.roo-radio-set-label', true).first(); + this.labelEl.setVisibilityMode(Roo.Element.DISPLAY); + + if(!this.fieldLabel.length){ + this.labelEl.hide(); + } + + this.itemsEl = this.el.select('.roo-radio-set-items', true).first(); + this.itemsEl.setVisibilityMode(Roo.Element.DISPLAY); + + this.indicator = this.indicatorEl(); + + if(this.indicator){ + this.indicator.addClass('invisible'); + } + + this.originalValue = this.getValue(); + + }, + + inputEl: function () + { + return this.el.select('.roo-radio-set-input', true).first(); + }, + + getChildContainer : function() + { + return this.itemsEl; + }, + + register : function(item) + { + this.radioes.push(item); + + }, + + validate : function() + { + if(this.getVisibilityEl().hasClass('hidden')){ + return true; + } + + var valid = false; + + Roo.each(this.radioes, function(i){ + if(!i.checked){ + return; + } + + valid = true; + return false; + }); + + if(this.allowBlank) { + return true; + } + + if(this.disabled || valid){ + this.markValid(); + return true; + } + + this.markInvalid(); + return false; + + }, + + markValid : function() + { + if(this.labelEl.isVisible(true) && this.indicatorEl()){ + this.indicatorEl().removeClass('visible'); + this.indicatorEl().addClass('invisible'); + } + + + if (Roo.bootstrap.version == 3) { + this.el.removeClass([this.invalidClass, this.validClass]); + this.el.addClass(this.validClass); + } else { + this.el.removeClass(['is-invalid','is-valid']); + this.el.addClass(['is-valid']); + } + this.fireEvent('valid', this); + }, + + markInvalid : function(msg) + { + if(this.allowBlank || this.disabled){ + return; + } + + if(this.labelEl.isVisible(true) && this.indicatorEl()){ + this.indicatorEl().removeClass('invisible'); + this.indicatorEl().addClass('visible'); + } + if (Roo.bootstrap.version == 3) { + this.el.removeClass([this.invalidClass, this.validClass]); + this.el.addClass(this.invalidClass); + } else { + this.el.removeClass(['is-invalid','is-valid']); + this.el.addClass(['is-invalid']); + } + + this.fireEvent('invalid', this, msg); + + }, + + setValue : function(v, suppressEvent) + { + if(this.value === v){ + return; + } + + this.value = v; + + if(this.rendered){ + this.inputEl().dom.value = (v === null || v === undefined ? '' : v); + } + + Roo.each(this.radioes, function(i){ + i.checked = false; + i.el.removeClass('checked'); + }); + + Roo.each(this.radioes, function(i){ + + if(i.value === v || i.value.toString() === v.toString()){ + i.checked = true; + i.el.addClass('checked'); + + if(suppressEvent !== true){ + this.fireEvent('check', this, i); + } + + return false; + } + + }, this); + + this.validate(); + }, + + clearInvalid : function(){ + + if(!this.el || this.preventMark){ + return; + } + + this.el.removeClass([this.invalidClass]); + + this.fireEvent('valid', this); + } + +}); + +Roo.apply(Roo.bootstrap.RadioSet, { + + groups: {}, + + register : function(set) + { + this.groups[set.name] = set; + }, + + get: function(name) + { + if (typeof(this.groups[name]) == 'undefined') { + return false; + } + + return this.groups[name] ; + } + +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Row.js.html b/docs2/src/Roo_bootstrap_Row.js.html new file mode 100644 index 0000000000..efb03cc974 --- /dev/null +++ b/docs2/src/Roo_bootstrap_Row.js.html @@ -0,0 +1,35 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Row.js/* + * - LGPL + * + * row + * + */ + +/** + * @class Roo.bootstrap.Row + * @extends Roo.bootstrap.Component + * Bootstrap Row class (contains columns...) + * + * @constructor + * Create a new Row + * @param {Object} config The config object + */ + +Roo.bootstrap.Row = function(config){ + Roo.bootstrap.Row.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.Row, Roo.bootstrap.Component, { + + getAutoCreate : function(){ + return { + cls: 'row clearfix' + }; + } + + +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_SecurePass.js.html b/docs2/src/Roo_bootstrap_SecurePass.js.html new file mode 100644 index 0000000000..5b32682962 --- /dev/null +++ b/docs2/src/Roo_bootstrap_SecurePass.js.html @@ -0,0 +1,355 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/SecurePass.js/* + * - LGPL + * + * Input + * + */ + +/** + * @class Roo.bootstrap.SecurePass + * @extends Roo.bootstrap.Input + * Bootstrap SecurePass class + * + * + * @constructor + * Create a new SecurePass + * @param {Object} config The config object + */ + +Roo.bootstrap.SecurePass = function (config) { + // these go here, so the translation tool can replace them.. + this.errors = { + PwdEmpty: "Please type a password, and then retype it to confirm.", + PwdShort: "Your password must be at least 6 characters long. Please type a different password.", + PwdLong: "Your password can't contain more than 16 characters. Please type a different password.", + PwdBadChar: "The password contains characters that aren't allowed. Please type a different password.", + IDInPwd: "Your password can't include the part of your ID. Please type a different password.", + FNInPwd: "Your password can't contain your first name. Please type a different password.", + LNInPwd: "Your password can't contain your last name. Please type a different password.", + TooWeak: "Your password is Too Weak." + }, + this.meterLabel = "Password strength:"; + this.pwdStrengths = ["Too Weak", "Weak", "Medium", "Strong"]; + this.meterClass = [ + "roo-password-meter-tooweak", + "roo-password-meter-weak", + "roo-password-meter-medium", + "roo-password-meter-strong", + "roo-password-meter-grey" + ]; + + this.errors = {}; + + Roo.bootstrap.SecurePass.superclass.constructor.call(this, config); +} + +Roo.extend(Roo.bootstrap.SecurePass, Roo.bootstrap.Input, { + /** + * @cfg {String/Object} errors A Error spec, or true for a default spec (defaults to + * { + * PwdEmpty: "Please type a password, and then retype it to confirm.", + * PwdShort: "Your password must be at least 6 characters long. Please type a different password.", + * PwdLong: "Your password can't contain more than 16 characters. Please type a different password.", + * PwdBadChar: "The password contains characters that aren't allowed. Please type a different password.", + * IDInPwd: "Your password can't include the part of your ID. Please type a different password.", + * FNInPwd: "Your password can't contain your first name. Please type a different password.", + * LNInPwd: "Your password can't contain your last name. Please type a different password." + * }) + */ + // private + + meterWidth: 300, + errorMsg :'', + errors: false, + imageRoot: '/', + /** + * @cfg {String/Object} Label for the strength meter (defaults to + * 'Password strength:') + */ + // private + meterLabel: '', + /** + * @cfg {String/Object} pwdStrengths A pwdStrengths spec, or true for a default spec (defaults to + * ['Weak', 'Medium', 'Strong']) + */ + // private + pwdStrengths: false, + // private + strength: 0, + // private + _lastPwd: null, + // private + kCapitalLetter: 0, + kSmallLetter: 1, + kDigit: 2, + kPunctuation: 3, + + insecure: false, + // private + initEvents: function () + { + Roo.bootstrap.SecurePass.superclass.initEvents.call(this); + + if (this.el.is('input[type=password]') && Roo.isSafari) { + this.el.on('keydown', this.SafariOnKeyDown, this); + } + + this.el.on('keyup', this.checkStrength, this, {buffer: 50}); + }, + // private + onRender: function (ct, position) + { + Roo.bootstrap.SecurePass.superclass.onRender.call(this, ct, position); + this.wrap = this.el.wrap({cls: 'x-form-field-wrap'}); + this.trigger = this.wrap.createChild({tag: 'div', cls: 'StrengthMeter ' + this.triggerClass}); + + this.trigger.createChild({ + cn: [ + { + //id: 'PwdMeter', + tag: 'div', + cls: 'roo-password-meter-grey col-xs-12', + style: { + //width: 0, + //width: this.meterWidth + 'px' + } + }, + { + cls: 'roo-password-meter-text' + } + ] + }); + + + if (this.hideTrigger) { + this.trigger.setDisplayed(false); + } + this.setSize(this.width || '', this.height || ''); + }, + // private + onDestroy: function () + { + if (this.trigger) { + this.trigger.removeAllListeners(); + this.trigger.remove(); + } + if (this.wrap) { + this.wrap.remove(); + } + Roo.bootstrap.TriggerField.superclass.onDestroy.call(this); + }, + // private + checkStrength: function () + { + var pwd = this.inputEl().getValue(); + if (pwd == this._lastPwd) { + return; + } + + var strength; + if (this.ClientSideStrongPassword(pwd)) { + strength = 3; + } else if (this.ClientSideMediumPassword(pwd)) { + strength = 2; + } else if (this.ClientSideWeakPassword(pwd)) { + strength = 1; + } else { + strength = 0; + } + + Roo.log('strength1: ' + strength); + + //var pm = this.trigger.child('div/div/div').dom; + var pm = this.trigger.child('div/div'); + pm.removeClass(this.meterClass); + pm.addClass(this.meterClass[strength]); + + + var pt = this.trigger.child('/div').child('>*[class=roo-password-meter-text]').dom; + + pt.innerHTML = this.meterLabel + '&nbsp;' + this.pwdStrengths[strength]; + + this._lastPwd = pwd; + }, + reset: function () + { + Roo.bootstrap.SecurePass.superclass.reset.call(this); + + this._lastPwd = ''; + + var pm = this.trigger.child('div/div'); + pm.removeClass(this.meterClass); + pm.addClass('roo-password-meter-grey'); + + + var pt = this.trigger.child('/div').child('>*[class=roo-password-meter-text]').dom; + + pt.innerHTML = ''; + this.inputEl().dom.type='password'; + }, + // private + validateValue: function (value) + { + + if (!Roo.bootstrap.SecurePass.superclass.validateValue.call(this, value)) { + return false; + } + if (value.length == 0) { + if (this.allowBlank) { + this.clearInvalid(); + return true; + } + + this.markInvalid(this.errors.PwdEmpty); + this.errorMsg = this.errors.PwdEmpty; + return false; + } + + if(this.insecure){ + return true; + } + + if ('[\x21-\x7e]*'.match(value)) { + this.markInvalid(this.errors.PwdBadChar); + this.errorMsg = this.errors.PwdBadChar; + return false; + } + if (value.length < 6) { + this.markInvalid(this.errors.PwdShort); + this.errorMsg = this.errors.PwdShort; + return false; + } + if (value.length > 16) { + this.markInvalid(this.errors.PwdLong); + this.errorMsg = this.errors.PwdLong; + return false; + } + var strength; + if (this.ClientSideStrongPassword(value)) { + strength = 3; + } else if (this.ClientSideMediumPassword(value)) { + strength = 2; + } else if (this.ClientSideWeakPassword(value)) { + strength = 1; + } else { + strength = 0; + } + + + if (strength < 2) { + //this.markInvalid(this.errors.TooWeak); + this.errorMsg = this.errors.TooWeak; + //return false; + } + + + console.log('strength2: ' + strength); + + //var pm = this.trigger.child('div/div/div').dom; + + var pm = this.trigger.child('div/div'); + pm.removeClass(this.meterClass); + pm.addClass(this.meterClass[strength]); + + var pt = this.trigger.child('/div').child('>*[class=roo-password-meter-text]').dom; + + pt.innerHTML = this.meterLabel + '&nbsp;' + this.pwdStrengths[strength]; + + this.errorMsg = ''; + return true; + }, + // private + CharacterSetChecks: function (type) + { + this.type = type; + this.fResult = false; + }, + // private + isctype: function (character, type) + { + switch (type) { + case this.kCapitalLetter: + if (character >= 'A' && character <= 'Z') { + return true; + } + break; + + case this.kSmallLetter: + if (character >= 'a' && character <= 'z') { + return true; + } + break; + + case this.kDigit: + if (character >= '0' && character <= '9') { + return true; + } + break; + + case this.kPunctuation: + if ('!@#$%^&*()_+-=\'";:[{]}|.>,</?`~'.indexOf(character) >= 0) { + return true; + } + break; + + default: + return false; + } + + }, + // private + IsLongEnough: function (pwd, size) + { + return !(pwd == null || isNaN(size) || pwd.length < size); + }, + // private + SpansEnoughCharacterSets: function (word, nb) + { + if (!this.IsLongEnough(word, nb)) + { + return false; + } + + var characterSetChecks = new Array( + new this.CharacterSetChecks(this.kCapitalLetter), new this.CharacterSetChecks(this.kSmallLetter), + new this.CharacterSetChecks(this.kDigit), new this.CharacterSetChecks(this.kPunctuation) + ); + + for (var index = 0; index < word.length; ++index) { + for (var nCharSet = 0; nCharSet < characterSetChecks.length; ++nCharSet) { + if (!characterSetChecks[nCharSet].fResult && this.isctype(word.charAt(index), characterSetChecks[nCharSet].type)) { + characterSetChecks[nCharSet].fResult = true; + break; + } + } + } + + var nCharSets = 0; + for (var nCharSet = 0; nCharSet < characterSetChecks.length; ++nCharSet) { + if (characterSetChecks[nCharSet].fResult) { + ++nCharSets; + } + } + + if (nCharSets < nb) { + return false; + } + return true; + }, + // private + ClientSideStrongPassword: function (pwd) + { + return this.IsLongEnough(pwd, 8) && this.SpansEnoughCharacterSets(pwd, 3); + }, + // private + ClientSideMediumPassword: function (pwd) + { + return this.IsLongEnough(pwd, 7) && this.SpansEnoughCharacterSets(pwd, 2); + }, + // private + ClientSideWeakPassword: function (pwd) + { + return this.IsLongEnough(pwd, 6) || !this.IsLongEnough(pwd, 0); + } + +}) \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Slider.js.html b/docs2/src/Roo_bootstrap_Slider.js.html new file mode 100644 index 0000000000..b7e757601c --- /dev/null +++ b/docs2/src/Roo_bootstrap_Slider.js.html @@ -0,0 +1,43 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Slider.js/* + * - LGPL + * + * slider + * + */ + + +/** + * @class Roo.bootstrap.Slider + * @extends Roo.bootstrap.Component + * Bootstrap Slider class + * + * @constructor + * Create a new Slider + * @param {Object} config The config object + */ + +Roo.bootstrap.Slider = function(config){ + Roo.bootstrap.Slider.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.Slider, Roo.bootstrap.Component, { + + getAutoCreate : function(){ + + var cfg = { + tag: 'div', + cls: 'slider slider-sample1 vertical-handler ui-slider ui-slider-horizontal ui-widget ui-widget-content ui-corner-all', + cn: [ + { + tag: 'a', + cls: 'ui-slider-handle ui-state-default ui-corner-all' + } + ] + }; + + return cfg; + } + +}); + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_SplitBar.js.html b/docs2/src/Roo_bootstrap_SplitBar.js.html new file mode 100644 index 0000000000..07866b8580 --- /dev/null +++ b/docs2/src/Roo_bootstrap_SplitBar.js.html @@ -0,0 +1,452 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/SplitBar.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.bootstrap.SplitBar + * @extends Roo.util.Observable + * Creates draggable splitter bar functionality from two elements (element to be dragged and element to be resized). + * <br><br> + * Usage: + * <pre><code> +var split = new Roo.bootstrap.SplitBar("elementToDrag", "elementToSize", + Roo.bootstrap.SplitBar.HORIZONTAL, Roo.bootstrap.SplitBar.LEFT); +split.setAdapter(new Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter("container")); +split.minSize = 100; +split.maxSize = 600; +split.animate = true; +split.on('moved', splitterMoved); +</code></pre> + * @constructor + * Create a new SplitBar + * @config {String/HTMLElement/Roo.Element} dragElement The element to be dragged and act as the SplitBar. + * @config {String/HTMLElement/Roo.Element} resizingElement The element to be resized based on where the SplitBar element is dragged + * @config {Number} orientation (optional) Either Roo.bootstrap.SplitBar.HORIZONTAL or Roo.bootstrap.SplitBar.VERTICAL. (Defaults to HORIZONTAL) + * @config {Number} placement (optional) Either Roo.bootstrap.SplitBar.LEFT or Roo.bootstrap.SplitBar.RIGHT for horizontal or + Roo.bootstrap.SplitBar.TOP or Roo.bootstrap.SplitBar.BOTTOM for vertical. (By default, this is determined automatically by the initial + position of the SplitBar). + */ +Roo.bootstrap.SplitBar = function(cfg){ + + /** @private */ + + //{ + // dragElement : elm + // resizingElement: el, + // optional.. + // orientation : Either Roo.bootstrap.SplitBar.HORIZONTAL + // placement : Roo.bootstrap.SplitBar.LEFT , + // existingProxy ??? + //} + + this.el = Roo.get(cfg.dragElement, true); + this.el.dom.unselectable = "on"; + /** @private */ + this.resizingEl = Roo.get(cfg.resizingElement, true); + + /** + * @private + * The orientation of the split. Either Roo.bootstrap.SplitBar.HORIZONTAL or Roo.bootstrap.SplitBar.VERTICAL. (Defaults to HORIZONTAL) + * Note: If this is changed after creating the SplitBar, the placement property must be manually updated + * @type Number + */ + this.orientation = cfg.orientation || Roo.bootstrap.SplitBar.HORIZONTAL; + + /** + * The minimum size of the resizing element. (Defaults to 0) + * @type Number + */ + this.minSize = 0; + + /** + * The maximum size of the resizing element. (Defaults to 2000) + * @type Number + */ + this.maxSize = 2000; + + /** + * Whether to animate the transition to the new size + * @type Boolean + */ + this.animate = false; + + /** + * Whether to create a transparent shim that overlays the page when dragging, enables dragging across iframes. + * @type Boolean + */ + this.useShim = false; + + /** @private */ + this.shim = null; + + if(!cfg.existingProxy){ + /** @private */ + this.proxy = Roo.bootstrap.SplitBar.createProxy(this.orientation); + }else{ + this.proxy = Roo.get(cfg.existingProxy).dom; + } + /** @private */ + this.dd = new Roo.dd.DDProxy(this.el.dom.id, "XSplitBars", {dragElId : this.proxy.id}); + + /** @private */ + this.dd.b4StartDrag = this.onStartProxyDrag.createDelegate(this); + + /** @private */ + this.dd.endDrag = this.onEndProxyDrag.createDelegate(this); + + /** @private */ + this.dragSpecs = {}; + + /** + * @private The adapter to use to positon and resize elements + */ + this.adapter = new Roo.bootstrap.SplitBar.BasicLayoutAdapter(); + this.adapter.init(this); + + if(this.orientation == Roo.bootstrap.SplitBar.HORIZONTAL){ + /** @private */ + this.placement = cfg.placement || (this.el.getX() > this.resizingEl.getX() ? Roo.bootstrap.SplitBar.LEFT : Roo.bootstrap.SplitBar.RIGHT); + this.el.addClass("roo-splitbar-h"); + }else{ + /** @private */ + this.placement = cfg.placement || (this.el.getY() > this.resizingEl.getY() ? Roo.bootstrap.SplitBar.TOP : Roo.bootstrap.SplitBar.BOTTOM); + this.el.addClass("roo-splitbar-v"); + } + + this.addEvents({ + /** + * @event resize + * Fires when the splitter is moved (alias for {@link #event-moved}) + * @param {Roo.bootstrap.SplitBar} this + * @param {Number} newSize the new width or height + */ + "resize" : true, + /** + * @event moved + * Fires when the splitter is moved + * @param {Roo.bootstrap.SplitBar} this + * @param {Number} newSize the new width or height + */ + "moved" : true, + /** + * @event beforeresize + * Fires before the splitter is dragged + * @param {Roo.bootstrap.SplitBar} this + */ + "beforeresize" : true, + + "beforeapply" : true + }); + + Roo.util.Observable.call(this); +}; + +Roo.extend(Roo.bootstrap.SplitBar, Roo.util.Observable, { + onStartProxyDrag : function(x, y){ + this.fireEvent("beforeresize", this); + if(!this.overlay){ + var o = Roo.DomHelper.insertFirst(document.body, {cls: "roo-drag-overlay", html: "&#160;"}, true); + o.unselectable(); + o.enableDisplayMode("block"); + // all splitbars share the same overlay + Roo.bootstrap.SplitBar.prototype.overlay = o; + } + this.overlay.setSize(Roo.lib.Dom.getViewWidth(true), Roo.lib.Dom.getViewHeight(true)); + this.overlay.show(); + Roo.get(this.proxy).setDisplayed("block"); + var size = this.adapter.getElementSize(this); + this.activeMinSize = this.getMinimumSize();; + this.activeMaxSize = this.getMaximumSize();; + var c1 = size - this.activeMinSize; + var c2 = Math.max(this.activeMaxSize - size, 0); + if(this.orientation == Roo.bootstrap.SplitBar.HORIZONTAL){ + this.dd.resetConstraints(); + this.dd.setXConstraint( + this.placement == Roo.bootstrap.SplitBar.LEFT ? c1 : c2, + this.placement == Roo.bootstrap.SplitBar.LEFT ? c2 : c1 + ); + this.dd.setYConstraint(0, 0); + }else{ + this.dd.resetConstraints(); + this.dd.setXConstraint(0, 0); + this.dd.setYConstraint( + this.placement == Roo.bootstrap.SplitBar.TOP ? c1 : c2, + this.placement == Roo.bootstrap.SplitBar.TOP ? c2 : c1 + ); + } + this.dragSpecs.startSize = size; + this.dragSpecs.startPoint = [x, y]; + Roo.dd.DDProxy.prototype.b4StartDrag.call(this.dd, x, y); + }, + + /** + * @private Called after the drag operation by the DDProxy + */ + onEndProxyDrag : function(e){ + Roo.get(this.proxy).setDisplayed(false); + var endPoint = Roo.lib.Event.getXY(e); + if(this.overlay){ + this.overlay.hide(); + } + var newSize; + if(this.orientation == Roo.bootstrap.SplitBar.HORIZONTAL){ + newSize = this.dragSpecs.startSize + + (this.placement == Roo.bootstrap.SplitBar.LEFT ? + endPoint[0] - this.dragSpecs.startPoint[0] : + this.dragSpecs.startPoint[0] - endPoint[0] + ); + }else{ + newSize = this.dragSpecs.startSize + + (this.placement == Roo.bootstrap.SplitBar.TOP ? + endPoint[1] - this.dragSpecs.startPoint[1] : + this.dragSpecs.startPoint[1] - endPoint[1] + ); + } + newSize = Math.min(Math.max(newSize, this.activeMinSize), this.activeMaxSize); + if(newSize != this.dragSpecs.startSize){ + if(this.fireEvent('beforeapply', this, newSize) !== false){ + this.adapter.setElementSize(this, newSize); + this.fireEvent("moved", this, newSize); + this.fireEvent("resize", this, newSize); + } + } + }, + + /** + * Get the adapter this SplitBar uses + * @return The adapter object + */ + getAdapter : function(){ + return this.adapter; + }, + + /** + * Set the adapter this SplitBar uses + * @param {Object} adapter A SplitBar adapter object + */ + setAdapter : function(adapter){ + this.adapter = adapter; + this.adapter.init(this); + }, + + /** + * Gets the minimum size for the resizing element + * @return {Number} The minimum size + */ + getMinimumSize : function(){ + return this.minSize; + }, + + /** + * Sets the minimum size for the resizing element + * @param {Number} minSize The minimum size + */ + setMinimumSize : function(minSize){ + this.minSize = minSize; + }, + + /** + * Gets the maximum size for the resizing element + * @return {Number} The maximum size + */ + getMaximumSize : function(){ + return this.maxSize; + }, + + /** + * Sets the maximum size for the resizing element + * @param {Number} maxSize The maximum size + */ + setMaximumSize : function(maxSize){ + this.maxSize = maxSize; + }, + + /** + * Sets the initialize size for the resizing element + * @param {Number} size The initial size + */ + setCurrentSize : function(size){ + var oldAnimate = this.animate; + this.animate = false; + this.adapter.setElementSize(this, size); + this.animate = oldAnimate; + }, + + /** + * Destroy this splitbar. + * @param {Boolean} removeEl True to remove the element + */ + destroy : function(removeEl){ + if(this.shim){ + this.shim.remove(); + } + this.dd.unreg(); + this.proxy.parentNode.removeChild(this.proxy); + if(removeEl){ + this.el.remove(); + } + } +}); + +/** + * @private static Create our own proxy element element. So it will be the same same size on all browsers, we won't use borders. Instead we use a background color. + */ +Roo.bootstrap.SplitBar.createProxy = function(dir){ + var proxy = new Roo.Element(document.createElement("div")); + proxy.unselectable(); + var cls = 'roo-splitbar-proxy'; + proxy.addClass(cls + ' ' + (dir == Roo.bootstrap.SplitBar.HORIZONTAL ? cls +'-h' : cls + '-v')); + document.body.appendChild(proxy.dom); + return proxy.dom; +}; + +/** + * @class Roo.bootstrap.SplitBar.BasicLayoutAdapter + * Default Adapter. It assumes the splitter and resizing element are not positioned + * elements and only gets/sets the width of the element. Generally used for table based layouts. + */ +Roo.bootstrap.SplitBar.BasicLayoutAdapter = function(){ +}; + +Roo.bootstrap.SplitBar.BasicLayoutAdapter.prototype = { + // do nothing for now + init : function(s){ + + }, + /** + * Called before drag operations to get the current size of the resizing element. + * @param {Roo.bootstrap.SplitBar} s The SplitBar using this adapter + */ + getElementSize : function(s){ + if(s.orientation == Roo.bootstrap.SplitBar.HORIZONTAL){ + return s.resizingEl.getWidth(); + }else{ + return s.resizingEl.getHeight(); + } + }, + + /** + * Called after drag operations to set the size of the resizing element. + * @param {Roo.bootstrap.SplitBar} s The SplitBar using this adapter + * @param {Number} newSize The new size to set + * @param {Function} onComplete A function to be invoked when resizing is complete + */ + setElementSize : function(s, newSize, onComplete){ + if(s.orientation == Roo.bootstrap.SplitBar.HORIZONTAL){ + if(!s.animate){ + s.resizingEl.setWidth(newSize); + if(onComplete){ + onComplete(s, newSize); + } + }else{ + s.resizingEl.setWidth(newSize, true, .1, onComplete, 'easeOut'); + } + }else{ + + if(!s.animate){ + s.resizingEl.setHeight(newSize); + if(onComplete){ + onComplete(s, newSize); + } + }else{ + s.resizingEl.setHeight(newSize, true, .1, onComplete, 'easeOut'); + } + } + } +}; + +/** + *@class Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter + * @extends Roo.bootstrap.SplitBar.BasicLayoutAdapter + * Adapter that moves the splitter element to align with the resized sizing element. + * Used with an absolute positioned SplitBar. + * @param {String/HTMLElement/Roo.Element} container The container that wraps around the absolute positioned content. If it's + * document.body, make sure you assign an id to the body element. + */ +Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter = function(container){ + this.basic = new Roo.bootstrap.SplitBar.BasicLayoutAdapter(); + this.container = Roo.get(container); +}; + +Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter.prototype = { + init : function(s){ + this.basic.init(s); + }, + + getElementSize : function(s){ + return this.basic.getElementSize(s); + }, + + setElementSize : function(s, newSize, onComplete){ + this.basic.setElementSize(s, newSize, this.moveSplitter.createDelegate(this, [s])); + }, + + moveSplitter : function(s){ + var yes = Roo.bootstrap.SplitBar; + switch(s.placement){ + case yes.LEFT: + s.el.setX(s.resizingEl.getRight()); + break; + case yes.RIGHT: + s.el.setStyle("right", (this.container.getWidth() - s.resizingEl.getLeft()) + "px"); + break; + case yes.TOP: + s.el.setY(s.resizingEl.getBottom()); + break; + case yes.BOTTOM: + s.el.setY(s.resizingEl.getTop() - s.el.getHeight()); + break; + } + } +}; + +/** + * Orientation constant - Create a vertical SplitBar + * @static + * @type Number + */ +Roo.bootstrap.SplitBar.VERTICAL = 1; + +/** + * Orientation constant - Create a horizontal SplitBar + * @static + * @type Number + */ +Roo.bootstrap.SplitBar.HORIZONTAL = 2; + +/** + * Placement constant - The resizing element is to the left of the splitter element + * @static + * @type Number + */ +Roo.bootstrap.SplitBar.LEFT = 1; + +/** + * Placement constant - The resizing element is to the right of the splitter element + * @static + * @type Number + */ +Roo.bootstrap.SplitBar.RIGHT = 2; + +/** + * Placement constant - The resizing element is positioned above the splitter element + * @static + * @type Number + */ +Roo.bootstrap.SplitBar.TOP = 3; + +/** + * Placement constant - The resizing element is positioned under splitter element + * @static + * @type Number + */ +Roo.bootstrap.SplitBar.BOTTOM = 4; + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_TabGroup.js.html b/docs2/src/Roo_bootstrap_TabGroup.js.html new file mode 100644 index 0000000000..3b182405e4 --- /dev/null +++ b/docs2/src/Roo_bootstrap_TabGroup.js.html @@ -0,0 +1,394 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/TabGroup.js/* + * - LGPL + * + * column + * + */ + +/** + * @class Roo.bootstrap.TabGroup + * @extends Roo.bootstrap.Column + * Bootstrap Column class + * @cfg {String} navId the navigation id (for use with navbars) - will be auto generated if it does not exist.. + * @cfg {Boolean} carousel true to make the group behave like a carousel + * @cfg {Boolean} bullets show bullets for the panels + * @cfg {Boolean} autoslide (true|false) auto slide .. default false + * @cfg {Number} timer auto slide timer .. default 0 millisecond + * @cfg {Boolean} showarrow (true|false) show arrow default true + * + * @constructor + * Create a new TabGroup + * @param {Object} config The config object + */ + +Roo.bootstrap.TabGroup = function(config){ + Roo.bootstrap.TabGroup.superclass.constructor.call(this, config); + if (!this.navId) { + this.navId = Roo.id(); + } + this.tabs = []; + Roo.bootstrap.TabGroup.register(this); + +}; + +Roo.extend(Roo.bootstrap.TabGroup, Roo.bootstrap.Column, { + + carousel : false, + transition : false, + bullets : 0, + timer : 0, + autoslide : false, + slideFn : false, + slideOnTouch : false, + showarrow : true, + + getAutoCreate : function() + { + var cfg = Roo.apply({}, Roo.bootstrap.TabGroup.superclass.getAutoCreate.call(this)); + + cfg.cls += ' tab-content'; + + if (this.carousel) { + cfg.cls += ' carousel slide'; + + cfg.cn = [{ + cls : 'carousel-inner', + cn : [] + }]; + + if(this.bullets && !Roo.isTouch){ + + var bullets = { + cls : 'carousel-bullets', + cn : [] + }; + + if(this.bullets_cls){ + bullets.cls = bullets.cls + ' ' + this.bullets_cls; + } + + bullets.cn.push({ + cls : 'clear' + }); + + cfg.cn[0].cn.push(bullets); + } + + if(this.showarrow){ + cfg.cn[0].cn.push({ + tag : 'div', + class : 'carousel-arrow', + cn : [ + { + tag : 'div', + class : 'carousel-prev', + cn : [ + { + tag : 'i', + class : 'fa fa-chevron-left' + } + ] + }, + { + tag : 'div', + class : 'carousel-next', + cn : [ + { + tag : 'i', + class : 'fa fa-chevron-right' + } + ] + } + ] + }); + } + + } + + return cfg; + }, + + initEvents: function() + { +// if(Roo.isTouch && this.slideOnTouch && !this.showarrow){ +// this.el.on("touchstart", this.onTouchStart, this); +// } + + if(this.autoslide){ + var _this = this; + + this.slideFn = window.setInterval(function() { + _this.showPanelNext(); + }, this.timer); + } + + if(this.showarrow){ + this.el.select('.carousel-prev', true).first().on('click', this.showPanelPrev, this); + this.el.select('.carousel-next', true).first().on('click', this.showPanelNext, this); + } + + + }, + +// onTouchStart : function(e, el, o) +// { +// if(!this.slideOnTouch || !Roo.isTouch || Roo.get(e.getTarget()).hasClass('roo-button-text')){ +// return; +// } +// +// this.showPanelNext(); +// }, + + + getChildContainer : function() + { + return this.carousel ? this.el.select('.carousel-inner', true).first() : this.el; + }, + + /** + * register a Navigation item + * @param {Roo.bootstrap.NavItem} the navitem to add + */ + register : function(item) + { + this.tabs.push( item); + item.navId = this.navId; // not really needed.. + this.addBullet(); + + }, + + getActivePanel : function() + { + var r = false; + Roo.each(this.tabs, function(t) { + if (t.active) { + r = t; + return false; + } + return null; + }); + return r; + + }, + getPanelByName : function(n) + { + var r = false; + Roo.each(this.tabs, function(t) { + if (t.tabId == n) { + r = t; + return false; + } + return null; + }); + return r; + }, + indexOfPanel : function(p) + { + var r = false; + Roo.each(this.tabs, function(t,i) { + if (t.tabId == p.tabId) { + r = i; + return false; + } + return null; + }); + return r; + }, + /** + * show a specific panel + * @param {Roo.bootstrap.TabPanel|number|string} panel to change to (use the tabId to specify a specific one) + * @return {boolean} false if panel was not shown (invalid entry or beforedeactivate fails.) + */ + showPanel : function (pan) + { + if(this.transition || typeof(pan) == 'undefined'){ + Roo.log("waiting for the transitionend"); + return false; + } + + if (typeof(pan) == 'number') { + pan = this.tabs[pan]; + } + + if (typeof(pan) == 'string') { + pan = this.getPanelByName(pan); + } + + var cur = this.getActivePanel(); + + if(!pan || !cur){ + Roo.log('pan or acitve pan is undefined'); + return false; + } + + if (pan.tabId == this.getActivePanel().tabId) { + return true; + } + + if (false === cur.fireEvent('beforedeactivate')) { + return false; + } + + if(this.bullets > 0 && !Roo.isTouch){ + this.setActiveBullet(this.indexOfPanel(pan)); + } + + if (this.carousel && typeof(Roo.get(document.body).dom.style.transition) != 'undefined') { + + //class="carousel-item carousel-item-next carousel-item-left" + + this.transition = true; + var dir = this.indexOfPanel(pan) > this.indexOfPanel(cur) ? 'next' : 'prev'; + var lr = dir == 'next' ? 'left' : 'right'; + pan.el.addClass(dir); // or prev + pan.el.addClass('carousel-item-' + dir); // or prev + pan.el.dom.offsetWidth; // find the offset with - causing a reflow? + cur.el.addClass(lr); // or right + pan.el.addClass(lr); + cur.el.addClass('carousel-item-' +lr); // or right + pan.el.addClass('carousel-item-' +lr); + + + var _this = this; + cur.el.on('transitionend', function() { + Roo.log("trans end?"); + + pan.el.removeClass([lr,dir, 'carousel-item-' + lr, 'carousel-item-' + dir]); + pan.setActive(true); + + cur.el.removeClass([lr, 'carousel-item-' + lr]); + cur.setActive(false); + + _this.transition = false; + + }, this, { single: true } ); + + return true; + } + + cur.setActive(false); + pan.setActive(true); + + return true; + + }, + showPanelNext : function() + { + var i = this.indexOfPanel(this.getActivePanel()); + + if (i >= this.tabs.length - 1 && !this.autoslide) { + return; + } + + if (i >= this.tabs.length - 1 && this.autoslide) { + i = -1; + } + + this.showPanel(this.tabs[i+1]); + }, + + showPanelPrev : function() + { + var i = this.indexOfPanel(this.getActivePanel()); + + if (i < 1 && !this.autoslide) { + return; + } + + if (i < 1 && this.autoslide) { + i = this.tabs.length; + } + + this.showPanel(this.tabs[i-1]); + }, + + + addBullet: function() + { + if(!this.bullets || Roo.isTouch){ + return; + } + var ctr = this.el.select('.carousel-bullets',true).first(); + var i = this.el.select('.carousel-bullets .bullet',true).getCount() ; + var bullet = ctr.createChild({ + cls : 'bullet bullet-' + i + },ctr.dom.lastChild); + + + var _this = this; + + bullet.on('click', (function(e, el, o, ii, t){ + + e.preventDefault(); + + this.showPanel(ii); + + if(this.autoslide && this.slideFn){ + clearInterval(this.slideFn); + this.slideFn = window.setInterval(function() { + _this.showPanelNext(); + }, this.timer); + } + + }).createDelegate(this, [i, bullet], true)); + + + }, + + setActiveBullet : function(i) + { + if(Roo.isTouch){ + return; + } + + Roo.each(this.el.select('.bullet', true).elements, function(el){ + el.removeClass('selected'); + }); + + var bullet = this.el.select('.bullet-' + i, true).first(); + + if(!bullet){ + return; + } + + bullet.addClass('selected'); + } + + + +}); + + + + + +Roo.apply(Roo.bootstrap.TabGroup, { + + groups: {}, + /** + * register a Navigation Group + * @param {Roo.bootstrap.NavGroup} the navgroup to add + */ + register : function(navgrp) + { + this.groups[navgrp.navId] = navgrp; + + }, + /** + * fetch a Navigation Group based on the navigation ID + * if one does not exist , it will get created. + * @param {string} the navgroup to add + * @returns {Roo.bootstrap.NavGroup} the navgroup + */ + get: function(navId) { + if (typeof(this.groups[navId]) == 'undefined') { + this.register(new Roo.bootstrap.TabGroup({ navId : navId })); + } + return this.groups[navId] ; + } + + + +}); + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_TabPanel.js.html b/docs2/src/Roo_bootstrap_TabPanel.js.html new file mode 100644 index 0000000000..7958e2174b --- /dev/null +++ b/docs2/src/Roo_bootstrap_TabPanel.js.html @@ -0,0 +1,188 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/TabPanel.js/* + * - LGPL + * + * TabPanel + * + */ + +/** + * @class Roo.bootstrap.TabPanel + * @extends Roo.bootstrap.Component + * Bootstrap TabPanel class + * @cfg {Boolean} active panel active + * @cfg {String} html panel content + * @cfg {String} tabId unique tab ID (will be autogenerated if not set. - used to match TabItem to Panel) + * @cfg {String} navId The Roo.bootstrap.NavGroup which triggers show hide () + * @cfg {String} href click to link.. + * + * + * @constructor + * Create a new TabPanel + * @param {Object} config The config object + */ + +Roo.bootstrap.TabPanel = function(config){ + Roo.bootstrap.TabPanel.superclass.constructor.call(this, config); + this.addEvents({ + /** + * @event changed + * Fires when the active status changes + * @param {Roo.bootstrap.TabPanel} this + * @param {Boolean} state the new state + + */ + 'changed': true, + /** + * @event beforedeactivate + * Fires before a tab is de-activated - can be used to do validation on a form. + * @param {Roo.bootstrap.TabPanel} this + * @return {Boolean} false if there is an error + + */ + 'beforedeactivate': true + }); + + this.tabId = this.tabId || Roo.id(); + +}; + +Roo.extend(Roo.bootstrap.TabPanel, Roo.bootstrap.Component, { + + active: false, + html: false, + tabId: false, + navId : false, + href : '', + + getAutoCreate : function(){ + + + var cfg = { + tag: 'div', + // item is needed for carousel - not sure if it has any effect otherwise + cls: 'carousel-item tab-pane item' + ((this.href.length) ? ' clickable ' : ''), + html: this.html || '' + }; + + if(this.active){ + cfg.cls += ' active'; + } + + if(this.tabId){ + cfg.tabId = this.tabId; + } + + + + return cfg; + }, + + initEvents: function() + { + var p = this.parent(); + + this.navId = this.navId || p.navId; + + if (typeof(this.navId) != 'undefined') { + // not really needed.. but just in case.. parent should be a NavGroup. + var tg = Roo.bootstrap.TabGroup.get(this.navId); + + tg.register(this); + + var i = tg.tabs.length - 1; + + if(this.active && tg.bullets > 0 && i < tg.bullets){ + tg.setActiveBullet(i); + } + } + + this.el.on('click', this.onClick, this); + + if(Roo.isTouch){ + this.el.on("touchstart", this.onTouchStart, this); + this.el.on("touchmove", this.onTouchMove, this); + this.el.on("touchend", this.onTouchEnd, this); + } + + }, + + onRender : function(ct, position) + { + Roo.bootstrap.TabPanel.superclass.onRender.call(this, ct, position); + }, + + setActive : function(state) + { + Roo.log("panel - set active " + this.tabId + "=" + state); + + this.active = state; + if (!state) { + this.el.removeClass('active'); + + } else if (!this.el.hasClass('active')) { + this.el.addClass('active'); + } + + this.fireEvent('changed', this, state); + }, + + onClick : function(e) + { + e.preventDefault(); + + if(!this.href.length){ + return; + } + + window.location.href = this.href; + }, + + startX : 0, + startY : 0, + endX : 0, + endY : 0, + swiping : false, + + onTouchStart : function(e) + { + this.swiping = false; + + this.startX = e.browserEvent.touches[0].clientX; + this.startY = e.browserEvent.touches[0].clientY; + }, + + onTouchMove : function(e) + { + this.swiping = true; + + this.endX = e.browserEvent.touches[0].clientX; + this.endY = e.browserEvent.touches[0].clientY; + }, + + onTouchEnd : function(e) + { + if(!this.swiping){ + this.onClick(e); + return; + } + + var tabGroup = this.parent(); + + if(this.endX > this.startX){ // swiping right + tabGroup.showPanelPrev(); + return; + } + + if(this.startX > this.endX){ // swiping left + tabGroup.showPanelNext(); + return; + } + } + + +}); + + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Table.js.html b/docs2/src/Roo_bootstrap_Table.js.html new file mode 100644 index 0000000000..9ac5c8f177 --- /dev/null +++ b/docs2/src/Roo_bootstrap_Table.js.html @@ -0,0 +1,1228 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Table.js/* + * - LGPL + * + * table + * + */ + +/** + * @class Roo.bootstrap.Table + * @extends Roo.bootstrap.Component + * Bootstrap Table class + * @cfg {String} cls table class + * @cfg {String} align (left|center|right) Specifies the alignment of a table according to surrounding text + * @cfg {String} bgcolor Specifies the background color for a table + * @cfg {Number} border Specifies whether the table cells should have borders or not + * @cfg {Number} cellpadding Specifies the space between the cell wall and the cell content + * @cfg {Number} cellspacing Specifies the space between cells + * @cfg {String} frame Specifies which parts of the outside borders that should be visible + * @cfg {String} rules Specifies which parts of the inside borders that should be visible + * @cfg {String} sortable Specifies that the table should be sortable + * @cfg {String} summary Specifies a summary of the content of a table + * @cfg {Number} width Specifies the width of a table + * @cfg {String} layout table layout (auto | fixed | initial | inherit) + * + * @cfg {boolean} striped Should the rows be alternative striped + * @cfg {boolean} bordered Add borders to the table + * @cfg {boolean} hover Add hover highlighting + * @cfg {boolean} condensed Format condensed + * @cfg {boolean} responsive Format condensed + * @cfg {Boolean} loadMask (true|false) default false + * @cfg {Boolean} footerShow (true|false) generate tfoot, default true + * @cfg {Boolean} headerShow (true|false) generate thead, default true + * @cfg {Boolean} rowSelection (true|false) default false + * @cfg {Boolean} cellSelection (true|false) default false + * @cfg {Boolean} scrollBody (true|false) default false - body scrolled / fixed header + * @cfg {Roo.bootstrap.PagingToolbar} footer a paging toolbar + * @cfg {Boolean} lazyLoad auto load data while scrolling to the end (default false) + * @cfg {Boolean} auto_hide_footer auto hide footer if only one page (default false) + + * + * @constructor + * Create a new Table + * @param {Object} config The config object + */ + +Roo.bootstrap.Table = function(config){ + Roo.bootstrap.Table.superclass.constructor.call(this, config); + + + + // BC... + this.rowSelection = (typeof(config.rowSelection) != 'undefined') ? config.rowSelection : this.rowSelection; + this.cellSelection = (typeof(config.cellSelection) != 'undefined') ? config.cellSelection : this.cellSelection; + this.headerShow = (typeof(config.thead) != 'undefined') ? config.thead : this.headerShow; + this.footerShow = (typeof(config.tfoot) != 'undefined') ? config.tfoot : this.footerShow; + + this.sm = this.sm || {xtype: 'RowSelectionModel'}; + if (this.sm) { + this.sm.grid = this; + this.selModel = Roo.factory(this.sm, Roo.bootstrap.Table); + this.sm = this.selModel; + this.sm.xmodule = this.xmodule || false; + } + + if (this.cm && typeof(this.cm.config) == 'undefined') { + this.colModel = new Roo.grid.ColumnModel(this.cm); + this.cm = this.colModel; + this.cm.xmodule = this.xmodule || false; + } + if (this.store) { + this.store= Roo.factory(this.store, Roo.data); + this.ds = this.store; + this.ds.xmodule = this.xmodule || false; + + } + if (this.footer && this.store) { + this.footer.dataSource = this.ds; + this.footer = Roo.factory(this.footer); + } + + /** @private */ + this.addEvents({ + /** + * @event cellclick + * Fires when a cell is clicked + * @param {Roo.bootstrap.Table} this + * @param {Roo.Element} el + * @param {Number} rowIndex + * @param {Number} columnIndex + * @param {Roo.EventObject} e + */ + "cellclick" : true, + /** + * @event celldblclick + * Fires when a cell is double clicked + * @param {Roo.bootstrap.Table} this + * @param {Roo.Element} el + * @param {Number} rowIndex + * @param {Number} columnIndex + * @param {Roo.EventObject} e + */ + "celldblclick" : true, + /** + * @event rowclick + * Fires when a row is clicked + * @param {Roo.bootstrap.Table} this + * @param {Roo.Element} el + * @param {Number} rowIndex + * @param {Roo.EventObject} e + */ + "rowclick" : true, + /** + * @event rowdblclick + * Fires when a row is double clicked + * @param {Roo.bootstrap.Table} this + * @param {Roo.Element} el + * @param {Number} rowIndex + * @param {Roo.EventObject} e + */ + "rowdblclick" : true, + /** + * @event mouseover + * Fires when a mouseover occur + * @param {Roo.bootstrap.Table} this + * @param {Roo.Element} el + * @param {Number} rowIndex + * @param {Number} columnIndex + * @param {Roo.EventObject} e + */ + "mouseover" : true, + /** + * @event mouseout + * Fires when a mouseout occur + * @param {Roo.bootstrap.Table} this + * @param {Roo.Element} el + * @param {Number} rowIndex + * @param {Number} columnIndex + * @param {Roo.EventObject} e + */ + "mouseout" : true, + /** + * @event rowclass + * Fires when a row is rendered, so you can change add a style to it. + * @param {Roo.bootstrap.Table} this + * @param {Object} rowcfg contains record rowIndex colIndex and rowClass - set rowClass to add a style. + */ + 'rowclass' : true, + /** + * @event rowsrendered + * Fires when all the rows have been rendered + * @param {Roo.bootstrap.Table} this + */ + 'rowsrendered' : true, + /** + * @event contextmenu + * The raw contextmenu event for the entire grid. + * @param {Roo.EventObject} e + */ + "contextmenu" : true, + /** + * @event rowcontextmenu + * Fires when a row is right clicked + * @param {Roo.bootstrap.Table} this + * @param {Number} rowIndex + * @param {Roo.EventObject} e + */ + "rowcontextmenu" : true, + /** + * @event cellcontextmenu + * Fires when a cell is right clicked + * @param {Roo.bootstrap.Table} this + * @param {Number} rowIndex + * @param {Number} cellIndex + * @param {Roo.EventObject} e + */ + "cellcontextmenu" : true, + /** + * @event headercontextmenu + * Fires when a header is right clicked + * @param {Roo.bootstrap.Table} this + * @param {Number} columnIndex + * @param {Roo.EventObject} e + */ + "headercontextmenu" : true + }); +}; + +Roo.extend(Roo.bootstrap.Table, Roo.bootstrap.Component, { + + cls: false, + align: false, + bgcolor: false, + border: false, + cellpadding: false, + cellspacing: false, + frame: false, + rules: false, + sortable: false, + summary: false, + width: false, + striped : false, + scrollBody : false, + bordered: false, + hover: false, + condensed : false, + responsive : false, + sm : false, + cm : false, + store : false, + loadMask : false, + footerShow : true, + headerShow : true, + + rowSelection : false, + cellSelection : false, + layout : false, + + // Roo.Element - the tbody + mainBody: false, + // Roo.Element - thead element + mainHead: false, + + container: false, // used by gridpanel... + + lazyLoad : false, + + CSS : Roo.util.CSS, + + auto_hide_footer : false, + + getAutoCreate : function() + { + var cfg = Roo.apply({}, Roo.bootstrap.Table.superclass.getAutoCreate.call(this)); + + cfg = { + tag: 'table', + cls : 'table', + cn : [] + }; + if (this.scrollBody) { + cfg.cls += ' table-body-fixed'; + } + if (this.striped) { + cfg.cls += ' table-striped'; + } + + if (this.hover) { + cfg.cls += ' table-hover'; + } + if (this.bordered) { + cfg.cls += ' table-bordered'; + } + if (this.condensed) { + cfg.cls += ' table-condensed'; + } + if (this.responsive) { + cfg.cls += ' table-responsive'; + } + + if (this.cls) { + cfg.cls+= ' ' +this.cls; + } + + // this lot should be simplifed... + var _t = this; + var cp = [ + 'align', + 'bgcolor', + 'border', + 'cellpadding', + 'cellspacing', + 'frame', + 'rules', + 'sortable', + 'summary', + 'width' + ].forEach(function(k) { + if (_t[k]) { + cfg[k] = _t[k]; + } + }); + + + if (this.layout) { + cfg.style = (typeof(cfg.style) == 'undefined') ? ('table-layout:' + this.layout + ';') : (cfg.style + ('table-layout:' + this.layout + ';')); + } + + if(this.store || this.cm){ + if(this.headerShow){ + cfg.cn.push(this.renderHeader()); + } + + cfg.cn.push(this.renderBody()); + + if(this.footerShow){ + cfg.cn.push(this.renderFooter()); + } + // where does this come from? + //cfg.cls+= ' TableGrid'; + } + + return { cn : [ cfg ] }; + }, + + initEvents : function() + { + if(!this.store || !this.cm){ + return; + } + if (this.selModel) { + this.selModel.initEvents(); + } + + + //Roo.log('initEvents with ds!!!!'); + + this.mainBody = this.el.select('tbody', true).first(); + this.mainHead = this.el.select('thead', true).first(); + this.mainFoot = this.el.select('tfoot', true).first(); + + + + var _this = this; + + Roo.each(this.el.select('thead th.sortable', true).elements, function(e){ + e.on('click', _this.sort, _this); + }); + + this.mainBody.on("click", this.onClick, this); + this.mainBody.on("dblclick", this.onDblClick, this); + + // why is this done????? = it breaks dialogs?? + //this.parent().el.setStyle('position', 'relative'); + + + if (this.footer) { + this.footer.parentId = this.id; + this.footer.onRender(this.el.select('tfoot tr td').first(), null); + + if(this.lazyLoad){ + this.el.select('tfoot tr td').first().addClass('hide'); + } + } + + if(this.loadMask) { + this.maskEl = new Roo.LoadMask(this.el, { store : this.ds, msgCls: 'roo-el-mask-msg' }); + } + + this.store.on('load', this.onLoad, this); + this.store.on('beforeload', this.onBeforeLoad, this); + this.store.on('update', this.onUpdate, this); + this.store.on('add', this.onAdd, this); + this.store.on("clear", this.clear, this); + + this.el.on("contextmenu", this.onContextMenu, this); + + this.mainBody.on('scroll', this.onBodyScroll, this); + + this.cm.on("headerchange", this.onHeaderChange, this); + + this.cm.on("hiddenchange", this.onHiddenChange, this, arguments); + + }, + + onContextMenu : function(e, t) + { + this.processEvent("contextmenu", e); + }, + + processEvent : function(name, e) + { + if (name != 'touchstart' ) { + this.fireEvent(name, e); + } + + var t = e.getTarget(); + + var cell = Roo.get(t); + + if(!cell){ + return; + } + + if(cell.findParent('tfoot', false, true)){ + return; + } + + if(cell.findParent('thead', false, true)){ + + if(e.getTarget().nodeName.toLowerCase() != 'th'){ + cell = Roo.get(t).findParent('th', false, true); + if (!cell) { + Roo.log("failed to find th in thead?"); + Roo.log(e.getTarget()); + return; + } + } + + var cellIndex = cell.dom.cellIndex; + + var ename = name == 'touchstart' ? 'click' : name; + this.fireEvent("header" + ename, this, cellIndex, e); + + return; + } + + if(e.getTarget().nodeName.toLowerCase() != 'td'){ + cell = Roo.get(t).findParent('td', false, true); + if (!cell) { + Roo.log("failed to find th in tbody?"); + Roo.log(e.getTarget()); + return; + } + } + + var row = cell.findParent('tr', false, true); + var cellIndex = cell.dom.cellIndex; + var rowIndex = row.dom.rowIndex - 1; + + if(row !== false){ + + this.fireEvent("row" + name, this, rowIndex, e); + + if(cell !== false){ + + this.fireEvent("cell" + name, this, rowIndex, cellIndex, e); + } + } + + }, + + onMouseover : function(e, el) + { + var cell = Roo.get(el); + + if(!cell){ + return; + } + + if(e.getTarget().nodeName.toLowerCase() != 'td'){ + cell = cell.findParent('td', false, true); + } + + var row = cell.findParent('tr', false, true); + var cellIndex = cell.dom.cellIndex; + var rowIndex = row.dom.rowIndex - 1; // start from 0 + + this.fireEvent('mouseover', this, cell, rowIndex, cellIndex, e); + + }, + + onMouseout : function(e, el) + { + var cell = Roo.get(el); + + if(!cell){ + return; + } + + if(e.getTarget().nodeName.toLowerCase() != 'td'){ + cell = cell.findParent('td', false, true); + } + + var row = cell.findParent('tr', false, true); + var cellIndex = cell.dom.cellIndex; + var rowIndex = row.dom.rowIndex - 1; // start from 0 + + this.fireEvent('mouseout', this, cell, rowIndex, cellIndex, e); + + }, + + onClick : function(e, el) + { + var cell = Roo.get(el); + + if(!cell || (!this.cellSelection && !this.rowSelection)){ + return; + } + + if(e.getTarget().nodeName.toLowerCase() != 'td'){ + cell = cell.findParent('td', false, true); + } + + if(!cell || typeof(cell) == 'undefined'){ + return; + } + + var row = cell.findParent('tr', false, true); + + if(!row || typeof(row) == 'undefined'){ + return; + } + + var cellIndex = cell.dom.cellIndex; + var rowIndex = this.getRowIndex(row); + + // why??? - should these not be based on SelectionModel? + if(this.cellSelection){ + this.fireEvent('cellclick', this, cell, rowIndex, cellIndex, e); + } + + if(this.rowSelection){ + this.fireEvent('rowclick', this, row, rowIndex, e); + } + + + }, + + onDblClick : function(e,el) + { + var cell = Roo.get(el); + + if(!cell || (!this.cellSelection && !this.rowSelection)){ + return; + } + + if(e.getTarget().nodeName.toLowerCase() != 'td'){ + cell = cell.findParent('td', false, true); + } + + if(!cell || typeof(cell) == 'undefined'){ + return; + } + + var row = cell.findParent('tr', false, true); + + if(!row || typeof(row) == 'undefined'){ + return; + } + + var cellIndex = cell.dom.cellIndex; + var rowIndex = this.getRowIndex(row); + + if(this.cellSelection){ + this.fireEvent('celldblclick', this, cell, rowIndex, cellIndex, e); + } + + if(this.rowSelection){ + this.fireEvent('rowdblclick', this, row, rowIndex, e); + } + }, + + sort : function(e,el) + { + var col = Roo.get(el); + + if(!col.hasClass('sortable')){ + return; + } + + var sort = col.attr('sort'); + var dir = 'ASC'; + + if(col.select('i', true).first().hasClass('glyphicon-arrow-up')){ + dir = 'DESC'; + } + + this.store.sortInfo = {field : sort, direction : dir}; + + if (this.footer) { + Roo.log("calling footer first"); + this.footer.onClick('first'); + } else { + + this.store.load({ params : { start : 0 } }); + } + }, + + renderHeader : function() + { + var header = { + tag: 'thead', + cn : [] + }; + + var cm = this.cm; + this.totalWidth = 0; + + for(var i = 0, len = cm.getColumnCount(); i < len; i++){ + + var config = cm.config[i]; + + var c = { + tag: 'th', + cls : 'x-hcol-' + i, + style : '', + html: cm.getColumnHeader(i) + }; + + var hh = ''; + + if(typeof(config.sortable) != 'undefined' && config.sortable){ + c.cls = 'sortable'; + c.html = '<i class="glyphicon"></i>' + c.html; + } + + if(typeof(config.lgHeader) != 'undefined'){ + hh += '<span class="hidden-xs hidden-sm hidden-md">' + config.lgHeader + '</span>'; + } + + if(typeof(config.mdHeader) != 'undefined'){ + hh += '<span class="hidden-xs hidden-sm hidden-lg">' + config.mdHeader + '</span>'; + } + + if(typeof(config.smHeader) != 'undefined'){ + hh += '<span class="hidden-xs hidden-md hidden-lg">' + config.smHeader + '</span>'; + } + + if(typeof(config.xsHeader) != 'undefined'){ + hh += '<span class="hidden-sm hidden-md hidden-lg">' + config.xsHeader + '</span>'; + } + + if(hh.length){ + c.html = hh; + } + + if(typeof(config.tooltip) != 'undefined'){ + c.tooltip = config.tooltip; + } + + if(typeof(config.colspan) != 'undefined'){ + c.colspan = config.colspan; + } + + if(typeof(config.hidden) != 'undefined' && config.hidden){ + c.style += ' display:none;'; + } + + if(typeof(config.dataIndex) != 'undefined'){ + c.sort = config.dataIndex; + } + + + + if(typeof(config.align) != 'undefined' && config.align.length){ + c.style += ' text-align:' + config.align + ';'; + } + + if(typeof(config.width) != 'undefined'){ + c.style += ' width:' + config.width + 'px;'; + this.totalWidth += config.width; + } else { + this.totalWidth += 100; // assume minimum of 100 per column? + } + + if(typeof(config.cls) != 'undefined'){ + c.cls = (typeof(c.cls) == 'undefined') ? config.cls : (c.cls + ' ' + config.cls); + } + + ['xs','sm','md','lg'].map(function(size){ + + if(typeof(config[size]) == 'undefined'){ + return; + } + + if (!config[size]) { // 0 = hidden + c.cls += ' hidden-' + size; + return; + } + + c.cls += ' col-' + size + '-' + config[size]; + + }); + + header.cn.push(c) + } + + return header; + }, + + renderBody : function() + { + var body = { + tag: 'tbody', + cn : [ + { + tag: 'tr', + cn : [ + { + tag : 'td', + colspan : this.cm.getColumnCount() + } + ] + } + ] + }; + + return body; + }, + + renderFooter : function() + { + var footer = { + tag: 'tfoot', + cn : [ + { + tag: 'tr', + cn : [ + { + tag : 'td', + colspan : this.cm.getColumnCount() + } + ] + } + ] + }; + + return footer; + }, + + + + onLoad : function() + { +// Roo.log('ds onload'); + this.clear(); + + var _this = this; + var cm = this.cm; + var ds = this.store; + + Roo.each(this.el.select('thead th.sortable', true).elements, function(e){ + e.select('i', true).removeClass(['glyphicon-arrow-up', 'glyphicon-arrow-down']); + if (_this.store.sortInfo) { + + if(e.hasClass('sortable') && e.attr('sort') == _this.store.sortInfo.field && _this.store.sortInfo.direction.toUpperCase() == 'ASC'){ + e.select('i', true).addClass(['glyphicon-arrow-up']); + } + + if(e.hasClass('sortable') && e.attr('sort') == _this.store.sortInfo.field && _this.store.sortInfo.direction.toUpperCase() == 'DESC'){ + e.select('i', true).addClass(['glyphicon-arrow-down']); + } + } + }); + + var tbody = this.mainBody; + + if(ds.getCount() > 0){ + ds.data.each(function(d,rowIndex){ + var row = this.renderRow(cm, ds, rowIndex); + + tbody.createChild(row); + + var _this = this; + + if(row.cellObjects.length){ + Roo.each(row.cellObjects, function(r){ + _this.renderCellObject(r); + }) + } + + }, this); + } + + var tfoot = this.el.select('tfoot', true).first(); + + if(this.footerShow && this.auto_hide_footer && this.mainFoot){ + + this.mainFoot.setVisibilityMode(Roo.Element.DISPLAY).hide(); + + var total = this.ds.getTotalCount(); + + if(this.footer.pageSize < total){ + this.mainFoot.show(); + } + } + + Roo.each(this.el.select('tbody td', true).elements, function(e){ + e.on('mouseover', _this.onMouseover, _this); + }); + + Roo.each(this.el.select('tbody td', true).elements, function(e){ + e.on('mouseout', _this.onMouseout, _this); + }); + this.fireEvent('rowsrendered', this); + + this.autoSize(); + }, + + + onUpdate : function(ds,record) + { + this.refreshRow(record); + this.autoSize(); + }, + + onRemove : function(ds, record, index, isUpdate){ + if(isUpdate !== true){ + this.fireEvent("beforerowremoved", this, index, record); + } + var bt = this.mainBody.dom; + + var rows = this.el.select('tbody > tr', true).elements; + + if(typeof(rows[index]) != 'undefined'){ + bt.removeChild(rows[index].dom); + } + +// if(bt.rows[index]){ +// bt.removeChild(bt.rows[index]); +// } + + if(isUpdate !== true){ + //this.stripeRows(index); + //this.syncRowHeights(index, index); + //this.layout(); + this.fireEvent("rowremoved", this, index, record); + } + }, + + onAdd : function(ds, records, rowIndex) + { + //Roo.log('on Add called'); + // - note this does not handle multiple adding very well.. + var bt = this.mainBody.dom; + for (var i =0 ; i < records.length;i++) { + //Roo.log('call insert row Add called on ' + rowIndex + ':' + i); + //Roo.log(records[i]); + //Roo.log(this.store.getAt(rowIndex+i)); + this.insertRow(this.store, rowIndex + i, false); + return; + } + + }, + + + refreshRow : function(record){ + var ds = this.store, index; + if(typeof record == 'number'){ + index = record; + record = ds.getAt(index); + }else{ + index = ds.indexOf(record); + } + this.insertRow(ds, index, true); + this.autoSize(); + this.onRemove(ds, record, index+1, true); + this.autoSize(); + //this.syncRowHeights(index, index); + //this.layout(); + this.fireEvent("rowupdated", this, index, record); + }, + + insertRow : function(dm, rowIndex, isUpdate){ + + if(!isUpdate){ + this.fireEvent("beforerowsinserted", this, rowIndex); + } + //var s = this.getScrollState(); + var row = this.renderRow(this.cm, this.store, rowIndex); + // insert before rowIndex.. + var e = this.mainBody.createChild(row,this.getRowDom(rowIndex)); + + var _this = this; + + if(row.cellObjects.length){ + Roo.each(row.cellObjects, function(r){ + _this.renderCellObject(r); + }) + } + + if(!isUpdate){ + this.fireEvent("rowsinserted", this, rowIndex); + //this.syncRowHeights(firstRow, lastRow); + //this.stripeRows(firstRow); + //this.layout(); + } + + }, + + + getRowDom : function(rowIndex) + { + var rows = this.el.select('tbody > tr', true).elements; + + return (typeof(rows[rowIndex]) == 'undefined') ? false : rows[rowIndex]; + + }, + // returns the object tree for a tr.. + + + renderRow : function(cm, ds, rowIndex) + { + var d = ds.getAt(rowIndex); + + var row = { + tag : 'tr', + cls : 'x-row-' + rowIndex, + cn : [] + }; + + var cellObjects = []; + + for(var i = 0, len = cm.getColumnCount(); i < len; i++){ + var config = cm.config[i]; + + var renderer = cm.getRenderer(i); + var value = ''; + var id = false; + + if(typeof(renderer) !== 'undefined'){ + value = renderer(d.data[cm.getDataIndex(i)], false, d); + } + // if object are returned, then they are expected to be Roo.bootstrap.Component instances + // and are rendered into the cells after the row is rendered - using the id for the element. + + if(typeof(value) === 'object'){ + id = Roo.id(); + cellObjects.push({ + container : id, + cfg : value + }) + } + + var rowcfg = { + record: d, + rowIndex : rowIndex, + colIndex : i, + rowClass : '' + }; + + this.fireEvent('rowclass', this, rowcfg); + + var td = { + tag: 'td', + cls : rowcfg.rowClass + ' x-col-' + i, + style: '', + html: (typeof(value) === 'object') ? '' : value + }; + + if (id) { + td.id = id; + } + + if(typeof(config.colspan) != 'undefined'){ + td.colspan = config.colspan; + } + + if(typeof(config.hidden) != 'undefined' && config.hidden){ + td.style += ' display:none;'; + } + + if(typeof(config.align) != 'undefined' && config.align.length){ + td.style += ' text-align:' + config.align + ';'; + } + if(typeof(config.valign) != 'undefined' && config.valign.length){ + td.style += ' vertical-align:' + config.valign + ';'; + } + + if(typeof(config.width) != 'undefined'){ + td.style += ' width:' + config.width + 'px;'; + } + + if(typeof(config.cursor) != 'undefined'){ + td.style += ' cursor:' + config.cursor + ';'; + } + + if(typeof(config.cls) != 'undefined'){ + td.cls = (typeof(td.cls) == 'undefined') ? config.cls : (td.cls + ' ' + config.cls); + } + + ['xs','sm','md','lg'].map(function(size){ + + if(typeof(config[size]) == 'undefined'){ + return; + } + + if (!config[size]) { // 0 = hidden + td.cls += ' hidden-' + size; + return; + } + + td.cls += ' col-' + size + '-' + config[size]; + + }); + + row.cn.push(td); + + } + + row.cellObjects = cellObjects; + + return row; + + }, + + + + onBeforeLoad : function() + { + + }, + /** + * Remove all rows + */ + clear : function() + { + this.el.select('tbody', true).first().dom.innerHTML = ''; + }, + /** + * Show or hide a row. + * @param {Number} rowIndex to show or hide + * @param {Boolean} state hide + */ + setRowVisibility : function(rowIndex, state) + { + var bt = this.mainBody.dom; + + var rows = this.el.select('tbody > tr', true).elements; + + if(typeof(rows[rowIndex]) == 'undefined'){ + return; + } + rows[rowIndex].dom.style.display = state ? '' : 'none'; + }, + + + getSelectionModel : function(){ + if(!this.selModel){ + this.selModel = new Roo.bootstrap.Table.RowSelectionModel({grid: this}); + } + return this.selModel; + }, + /* + * Render the Roo.bootstrap object from renderder + */ + renderCellObject : function(r) + { + var _this = this; + + r.cfg.parentId = (typeof(r.container) == 'string') ? r.container : r.container.id; + + var t = r.cfg.render(r.container); + + if(r.cfg.cn){ + Roo.each(r.cfg.cn, function(c){ + var child = { + container: t.getChildContainer(), + cfg: c + }; + _this.renderCellObject(child); + }) + } + }, + + getRowIndex : function(row) + { + var rowIndex = -1; + + Roo.each(this.el.select('tbody > tr', true).elements, function(el, index){ + if(el != row){ + return; + } + + rowIndex = index; + }); + + return rowIndex; + }, + /** + * Returns the grid's underlying element = used by panel.Grid + * @return {Element} The element + */ + getGridEl : function(){ + return this.el; + }, + /** + * Forces a resize - used by panel.Grid + * @return {Element} The element + */ + autoSize : function() + { + //var ctr = Roo.get(this.container.dom.parentElement); + var ctr = Roo.get(this.el.dom); + + var thd = this.getGridEl().select('thead',true).first(); + var tbd = this.getGridEl().select('tbody', true).first(); + var tfd = this.getGridEl().select('tfoot', true).first(); + + var cw = ctr.getWidth(); + + if (tbd) { + + tbd.setSize(ctr.getWidth(), + ctr.getHeight() - ((thd ? thd.getHeight() : 0) + (tfd ? tfd.getHeight() : 0)) + ); + var barsize = (tbd.dom.offsetWidth - tbd.dom.clientWidth); + cw -= barsize; + } + cw = Math.max(cw, this.totalWidth); + this.getGridEl().select('tr',true).setWidth(cw); + // resize 'expandable coloumn? + + return; // we doe not have a view in this design.. + + }, + onBodyScroll: function() + { + //Roo.log("body scrolled');" + this.mainBody.dom.scrollLeft); + if(this.mainHead){ + this.mainHead.setStyle({ + 'position' : 'relative', + 'left': (-1* this.mainBody.dom.scrollLeft) + 'px' + }); + } + + if(this.lazyLoad){ + + var scrollHeight = this.mainBody.dom.scrollHeight; + + var scrollTop = Math.ceil(this.mainBody.getScroll().top); + + var height = this.mainBody.getHeight(); + + if(scrollHeight - height == scrollTop) { + + var total = this.ds.getTotalCount(); + + if(this.footer.cursor + this.footer.pageSize < total){ + + this.footer.ds.load({ + params : { + start : this.footer.cursor + this.footer.pageSize, + limit : this.footer.pageSize + }, + add : true + }); + } + } + + } + }, + + onHeaderChange : function() + { + var header = this.renderHeader(); + var table = this.el.select('table', true).first(); + + this.mainHead.remove(); + this.mainHead = table.createChild(header, this.mainBody, false); + }, + + onHiddenChange : function(colModel, colIndex, hidden) + { + var thSelector = '#' + this.id + ' .x-hcol-' + colIndex; + var tdSelector = '#' + this.id + ' .x-col-' + colIndex; + + this.CSS.updateRule(thSelector, "display", ""); + this.CSS.updateRule(tdSelector, "display", ""); + + if(hidden){ + this.CSS.updateRule(thSelector, "display", "none"); + this.CSS.updateRule(tdSelector, "display", "none"); + } + + this.onHeaderChange(); + this.onLoad(); + }, + + setColumnWidth: function(col_index, width) + { + // width = "md-2 xs-2..." + if(!this.colModel.config[col_index]) { + return; + } + + var w = width.split(" "); + + var rows = this.el.dom.getElementsByClassName("x-col-"+col_index); + + var h_row = this.el.dom.getElementsByClassName("x-hcol-"+col_index); + + + for(var j = 0; j < w.length; j++) { + + if(!w[j]) { + continue; + } + + var size_cls = w[j].split("-"); + + if(!Number.isInteger(size_cls[1] * 1)) { + continue; + } + + if(!this.colModel.config[col_index][size_cls[0]]) { + continue; + } + + if(!h_row[0].classList.contains("col-"+size_cls[0]+"-"+this.colModel.config[col_index][size_cls[0]])) { + continue; + } + + h_row[0].classList.replace( + "col-"+size_cls[0]+"-"+this.colModel.config[col_index][size_cls[0]], + "col-"+size_cls[0]+"-"+size_cls[1] + ); + + for(var i = 0; i < rows.length; i++) { + + var size_cls = w[j].split("-"); + + if(!Number.isInteger(size_cls[1] * 1)) { + continue; + } + + if(!this.colModel.config[col_index][size_cls[0]]) { + continue; + } + + if(!rows[i].classList.contains("col-"+size_cls[0]+"-"+this.colModel.config[col_index][size_cls[0]])) { + continue; + } + + rows[i].classList.replace( + "col-"+size_cls[0]+"-"+this.colModel.config[col_index][size_cls[0]], + "col-"+size_cls[0]+"-"+size_cls[1] + ); + } + + this.colModel.config[col_index][size_cls[0]] = size_cls[1]; + } + } +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_TableBody.js.html b/docs2/src/Roo_bootstrap_TableBody.js.html new file mode 100644 index 0000000000..e1007f787d --- /dev/null +++ b/docs2/src/Roo_bootstrap_TableBody.js.html @@ -0,0 +1,87 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/TableBody.js/* + * - LGPL + * + * table body + * + */ + +/** + * @class Roo.bootstrap.TableBody + * @extends Roo.bootstrap.Component + * Bootstrap TableBody class + * @cfg {String} cls element class + * @cfg {String} tag element tag (thead|tbody|tfoot) default tbody + * @cfg {String} align Aligns the content inside the element + * @cfg {Number} charoff Sets the number of characters the content inside the element will be aligned from the character specified by the char attribute + * @cfg {String} valign Vertical aligns the content inside the <tbody> element + * + * @constructor + * Create a new TableBody + * @param {Object} config The config object + */ + +Roo.bootstrap.TableBody = function(config){ + Roo.bootstrap.TableBody.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.TableBody, Roo.bootstrap.Component, { + + cls: false, + tag: false, + align: false, + charoff: false, + valign: false, + + getAutoCreate : function(){ + var cfg = Roo.apply({}, Roo.bootstrap.TableBody.superclass.getAutoCreate.call(this)); + + cfg = { + tag: 'tbody' + }; + + if (this.cls) { + cfg.cls=this.cls + } + if(this.tag){ + cfg.tag = this.tag; + } + + if(this.align){ + cfg.align = this.align; + } + if(this.charoff){ + cfg.charoff = this.charoff; + } + if(this.valign){ + cfg.valign = this.valign; + } + + return cfg; + } + + +// initEvents : function() +// { +// +// if(!this.store){ +// return; +// } +// +// this.store = Roo.factory(this.store, Roo.data); +// this.store.on('load', this.onLoad, this); +// +// this.store.load(); +// +// }, +// +// onLoad: function () +// { +// this.fireEvent('load', this); +// } +// +// +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_TableCell.js.html b/docs2/src/Roo_bootstrap_TableCell.js.html new file mode 100644 index 0000000000..4c39e93d47 --- /dev/null +++ b/docs2/src/Roo_bootstrap_TableCell.js.html @@ -0,0 +1,123 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/TableCell.js/* + * - LGPL + * + * table cell + * + */ + +/** + * @class Roo.bootstrap.TableCell + * @extends Roo.bootstrap.Component + * Bootstrap TableCell class + * @cfg {String} html cell contain text + * @cfg {String} cls cell class + * @cfg {String} tag cell tag (td|th) default td + * @cfg {String} abbr Specifies an abbreviated version of the content in a cell + * @cfg {String} align Aligns the content in a cell + * @cfg {String} axis Categorizes cells + * @cfg {String} bgcolor Specifies the background color of a cell + * @cfg {Number} charoff Sets the number of characters the content will be aligned from the character specified by the char attribute + * @cfg {Number} colspan Specifies the number of columns a cell should span + * @cfg {String} headers Specifies one or more header cells a cell is related to + * @cfg {Number} height Sets the height of a cell + * @cfg {String} nowrap Specifies that the content inside a cell should not wrap + * @cfg {Number} rowspan Sets the number of rows a cell should span + * @cfg {String} scope Defines a way to associate header cells and data cells in a table + * @cfg {String} valign Vertical aligns the content in a cell + * @cfg {Number} width Specifies the width of a cell + * + * @constructor + * Create a new TableCell + * @param {Object} config The config object + */ + +Roo.bootstrap.TableCell = function(config){ + Roo.bootstrap.TableCell.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.TableCell, Roo.bootstrap.Component, { + + html: false, + cls: false, + tag: false, + abbr: false, + align: false, + axis: false, + bgcolor: false, + charoff: false, + colspan: false, + headers: false, + height: false, + nowrap: false, + rowspan: false, + scope: false, + valign: false, + width: false, + + + getAutoCreate : function(){ + var cfg = Roo.apply({}, Roo.bootstrap.TableCell.superclass.getAutoCreate.call(this)); + + cfg = { + tag: 'td' + }; + + if(this.tag){ + cfg.tag = this.tag; + } + + if (this.html) { + cfg.html=this.html + } + if (this.cls) { + cfg.cls=this.cls + } + if (this.abbr) { + cfg.abbr=this.abbr + } + if (this.align) { + cfg.align=this.align + } + if (this.axis) { + cfg.axis=this.axis + } + if (this.bgcolor) { + cfg.bgcolor=this.bgcolor + } + if (this.charoff) { + cfg.charoff=this.charoff + } + if (this.colspan) { + cfg.colspan=this.colspan + } + if (this.headers) { + cfg.headers=this.headers + } + if (this.height) { + cfg.height=this.height + } + if (this.nowrap) { + cfg.nowrap=this.nowrap + } + if (this.rowspan) { + cfg.rowspan=this.rowspan + } + if (this.scope) { + cfg.scope=this.scope + } + if (this.valign) { + cfg.valign=this.valign + } + if (this.width) { + cfg.width=this.width + } + + + return cfg; + } + +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_TableRow.js.html b/docs2/src/Roo_bootstrap_TableRow.js.html new file mode 100644 index 0000000000..89193565ac --- /dev/null +++ b/docs2/src/Roo_bootstrap_TableRow.js.html @@ -0,0 +1,65 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/TableRow.js/* + * - LGPL + * + * table row + * + */ + +/** + * @class Roo.bootstrap.TableRow + * @extends Roo.bootstrap.Component + * Bootstrap TableRow class + * @cfg {String} cls row class + * @cfg {String} align Aligns the content in a table row + * @cfg {String} bgcolor Specifies a background color for a table row + * @cfg {Number} charoff Sets the number of characters the content will be aligned from the character specified by the char attribute + * @cfg {String} valign Vertical aligns the content in a table row + * + * @constructor + * Create a new TableRow + * @param {Object} config The config object + */ + +Roo.bootstrap.TableRow = function(config){ + Roo.bootstrap.TableRow.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.TableRow, Roo.bootstrap.Component, { + + cls: false, + align: false, + bgcolor: false, + charoff: false, + valign: false, + + getAutoCreate : function(){ + var cfg = Roo.apply({}, Roo.bootstrap.TableRow.superclass.getAutoCreate.call(this)); + + cfg = { + tag: 'tr' + }; + + if(this.cls){ + cfg.cls = this.cls; + } + if(this.align){ + cfg.align = this.align; + } + if(this.bgcolor){ + cfg.bgcolor = this.bgcolor; + } + if(this.charoff){ + cfg.charoff = this.charoff; + } + if(this.valign){ + cfg.valign = this.valign; + } + + return cfg; + } + +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Table_AbstractSelectionModel.js.html b/docs2/src/Roo_bootstrap_Table_AbstractSelectionModel.js.html new file mode 100644 index 0000000000..2679b66a3d --- /dev/null +++ b/docs2/src/Roo_bootstrap_Table_AbstractSelectionModel.js.html @@ -0,0 +1,43 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Table/AbstractSelectionModel.js +/** + * @class Roo.bootstrap.Table.AbstractSelectionModel + * @extends Roo.util.Observable + * Abstract base class for grid SelectionModels. It provides the interface that should be + * implemented by descendant classes. This class should not be directly instantiated. + * @constructor + */ +Roo.bootstrap.Table.AbstractSelectionModel = function(){ + this.locked = false; + Roo.bootstrap.Table.AbstractSelectionModel.superclass.constructor.call(this); +}; + + +Roo.extend(Roo.bootstrap.Table.AbstractSelectionModel, Roo.util.Observable, { + /** @ignore Called by the grid automatically. Do not call directly. */ + init : function(grid){ + this.grid = grid; + this.initEvents(); + }, + + /** + * Locks the selections. + */ + lock : function(){ + this.locked = true; + }, + + /** + * Unlocks the selections. + */ + unlock : function(){ + this.locked = false; + }, + + /** + * Returns true if the selections are locked. + * @return {Boolean} + */ + isLocked : function(){ + return this.locked; + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Table_RowSelectionModel.js.html b/docs2/src/Roo_bootstrap_Table_RowSelectionModel.js.html new file mode 100644 index 0000000000..2e16496669 --- /dev/null +++ b/docs2/src/Roo_bootstrap_Table_RowSelectionModel.js.html @@ -0,0 +1,499 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Table/RowSelectionModel.js +/** + * @extends Roo.bootstrap.Table.AbstractSelectionModel + * @class Roo.bootstrap.Table.RowSelectionModel + * The default SelectionModel used by {@link Roo.bootstrap.Table}. + * It supports multiple selections and keyboard selection/navigation. + * @constructor + * @param {Object} config + */ + +Roo.bootstrap.Table.RowSelectionModel = function(config){ + Roo.apply(this, config); + this.selections = new Roo.util.MixedCollection(false, function(o){ + return o.id; + }); + + this.last = false; + this.lastActive = false; + + this.addEvents({ + /** + * @event selectionchange + * Fires when the selection changes + * @param {SelectionModel} this + */ + "selectionchange" : true, + /** + * @event afterselectionchange + * Fires after the selection changes (eg. by key press or clicking) + * @param {SelectionModel} this + */ + "afterselectionchange" : true, + /** + * @event beforerowselect + * Fires when a row is selected being selected, return false to cancel. + * @param {SelectionModel} this + * @param {Number} rowIndex The selected index + * @param {Boolean} keepExisting False if other selections will be cleared + */ + "beforerowselect" : true, + /** + * @event rowselect + * Fires when a row is selected. + * @param {SelectionModel} this + * @param {Number} rowIndex The selected index + * @param {Roo.data.Record} r The record + */ + "rowselect" : true, + /** + * @event rowdeselect + * Fires when a row is deselected. + * @param {SelectionModel} this + * @param {Number} rowIndex The selected index + */ + "rowdeselect" : true + }); + Roo.bootstrap.Table.RowSelectionModel.superclass.constructor.call(this); + this.locked = false; + }; + +Roo.extend(Roo.bootstrap.Table.RowSelectionModel, Roo.bootstrap.Table.AbstractSelectionModel, { + /** + * @cfg {Boolean} singleSelect + * True to allow selection of only one row at a time (defaults to false) + */ + singleSelect : false, + + // private + initEvents : function() + { + + //if(!this.grid.enableDragDrop && !this.grid.enableDrag){ + // this.growclickrid.on("mousedown", this.handleMouseDown, this); + //}else{ // allow click to work like normal + // this.grid.on("rowclick", this.handleDragableRowClick, this); + //} + //this.grid.on("rowdblclick", this.handleMouseDBClick, this); + this.grid.on("rowclick", this.handleMouseDown, this); + + this.rowNav = new Roo.KeyNav(this.grid.getGridEl(), { + "up" : function(e){ + if(!e.shiftKey){ + this.selectPrevious(e.shiftKey); + }else if(this.last !== false && this.lastActive !== false){ + var last = this.last; + this.selectRange(this.last, this.lastActive-1); + this.grid.getView().focusRow(this.lastActive); + if(last !== false){ + this.last = last; + } + }else{ + this.selectFirstRow(); + } + this.fireEvent("afterselectionchange", this); + }, + "down" : function(e){ + if(!e.shiftKey){ + this.selectNext(e.shiftKey); + }else if(this.last !== false && this.lastActive !== false){ + var last = this.last; + this.selectRange(this.last, this.lastActive+1); + this.grid.getView().focusRow(this.lastActive); + if(last !== false){ + this.last = last; + } + }else{ + this.selectFirstRow(); + } + this.fireEvent("afterselectionchange", this); + }, + scope: this + }); + this.grid.store.on('load', function(){ + this.selections.clear(); + },this); + /* + var view = this.grid.view; + view.on("refresh", this.onRefresh, this); + view.on("rowupdated", this.onRowUpdated, this); + view.on("rowremoved", this.onRemove, this); + */ + }, + + // private + onRefresh : function() + { + var ds = this.grid.store, i, v = this.grid.view; + var s = this.selections; + s.each(function(r){ + if((i = ds.indexOfId(r.id)) != -1){ + v.onRowSelect(i); + }else{ + s.remove(r); + } + }); + }, + + // private + onRemove : function(v, index, r){ + this.selections.remove(r); + }, + + // private + onRowUpdated : function(v, index, r){ + if(this.isSelected(r)){ + v.onRowSelect(index); + } + }, + + /** + * Select records. + * @param {Array} records The records to select + * @param {Boolean} keepExisting (optional) True to keep existing selections + */ + selectRecords : function(records, keepExisting) + { + if(!keepExisting){ + this.clearSelections(); + } + var ds = this.grid.store; + for(var i = 0, len = records.length; i < len; i++){ + this.selectRow(ds.indexOf(records[i]), true); + } + }, + + /** + * Gets the number of selected rows. + * @return {Number} + */ + getCount : function(){ + return this.selections.length; + }, + + /** + * Selects the first row in the grid. + */ + selectFirstRow : function(){ + this.selectRow(0); + }, + + /** + * Select the last row. + * @param {Boolean} keepExisting (optional) True to keep existing selections + */ + selectLastRow : function(keepExisting){ + //this.selectRow(this.grid.dataSource.getCount() - 1, keepExisting); + this.selectRow(this.grid.store.getCount() - 1, keepExisting); + }, + + /** + * Selects the row immediately following the last selected row. + * @param {Boolean} keepExisting (optional) True to keep existing selections + */ + selectNext : function(keepExisting) + { + if(this.last !== false && (this.last+1) < this.grid.store.getCount()){ + this.selectRow(this.last+1, keepExisting); + this.grid.getView().focusRow(this.last); + } + }, + + /** + * Selects the row that precedes the last selected row. + * @param {Boolean} keepExisting (optional) True to keep existing selections + */ + selectPrevious : function(keepExisting){ + if(this.last){ + this.selectRow(this.last-1, keepExisting); + this.grid.getView().focusRow(this.last); + } + }, + + /** + * Returns the selected records + * @return {Array} Array of selected records + */ + getSelections : function(){ + return [].concat(this.selections.items); + }, + + /** + * Returns the first selected record. + * @return {Record} + */ + getSelected : function(){ + return this.selections.itemAt(0); + }, + + + /** + * Clears all selections. + */ + clearSelections : function(fast) + { + if(this.locked) { + return; + } + if(fast !== true){ + var ds = this.grid.store; + var s = this.selections; + s.each(function(r){ + this.deselectRow(ds.indexOfId(r.id)); + }, this); + s.clear(); + }else{ + this.selections.clear(); + } + this.last = false; + }, + + + /** + * Selects all rows. + */ + selectAll : function(){ + if(this.locked) { + return; + } + this.selections.clear(); + for(var i = 0, len = this.grid.store.getCount(); i < len; i++){ + this.selectRow(i, true); + } + }, + + /** + * Returns True if there is a selection. + * @return {Boolean} + */ + hasSelection : function(){ + return this.selections.length > 0; + }, + + /** + * Returns True if the specified row is selected. + * @param {Number/Record} record The record or index of the record to check + * @return {Boolean} + */ + isSelected : function(index){ + var r = typeof index == "number" ? this.grid.store.getAt(index) : index; + return (r && this.selections.key(r.id) ? true : false); + }, + + /** + * Returns True if the specified record id is selected. + * @param {String} id The id of record to check + * @return {Boolean} + */ + isIdSelected : function(id){ + return (this.selections.key(id) ? true : false); + }, + + + // private + handleMouseDBClick : function(e, t){ + + }, + // private + handleMouseDown : function(e, t) + { + var rowIndex = this.grid.headerShow ? t.dom.rowIndex - 1 : t.dom.rowIndex ; // first row is header??? + if(this.isLocked() || rowIndex < 0 ){ + return; + }; + if(e.shiftKey && this.last !== false){ + var last = this.last; + this.selectRange(last, rowIndex, e.ctrlKey); + this.last = last; // reset the last + t.focus(); + + }else{ + var isSelected = this.isSelected(rowIndex); + //Roo.log("select row:" + rowIndex); + if(isSelected){ + this.deselectRow(rowIndex); + } else { + this.selectRow(rowIndex, true); + } + + /* + if(e.button !== 0 && isSelected){ + alert('rowIndex 2: ' + rowIndex); + view.focusRow(rowIndex); + }else if(e.ctrlKey && isSelected){ + this.deselectRow(rowIndex); + }else if(!isSelected){ + this.selectRow(rowIndex, e.button === 0 && (e.ctrlKey || e.shiftKey)); + view.focusRow(rowIndex); + } + */ + } + this.fireEvent("afterselectionchange", this); + }, + // private + handleDragableRowClick : function(grid, rowIndex, e) + { + if(e.button === 0 && !e.shiftKey && !e.ctrlKey) { + this.selectRow(rowIndex, false); + grid.view.focusRow(rowIndex); + this.fireEvent("afterselectionchange", this); + } + }, + + /** + * Selects multiple rows. + * @param {Array} rows Array of the indexes of the row to select + * @param {Boolean} keepExisting (optional) True to keep existing selections + */ + selectRows : function(rows, keepExisting){ + if(!keepExisting){ + this.clearSelections(); + } + for(var i = 0, len = rows.length; i < len; i++){ + this.selectRow(rows[i], true); + } + }, + + /** + * Selects a range of rows. All rows in between startRow and endRow are also selected. + * @param {Number} startRow The index of the first row in the range + * @param {Number} endRow The index of the last row in the range + * @param {Boolean} keepExisting (optional) True to retain existing selections + */ + selectRange : function(startRow, endRow, keepExisting){ + if(this.locked) { + return; + } + if(!keepExisting){ + this.clearSelections(); + } + if(startRow <= endRow){ + for(var i = startRow; i <= endRow; i++){ + this.selectRow(i, true); + } + }else{ + for(var i = startRow; i >= endRow; i--){ + this.selectRow(i, true); + } + } + }, + + /** + * Deselects a range of rows. All rows in between startRow and endRow are also deselected. + * @param {Number} startRow The index of the first row in the range + * @param {Number} endRow The index of the last row in the range + */ + deselectRange : function(startRow, endRow, preventViewNotify){ + if(this.locked) { + return; + } + for(var i = startRow; i <= endRow; i++){ + this.deselectRow(i, preventViewNotify); + } + }, + + /** + * Selects a row. + * @param {Number} row The index of the row to select + * @param {Boolean} keepExisting (optional) True to keep existing selections + */ + selectRow : function(index, keepExisting, preventViewNotify) + { + if(this.locked || (index < 0 || index > this.grid.store.getCount())) { + return; + } + if(this.fireEvent("beforerowselect", this, index, keepExisting) !== false){ + if(!keepExisting || this.singleSelect){ + this.clearSelections(); + } + + var r = this.grid.store.getAt(index); + //console.log('selectRow - record id :' + r.id); + + this.selections.add(r); + this.last = this.lastActive = index; + if(!preventViewNotify){ + var proxy = new Roo.Element( + this.grid.getRowDom(index) + ); + proxy.addClass('bg-info info'); + } + this.fireEvent("rowselect", this, index, r); + this.fireEvent("selectionchange", this); + } + }, + + /** + * Deselects a row. + * @param {Number} row The index of the row to deselect + */ + deselectRow : function(index, preventViewNotify) + { + if(this.locked) { + return; + } + if(this.last == index){ + this.last = false; + } + if(this.lastActive == index){ + this.lastActive = false; + } + + var r = this.grid.store.getAt(index); + if (!r) { + return; + } + + this.selections.remove(r); + //.console.log('deselectRow - record id :' + r.id); + if(!preventViewNotify){ + + var proxy = new Roo.Element( + this.grid.getRowDom(index) + ); + proxy.removeClass('bg-info info'); + } + this.fireEvent("rowdeselect", this, index); + this.fireEvent("selectionchange", this); + }, + + // private + restoreLast : function(){ + if(this._last){ + this.last = this._last; + } + }, + + // private + acceptsNav : function(row, col, cm){ + return !cm.isHidden(col) && cm.isCellEditable(col, row); + }, + + // private + onEditorKey : function(field, e){ + var k = e.getKey(), newCell, g = this.grid, ed = g.activeEditor; + if(k == e.TAB){ + e.stopEvent(); + ed.completeEdit(); + if(e.shiftKey){ + newCell = g.walkCells(ed.row, ed.col-1, -1, this.acceptsNav, this); + }else{ + newCell = g.walkCells(ed.row, ed.col+1, 1, this.acceptsNav, this); + } + }else if(k == e.ENTER && !e.ctrlKey){ + e.stopEvent(); + ed.completeEdit(); + if(e.shiftKey){ + newCell = g.walkCells(ed.row-1, ed.col, -1, this.acceptsNav, this); + }else{ + newCell = g.walkCells(ed.row+1, ed.col, 1, this.acceptsNav, this); + } + }else if(k == e.ESC){ + ed.cancelEdit(); + } + if(newCell){ + g.startEditing(newCell[0], newCell[1]); + } + } +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_TextArea.js.html b/docs2/src/Roo_bootstrap_TextArea.js.html new file mode 100644 index 0000000000..f65762cbf3 --- /dev/null +++ b/docs2/src/Roo_bootstrap_TextArea.js.html @@ -0,0 +1,370 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/TextArea.js/* + * - LGPL + * + * Input + * + */ + +/** + * @class Roo.bootstrap.TextArea + * @extends Roo.bootstrap.Input + * Bootstrap TextArea class + * @cfg {Number} cols Specifies the visible width of a text area + * @cfg {Number} rows Specifies the visible number of lines in a text area + * @cfg {string} wrap (soft|hard)Specifies how the text in a text area is to be wrapped when submitted in a form + * @cfg {string} resize (none|both|horizontal|vertical|inherit|initial) + * @cfg {string} html text + * + * @constructor + * Create a new TextArea + * @param {Object} config The config object + */ + +Roo.bootstrap.TextArea = function(config){ + Roo.bootstrap.TextArea.superclass.constructor.call(this, config); + +}; + +Roo.extend(Roo.bootstrap.TextArea, Roo.bootstrap.Input, { + + cols : false, + rows : 5, + readOnly : false, + warp : 'soft', + resize : false, + value: false, + html: false, + + getAutoCreate : function(){ + + var align = (!this.labelAlign) ? this.parentLabelAlign() : this.labelAlign; + + var id = Roo.id(); + + var cfg = {}; + + if(this.inputType != 'hidden'){ + cfg.cls = 'form-group' //input-group + } + + var input = { + tag: 'textarea', + id : id, + warp : this.warp, + rows : this.rows, + value : this.value || '', + html: this.html || '', + cls : 'form-control', + placeholder : this.placeholder || '' + + }; + + if(this.maxLength && this.maxLength != Number.MAX_VALUE){ + input.maxLength = this.maxLength; + } + + if(this.resize){ + input.style = (typeof(input.style) == 'undefined') ? 'resize:' + this.resize : input.style + 'resize:' + this.resize; + } + + if(this.cols){ + input.cols = this.cols; + } + + if (this.readOnly) { + input.readonly = true; + } + + if (this.name) { + input.name = this.name; + } + + if (this.size) { + input.cls = (typeof(input.cls) == 'undefined') ? 'input-' + this.size : input.cls + ' input-' + this.size; + } + + var settings=this; + ['xs','sm','md','lg'].map(function(size){ + if (settings[size]) { + cfg.cls += ' col-' + size + '-' + settings[size]; + } + }); + + var inputblock = input; + + if(this.hasFeedback && !this.allowBlank){ + + var feedback = { + tag: 'span', + cls: 'glyphicon form-control-feedback' + }; + + inputblock = { + cls : 'has-feedback', + cn : [ + input, + feedback + ] + }; + } + + + if (this.before || this.after) { + + inputblock = { + cls : 'input-group', + cn : [] + }; + if (this.before) { + inputblock.cn.push({ + tag :'span', + cls : 'input-group-addon', + html : this.before + }); + } + + inputblock.cn.push(input); + + if(this.hasFeedback && !this.allowBlank){ + inputblock.cls += ' has-feedback'; + inputblock.cn.push(feedback); + } + + if (this.after) { + inputblock.cn.push({ + tag :'span', + cls : 'input-group-addon', + html : this.after + }); + } + + } + + if (align ==='left' && this.fieldLabel.length) { + cfg.cn = [ + { + tag: 'label', + 'for' : id, + cls : 'control-label', + html : this.fieldLabel + }, + { + cls : "", + cn: [ + inputblock + ] + } + + ]; + + if(this.labelWidth > 12){ + cfg.cn[0].style = "width: " + this.labelWidth + 'px'; + } + + if(this.labelWidth < 13 && this.labelmd == 0){ + this.labelmd = this.labelWidth; + } + + if(this.labellg > 0){ + cfg.cn[0].cls += ' col-lg-' + this.labellg; + cfg.cn[1].cls += ' col-lg-' + (12 - this.labellg); + } + + if(this.labelmd > 0){ + cfg.cn[0].cls += ' col-md-' + this.labelmd; + cfg.cn[1].cls += ' col-md-' + (12 - this.labelmd); + } + + if(this.labelsm > 0){ + cfg.cn[0].cls += ' col-sm-' + this.labelsm; + cfg.cn[1].cls += ' col-sm-' + (12 - this.labelsm); + } + + if(this.labelxs > 0){ + cfg.cn[0].cls += ' col-xs-' + this.labelxs; + cfg.cn[1].cls += ' col-xs-' + (12 - this.labelxs); + } + + } else if ( this.fieldLabel.length) { + cfg.cn = [ + + { + tag: 'label', + //cls : 'input-group-addon', + html : this.fieldLabel + + }, + + inputblock + + ]; + + } else { + + cfg.cn = [ + + inputblock + + ]; + + } + + if (this.disabled) { + input.disabled=true; + } + + return cfg; + + }, + /** + * return the real textarea element. + */ + inputEl: function () + { + return this.el.select('textarea.form-control',true).first(); + }, + + /** + * Clear any invalid styles/messages for this field + */ + clearInvalid : function() + { + + if(!this.el || this.preventMark){ // not rendered + return; + } + + var label = this.el.select('label', true).first(); + var icon = this.el.select('i.fa-star', true).first(); + + if(label && icon){ + icon.remove(); + } + this.el.removeClass( this.validClass); + this.inputEl().removeClass('is-invalid'); + + if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank){ + + var feedback = this.el.select('.form-control-feedback', true).first(); + + if(feedback){ + this.el.select('.form-control-feedback', true).first().removeClass(this.invalidFeedbackClass); + } + + } + + this.fireEvent('valid', this); + }, + + /** + * Mark this field as valid + */ + markValid : function() + { + if(!this.el || this.preventMark){ // not rendered + return; + } + + this.el.removeClass([this.invalidClass, this.validClass]); + this.inputEl().removeClass(['is-valid', 'is-invalid']); + + var feedback = this.el.select('.form-control-feedback', true).first(); + + if(feedback){ + this.el.select('.form-control-feedback', true).first().removeClass([this.invalidFeedbackClass, this.validFeedbackClass]); + } + + if(this.disabled || this.allowBlank){ + return; + } + + var label = this.el.select('label', true).first(); + var icon = this.el.select('i.fa-star', true).first(); + + if(label && icon){ + icon.remove(); + } + if (Roo.bootstrap.version == 3) { + this.el.addClass(this.validClass); + } else { + this.inputEl().addClass('is-valid'); + } + + + if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank && (this.getValue().length || this.forceFeedback)){ + + var feedback = this.el.select('.form-control-feedback', true).first(); + + if(feedback){ + this.el.select('.form-control-feedback', true).first().removeClass([this.invalidFeedbackClass, this.validFeedbackClass]); + this.el.select('.form-control-feedback', true).first().addClass([this.validFeedbackClass]); + } + + } + + this.fireEvent('valid', this); + }, + + /** + * Mark this field as invalid + * @param {String} msg The validation message + */ + markInvalid : function(msg) + { + if(!this.el || this.preventMark){ // not rendered + return; + } + + this.el.removeClass([this.invalidClass, this.validClass]); + this.inputEl().removeClass(['is-valid', 'is-invalid']); + + var feedback = this.el.select('.form-control-feedback', true).first(); + + if(feedback){ + this.el.select('.form-control-feedback', true).first().removeClass([this.invalidFeedbackClass, this.validFeedbackClass]); + } + + if(this.disabled || this.allowBlank){ + return; + } + + var label = this.el.select('label', true).first(); + var icon = this.el.select('i.fa-star', true).first(); + + if(!this.getValue().length && label && !icon){ + this.el.createChild({ + tag : 'i', + cls : 'text-danger fa fa-lg fa-star', + tooltip : 'This field is required', + style : 'margin-right:5px;' + }, label, true); + } + + if (Roo.bootstrap.version == 3) { + this.el.addClass(this.invalidClass); + } else { + this.inputEl().addClass('is-invalid'); + } + + // fixme ... this may be depricated need to test.. + if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank){ + + var feedback = this.el.select('.form-control-feedback', true).first(); + + if(feedback){ + this.el.select('.form-control-feedback', true).first().removeClass([this.invalidFeedbackClass, this.validFeedbackClass]); + + if(this.getValue().length || this.forceFeedback){ + this.el.select('.form-control-feedback', true).first().addClass([this.invalidFeedbackClass]); + } + + } + + } + + this.fireEvent('invalid', this, msg); + } +}); + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_TimeField.js.html b/docs2/src/Roo_bootstrap_TimeField.js.html new file mode 100644 index 0000000000..61e8eb3f21 --- /dev/null +++ b/docs2/src/Roo_bootstrap_TimeField.js.html @@ -0,0 +1,509 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/TimeField.js/* + * - LGPL + * + * TimeField + * + */ + +/** + * @class Roo.bootstrap.TimeField + * @extends Roo.bootstrap.Input + * Bootstrap DateField class + * + * + * @constructor + * Create a new TimeField + * @param {Object} config The config object + */ + +Roo.bootstrap.TimeField = function(config){ + Roo.bootstrap.TimeField.superclass.constructor.call(this, config); + this.addEvents({ + /** + * @event show + * Fires when this field show. + * @param {Roo.bootstrap.DateField} thisthis + * @param {Mixed} date The date value + */ + show : true, + /** + * @event show + * Fires when this field hide. + * @param {Roo.bootstrap.DateField} this + * @param {Mixed} date The date value + */ + hide : true, + /** + * @event select + * Fires when select a date. + * @param {Roo.bootstrap.DateField} this + * @param {Mixed} date The date value + */ + select : true + }); +}; + +Roo.extend(Roo.bootstrap.TimeField, Roo.bootstrap.Input, { + + /** + * @cfg {String} format + * The default time format string which can be overriden for localization support. The format must be + * valid according to {@link Date#parseDate} (defaults to 'H:i'). + */ + format : "H:i", + + onRender: function(ct, position) + { + + Roo.bootstrap.TimeField.superclass.onRender.call(this, ct, position); + + this.el.select('>.input-group', true).first().createChild(Roo.bootstrap.TimeField.template); + + this.picker().setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + + this.pop = this.picker().select('>.datepicker-time',true).first(); + this.pop.setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + + this.picker().on('mousedown', this.onMousedown, this); + this.picker().on('click', this.onClick, this); + + this.picker().addClass('datepicker-dropdown'); + + this.fillTime(); + this.update(); + + this.pop.select('span.hours-up', true).first().on('click', this.onIncrementHours, this); + this.pop.select('span.hours-down', true).first().on('click', this.onDecrementHours, this); + this.pop.select('span.minutes-up', true).first().on('click', this.onIncrementMinutes, this); + this.pop.select('span.minutes-down', true).first().on('click', this.onDecrementMinutes, this); + this.pop.select('button.period', true).first().on('click', this.onTogglePeriod, this); + this.pop.select('button.ok', true).first().on('click', this.setTime, this); + + }, + + fireKey: function(e){ + if (!this.picker().isVisible()){ + if (e.keyCode == 27) { // allow escape to hide and re-show picker + this.show(); + } + return; + } + + e.preventDefault(); + + switch(e.keyCode){ + case 27: // escape + this.hide(); + break; + case 37: // left + case 39: // right + this.onTogglePeriod(); + break; + case 38: // up + this.onIncrementMinutes(); + break; + case 40: // down + this.onDecrementMinutes(); + break; + case 13: // enter + case 9: // tab + this.setTime(); + break; + } + }, + + onClick: function(e) { + e.stopPropagation(); + e.preventDefault(); + }, + + picker : function() + { + return this.el.select('.datepicker', true).first(); + }, + + fillTime: function() + { + var time = this.pop.select('tbody', true).first(); + + time.dom.innerHTML = ''; + + time.createChild({ + tag: 'tr', + cn: [ + { + tag: 'td', + cn: [ + { + tag: 'a', + href: '#', + cls: 'btn', + cn: [ + { + tag: 'span', + cls: 'hours-up glyphicon glyphicon-chevron-up' + } + ] + } + ] + }, + { + tag: 'td', + cls: 'separator' + }, + { + tag: 'td', + cn: [ + { + tag: 'a', + href: '#', + cls: 'btn', + cn: [ + { + tag: 'span', + cls: 'minutes-up glyphicon glyphicon-chevron-up' + } + ] + } + ] + }, + { + tag: 'td', + cls: 'separator' + } + ] + }); + + time.createChild({ + tag: 'tr', + cn: [ + { + tag: 'td', + cn: [ + { + tag: 'span', + cls: 'timepicker-hour', + html: '00' + } + ] + }, + { + tag: 'td', + cls: 'separator', + html: ':' + }, + { + tag: 'td', + cn: [ + { + tag: 'span', + cls: 'timepicker-minute', + html: '00' + } + ] + }, + { + tag: 'td', + cls: 'separator' + }, + { + tag: 'td', + cn: [ + { + tag: 'button', + type: 'button', + cls: 'btn btn-primary period', + html: 'AM' + + } + ] + } + ] + }); + + time.createChild({ + tag: 'tr', + cn: [ + { + tag: 'td', + cn: [ + { + tag: 'a', + href: '#', + cls: 'btn', + cn: [ + { + tag: 'span', + cls: 'hours-down glyphicon glyphicon-chevron-down' + } + ] + } + ] + }, + { + tag: 'td', + cls: 'separator' + }, + { + tag: 'td', + cn: [ + { + tag: 'a', + href: '#', + cls: 'btn', + cn: [ + { + tag: 'span', + cls: 'minutes-down glyphicon glyphicon-chevron-down' + } + ] + } + ] + }, + { + tag: 'td', + cls: 'separator' + } + ] + }); + + }, + + update: function() + { + + this.time = (typeof(this.time) === 'undefined') ? new Date() : this.time; + + this.fill(); + }, + + fill: function() + { + var hours = this.time.getHours(); + var minutes = this.time.getMinutes(); + var period = 'AM'; + + if(hours > 11){ + period = 'PM'; + } + + if(hours == 0){ + hours = 12; + } + + + if(hours > 12){ + hours = hours - 12; + } + + if(hours < 10){ + hours = '0' + hours; + } + + if(minutes < 10){ + minutes = '0' + minutes; + } + + this.pop.select('.timepicker-hour', true).first().dom.innerHTML = hours; + this.pop.select('.timepicker-minute', true).first().dom.innerHTML = minutes; + this.pop.select('button', true).first().dom.innerHTML = period; + + }, + + place: function() + { + this.picker().removeClass(['bottom-left', 'bottom-right', 'top-left', 'top-right']); + + var cls = ['bottom']; + + if((Roo.lib.Dom.getViewHeight() + Roo.get(document.body).getScroll().top) - (this.inputEl().getBottom() + this.picker().getHeight()) < 0){ // top + cls.pop(); + cls.push('top'); + } + + cls.push('right'); + + if((Roo.lib.Dom.getViewWidth() + Roo.get(document.body).getScroll().left) - (this.inputEl().getLeft() + this.picker().getWidth()) < 0){ // left + cls.pop(); + cls.push('left'); + } + + this.picker().addClass(cls.join('-')); + + var _this = this; + + Roo.each(cls, function(c){ + if(c == 'bottom'){ + _this.picker().setTop(_this.inputEl().getHeight()); + return; + } + if(c == 'top'){ + _this.picker().setTop(0 - _this.picker().getHeight()); + return; + } + + if(c == 'left'){ + _this.picker().setLeft(_this.inputEl().getLeft() + _this.inputEl().getWidth() - _this.el.getLeft() - _this.picker().getWidth()); + return; + } + if(c == 'right'){ + _this.picker().setLeft(_this.inputEl().getLeft() - _this.el.getLeft()); + return; + } + }); + + }, + + onFocus : function() + { + Roo.bootstrap.TimeField.superclass.onFocus.call(this); + this.show(); + }, + + onBlur : function() + { + Roo.bootstrap.TimeField.superclass.onBlur.call(this); + this.hide(); + }, + + show : function() + { + this.picker().show(); + this.pop.show(); + this.update(); + this.place(); + + this.fireEvent('show', this, this.date); + }, + + hide : function() + { + this.picker().hide(); + this.pop.hide(); + + this.fireEvent('hide', this, this.date); + }, + + setTime : function() + { + this.hide(); + this.setValue(this.time.format(this.format)); + + this.fireEvent('select', this, this.date); + + + }, + + onMousedown: function(e){ + e.stopPropagation(); + e.preventDefault(); + }, + + onIncrementHours: function() + { + Roo.log('onIncrementHours'); + this.time = this.time.add(Date.HOUR, 1); + this.update(); + + }, + + onDecrementHours: function() + { + Roo.log('onDecrementHours'); + this.time = this.time.add(Date.HOUR, -1); + this.update(); + }, + + onIncrementMinutes: function() + { + Roo.log('onIncrementMinutes'); + this.time = this.time.add(Date.MINUTE, 1); + this.update(); + }, + + onDecrementMinutes: function() + { + Roo.log('onDecrementMinutes'); + this.time = this.time.add(Date.MINUTE, -1); + this.update(); + }, + + onTogglePeriod: function() + { + Roo.log('onTogglePeriod'); + this.time = this.time.add(Date.HOUR, 12); + this.update(); + } + + +}); + +Roo.apply(Roo.bootstrap.TimeField, { + + content : { + tag: 'tbody', + cn: [ + { + tag: 'tr', + cn: [ + { + tag: 'td', + colspan: '7' + } + ] + } + ] + }, + + footer : { + tag: 'tfoot', + cn: [ + { + tag: 'tr', + cn: [ + { + tag: 'th', + colspan: '7', + cls: '', + cn: [ + { + tag: 'button', + cls: 'btn btn-info ok', + html: 'OK' + } + ] + } + + ] + } + ] + } +}); + +Roo.apply(Roo.bootstrap.TimeField, { + + template : { + tag: 'div', + cls: 'datepicker dropdown-menu', + cn: [ + { + tag: 'div', + cls: 'datepicker-time', + cn: [ + { + tag: 'table', + cls: 'table-condensed', + cn:[ + Roo.bootstrap.TimeField.content, + Roo.bootstrap.TimeField.footer + ] + } + ] + } + ] + } +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_Tooltip.js.html b/docs2/src/Roo_bootstrap_Tooltip.js.html new file mode 100644 index 0000000000..d9635209b3 --- /dev/null +++ b/docs2/src/Roo_bootstrap_Tooltip.js.html @@ -0,0 +1,310 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/Tooltip.js/* + * - LGPL + * + * Tooltip + * + */ + +/** + * @class Roo.bootstrap.Tooltip + * Bootstrap Tooltip class + * This is basic at present - all componets support it by default, however they should add tooltipEl() method + * to determine which dom element triggers the tooltip. + * + * It needs to add support for additional attributes like tooltip-position + * + * @constructor + * Create a new Toolti + * @param {Object} config The config object + */ + +Roo.bootstrap.Tooltip = function(config){ + Roo.bootstrap.Tooltip.superclass.constructor.call(this, config); + + this.alignment = Roo.bootstrap.Tooltip.alignment; + + if(typeof(config) != 'undefined' && typeof(config.alignment) != 'undefined'){ + this.alignment = config.alignment; + } + +}; + +Roo.apply(Roo.bootstrap.Tooltip, { + /** + * @function init initialize tooltip monitoring. + * @static + */ + currentEl : false, + currentTip : false, + currentRegion : false, + + // init : delay? + + init : function() + { + Roo.get(document).on('mouseover', this.enter ,this); + Roo.get(document).on('mouseout', this.leave, this); + + + this.currentTip = new Roo.bootstrap.Tooltip(); + }, + + enter : function(ev) + { + var dom = ev.getTarget(); + + //Roo.log(['enter',dom]); + var el = Roo.fly(dom); + if (this.currentEl) { + //Roo.log(dom); + //Roo.log(this.currentEl); + //Roo.log(this.currentEl.contains(dom)); + if (this.currentEl == el) { + return; + } + if (dom != this.currentEl.dom && this.currentEl.contains(dom)) { + return; + } + + } + + if (this.currentTip.el) { + this.currentTip.el.setVisibilityMode(Roo.Element.DISPLAY).hide(); // force hiding... + } + //Roo.log(ev); + + if(!el || el.dom == document){ + return; + } + + var bindEl = el; + + // you can not look for children, as if el is the body.. then everythign is the child.. + if (!el.attr('tooltip')) { // + if (!el.select("[tooltip]").elements.length) { + return; + } + // is the mouse over this child...? + bindEl = el.select("[tooltip]").first(); + var xy = ev.getXY(); + if (!bindEl.getRegion().contains( { top : xy[1] ,right : xy[0] , bottom : xy[1], left : xy[0]})) { + //Roo.log("not in region."); + return; + } + //Roo.log("child element over.."); + + } + this.currentEl = bindEl; + this.currentTip.bind(bindEl); + this.currentRegion = Roo.lib.Region.getRegion(dom); + this.currentTip.enter(); + + }, + leave : function(ev) + { + var dom = ev.getTarget(); + //Roo.log(['leave',dom]); + if (!this.currentEl) { + return; + } + + + if (dom != this.currentEl.dom) { + return; + } + var xy = ev.getXY(); + if (this.currentRegion.contains( new Roo.lib.Region( xy[1], xy[0] ,xy[1], xy[0] ))) { + return; + } + // only activate leave if mouse cursor is outside... bounding box.. + + + + + if (this.currentTip) { + this.currentTip.leave(); + } + //Roo.log('clear currentEl'); + this.currentEl = false; + + + }, + alignment : { + 'left' : ['r-l', [-2,0], 'right'], + 'right' : ['l-r', [2,0], 'left'], + 'bottom' : ['t-b', [0,2], 'top'], + 'top' : [ 'b-t', [0,-2], 'bottom'] + } + +}); + + +Roo.extend(Roo.bootstrap.Tooltip, Roo.bootstrap.Component, { + + + bindEl : false, + + delay : null, // can be { show : 300 , hide: 500} + + timeout : null, + + hoverState : null, //??? + + placement : 'bottom', + + alignment : false, + + getAutoCreate : function(){ + + var cfg = { + cls : 'tooltip', + role : 'tooltip', + cn : [ + { + cls : 'tooltip-arrow' + }, + { + cls : 'tooltip-inner' + } + ] + }; + + return cfg; + }, + bind : function(el) + { + this.bindEl = el; + }, + + + enter : function () { + + if (this.timeout != null) { + clearTimeout(this.timeout); + } + + this.hoverState = 'in'; + //Roo.log("enter - show"); + if (!this.delay || !this.delay.show) { + this.show(); + return; + } + var _t = this; + this.timeout = setTimeout(function () { + if (_t.hoverState == 'in') { + _t.show(); + } + }, this.delay.show); + }, + leave : function() + { + clearTimeout(this.timeout); + + this.hoverState = 'out'; + if (!this.delay || !this.delay.hide) { + this.hide(); + return; + } + + var _t = this; + this.timeout = setTimeout(function () { + //Roo.log("leave - timeout"); + + if (_t.hoverState == 'out') { + _t.hide(); + Roo.bootstrap.Tooltip.currentEl = false; + } + }, delay); + }, + + show : function (msg) + { + if (!this.el) { + this.render(document.body); + } + // set content. + //Roo.log([this.bindEl, this.bindEl.attr('tooltip')]); + + var tip = msg || this.bindEl.attr('tooltip') || this.bindEl.select("[tooltip]").first().attr('tooltip'); + + this.el.select('.tooltip-inner',true).first().dom.innerHTML = tip; + + this.el.removeClass(['fade','top','bottom', 'left', 'right','in']); + + var placement = typeof this.placement == 'function' ? + this.placement.call(this, this.el, on_el) : + this.placement; + + var autoToken = /\s?auto?\s?/i; + var autoPlace = autoToken.test(placement); + if (autoPlace) { + placement = placement.replace(autoToken, '') || 'top'; + } + + //this.el.detach() + //this.el.setXY([0,0]); + this.el.show(); + //this.el.dom.style.display='block'; + + //this.el.appendTo(on_el); + + var p = this.getPosition(); + var box = this.el.getBox(); + + if (autoPlace) { + // fixme.. + } + + var align = this.alignment[placement]; + + var xy = this.el.getAlignToXY(this.bindEl, align[0], align[1]); + + if(placement == 'top' || placement == 'bottom'){ + if(xy[0] < 0){ + placement = 'right'; + } + + if(xy[0] + this.el.getWidth() > Roo.lib.Dom.getViewWidth()){ + placement = 'left'; + } + + var scroll = Roo.select('body', true).first().getScroll(); + + if(xy[1] > Roo.lib.Dom.getViewHeight() + scroll.top - this.el.getHeight()){ + placement = 'top'; + } + + align = this.alignment[placement]; + } + + this.el.alignTo(this.bindEl, align[0],align[1]); + //var arrow = this.el.select('.arrow',true).first(); + //arrow.set(align[2], + + this.el.addClass(placement); + + this.el.addClass('in fade'); + + this.hoverState = null; + + if (this.el.hasClass('fade')) { + // fade it? + } + + }, + hide : function() + { + + if (!this.el) { + return; + } + //this.el.setXY([0,0]); + this.el.removeClass('in'); + //this.el.hide(); + + } + +}); + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_TriggerField.js.html b/docs2/src/Roo_bootstrap_TriggerField.js.html new file mode 100644 index 0000000000..0418e8f80f --- /dev/null +++ b/docs2/src/Roo_bootstrap_TriggerField.js.html @@ -0,0 +1,606 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/TriggerField.js/* + * - LGPL + * + * trigger field - base class for combo.. + * + */ + +/** + * @class Roo.bootstrap.TriggerField + * @extends Roo.bootstrap.Input + * Provides a convenient wrapper for TextFields that adds a clickable trigger button (looks like a combobox by default). + * The trigger has no default action, so you must assign a function to implement the trigger click handler by + * overriding {@link #onTriggerClick}. You can create a TriggerField directly, as it renders exactly like a combobox + * for which you can provide a custom implementation. For example: + * <pre><code> +var trigger = new Roo.bootstrap.TriggerField(); +trigger.onTriggerClick = myTriggerFn; +trigger.applyTo('my-field'); +</code></pre> + * + * However, in general you will most likely want to use TriggerField as the base class for a reusable component. + * {@link Roo.bootstrap.DateField} and {@link Roo.bootstrap.ComboBox} are perfect examples of this. + * @cfg {String} triggerClass An additional CSS class used to style the trigger button. The trigger will always get the + * class 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified. + * @cfg {String} caret (search|calendar) a fontawesome for the trigger icon see http://fortawesome.github.io/Font-Awesome/icons/ + + * @constructor + * Create a new TriggerField. + * @param {Object} config Configuration options (valid {@Roo.bootstrap.Input} config options will also be applied + * to the base TextField) + */ +Roo.bootstrap.TriggerField = function(config){ + this.mimicing = false; + Roo.bootstrap.TriggerField.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.TriggerField, Roo.bootstrap.Input, { + /** + * @cfg {String} triggerClass A CSS class to apply to the trigger + */ + /** + * @cfg {Boolean} hideTrigger True to hide the trigger element and display only the base text field (defaults to false) + */ + hideTrigger:false, + + /** + * @cfg {Boolean} removable (true|false) special filter default false + */ + removable : false, + + /** @cfg {Boolean} grow @hide */ + /** @cfg {Number} growMin @hide */ + /** @cfg {Number} growMax @hide */ + + /** + * @hide + * @method + */ + autoSize: Roo.emptyFn, + // private + monitorTab : true, + // private + deferHeight : true, + + + actionMode : 'wrap', + + caret : false, + + + getAutoCreate : function(){ + + var align = this.labelAlign || this.parentLabelAlign(); + + var id = Roo.id(); + + var cfg = { + cls: 'form-group' //input-group + }; + + + var input = { + tag: 'input', + id : id, + type : this.inputType, + cls : 'form-control', + autocomplete: 'new-password', + placeholder : this.placeholder || '' + + }; + if (this.name) { + input.name = this.name; + } + if (this.size) { + input.cls += ' input-' + this.size; + } + + if (this.disabled) { + input.disabled=true; + } + + var inputblock = input; + + if(this.hasFeedback && !this.allowBlank){ + + var feedback = { + tag: 'span', + cls: 'glyphicon form-control-feedback' + }; + + if(this.removable && !this.editable && !this.tickable){ + inputblock = { + cls : 'has-feedback', + cn : [ + inputblock, + { + tag: 'button', + html : 'x', + cls : 'roo-combo-removable-btn close' + }, + feedback + ] + }; + } else { + inputblock = { + cls : 'has-feedback', + cn : [ + inputblock, + feedback + ] + }; + } + + } else { + if(this.removable && !this.editable && !this.tickable){ + inputblock = { + cls : 'roo-removable', + cn : [ + inputblock, + { + tag: 'button', + html : 'x', + cls : 'roo-combo-removable-btn close' + } + ] + }; + } + } + + if (this.before || this.after) { + + inputblock = { + cls : 'input-group', + cn : [] + }; + if (this.before) { + inputblock.cn.push({ + tag :'span', + cls : 'input-group-addon input-group-prepend input-group-text', + html : this.before + }); + } + + inputblock.cn.push(input); + + if(this.hasFeedback && !this.allowBlank){ + inputblock.cls += ' has-feedback'; + inputblock.cn.push(feedback); + } + + if (this.after) { + inputblock.cn.push({ + tag :'span', + cls : 'input-group-addon input-group-append input-group-text', + html : this.after + }); + } + + }; + + + + var ibwrap = inputblock; + + if(this.multiple){ + ibwrap = { + tag: 'ul', + cls: 'roo-select2-choices', + cn:[ + { + tag: 'li', + cls: 'roo-select2-search-field', + cn: [ + + inputblock + ] + } + ] + }; + + } + + var combobox = { + cls: 'roo-select2-container input-group', + cn: [ + { + tag: 'input', + type : 'hidden', + cls: 'form-hidden-field' + }, + ibwrap + ] + }; + + if(!this.multiple && this.showToggleBtn){ + + var caret = { + tag: 'span', + cls: 'caret' + }; + if (this.caret != false) { + caret = { + tag: 'i', + cls: 'fa fa-' + this.caret + }; + + } + + combobox.cn.push({ + tag :'span', + cls : 'input-group-addon input-group-append input-group-text btn dropdown-toggle', + cn : [ + caret, + { + tag: 'span', + cls: 'combobox-clear', + cn : [ + { + tag : 'i', + cls: 'icon-remove' + } + ] + } + ] + + }) + } + + if(this.multiple){ + combobox.cls += ' roo-select2-container-multi'; + } + var indicator = { + tag : 'i', + cls : 'roo-required-indicator ' + (this.indicatorpos == 'right' ? 'right' : 'left') +'-indicator text-danger fa fa-lg fa-star', + tooltip : 'This field is required' + }; + if (Roo.bootstrap.version == 4) { + indicator = { + tag : 'i', + style : 'display:none' + }; + } + + + if (align ==='left' && this.fieldLabel.length) { + + cfg.cls += ' roo-form-group-label-left' + (Roo.bootstrap.version == 4 ? ' row' : ''); + + cfg.cn = [ + indicator, + { + tag: 'label', + 'for' : id, + cls : 'control-label', + html : this.fieldLabel + + }, + { + cls : "", + cn: [ + combobox + ] + } + + ]; + + var labelCfg = cfg.cn[1]; + var contentCfg = cfg.cn[2]; + + if(this.indicatorpos == 'right'){ + cfg.cn = [ + { + tag: 'label', + 'for' : id, + cls : 'control-label', + cn : [ + { + tag : 'span', + html : this.fieldLabel + }, + indicator + ] + }, + { + cls : "", + cn: [ + combobox + ] + } + + ]; + + labelCfg = cfg.cn[0]; + contentCfg = cfg.cn[1]; + } + + if(this.labelWidth > 12){ + labelCfg.style = "width: " + this.labelWidth + 'px'; + } + + if(this.labelWidth < 13 && this.labelmd == 0){ + this.labelmd = this.labelWidth; + } + + if(this.labellg > 0){ + labelCfg.cls += ' col-lg-' + this.labellg; + contentCfg.cls += ' col-lg-' + (12 - this.labellg); + } + + if(this.labelmd > 0){ + labelCfg.cls += ' col-md-' + this.labelmd; + contentCfg.cls += ' col-md-' + (12 - this.labelmd); + } + + if(this.labelsm > 0){ + labelCfg.cls += ' col-sm-' + this.labelsm; + contentCfg.cls += ' col-sm-' + (12 - this.labelsm); + } + + if(this.labelxs > 0){ + labelCfg.cls += ' col-xs-' + this.labelxs; + contentCfg.cls += ' col-xs-' + (12 - this.labelxs); + } + + } else if ( this.fieldLabel.length) { +// Roo.log(" label"); + cfg.cn = [ + indicator, + { + tag: 'label', + //cls : 'input-group-addon', + html : this.fieldLabel + + }, + + combobox + + ]; + + if(this.indicatorpos == 'right'){ + + cfg.cn = [ + { + tag: 'label', + cn : [ + { + tag : 'span', + html : this.fieldLabel + }, + indicator + ] + + }, + combobox + + ]; + + } + + } else { + +// Roo.log(" no label && no align"); + cfg = combobox + + + } + + var settings=this; + ['xs','sm','md','lg'].map(function(size){ + if (settings[size]) { + cfg.cls += ' col-' + size + '-' + settings[size]; + } + }); + + return cfg; + + }, + + + + // private + onResize : function(w, h){ +// Roo.bootstrap.TriggerField.superclass.onResize.apply(this, arguments); +// if(typeof w == 'number'){ +// var x = w - this.trigger.getWidth(); +// this.inputEl().setWidth(this.adjustWidth('input', x)); +// this.trigger.setStyle('left', x+'px'); +// } + }, + + // private + adjustSize : Roo.BoxComponent.prototype.adjustSize, + + // private + getResizeEl : function(){ + return this.inputEl(); + }, + + // private + getPositionEl : function(){ + return this.inputEl(); + }, + + // private + alignErrorIcon : function(){ + this.errorIcon.alignTo(this.inputEl(), 'tl-tr', [2, 0]); + }, + + // private + initEvents : function(){ + + this.createList(); + + Roo.bootstrap.TriggerField.superclass.initEvents.call(this); + //this.wrap = this.el.wrap({cls: "x-form-field-wrap"}); + if(!this.multiple && this.showToggleBtn){ + this.trigger = this.el.select('span.dropdown-toggle',true).first(); + if(this.hideTrigger){ + this.trigger.setDisplayed(false); + } + this.trigger.on("click", this.onTriggerClick, this, {preventDefault:true}); + } + + if(this.multiple){ + this.inputEl().on("click", this.onTriggerClick, this, {preventDefault:true}); + } + + if(this.removable && !this.editable && !this.tickable){ + var close = this.closeTriggerEl(); + + if(close){ + close.setVisibilityMode(Roo.Element.DISPLAY).hide(); + close.on('click', this.removeBtnClick, this, close); + } + } + + //this.trigger.addClassOnOver('x-form-trigger-over'); + //this.trigger.addClassOnClick('x-form-trigger-click'); + + //if(!this.width){ + // this.wrap.setWidth(this.el.getWidth()+this.trigger.getWidth()); + //} + }, + + closeTriggerEl : function() + { + var close = this.el.select('.roo-combo-removable-btn', true).first(); + return close ? close : false; + }, + + removeBtnClick : function(e, h, el) + { + e.preventDefault(); + + if(this.fireEvent("remove", this) !== false){ + this.reset(); + this.fireEvent("afterremove", this) + } + }, + + createList : function() + { + this.list = Roo.get(document.body).createChild({ + tag: Roo.bootstrap.version == 4 ? 'div' : 'ul', + cls: 'typeahead typeahead-long dropdown-menu', + style: 'display:none' + }); + + this.list.setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block';; + + }, + + // private + initTrigger : function(){ + + }, + + // private + onDestroy : function(){ + if(this.trigger){ + this.trigger.removeAllListeners(); + // this.trigger.remove(); + } + //if(this.wrap){ + // this.wrap.remove(); + //} + Roo.bootstrap.TriggerField.superclass.onDestroy.call(this); + }, + + // private + onFocus : function(){ + Roo.bootstrap.TriggerField.superclass.onFocus.call(this); + /* + if(!this.mimicing){ + this.wrap.addClass('x-trigger-wrap-focus'); + this.mimicing = true; + Roo.get(Roo.isIE ? document.body : document).on("mousedown", this.mimicBlur, this); + if(this.monitorTab){ + this.el.on("keydown", this.checkTab, this); + } + } + */ + }, + + // private + checkTab : function(e){ + if(e.getKey() == e.TAB){ + this.triggerBlur(); + } + }, + + // private + onBlur : function(){ + // do nothing + }, + + // private + mimicBlur : function(e, t){ + /* + if(!this.wrap.contains(t) && this.validateBlur()){ + this.triggerBlur(); + } + */ + }, + + // private + triggerBlur : function(){ + this.mimicing = false; + Roo.get(Roo.isIE ? document.body : document).un("mousedown", this.mimicBlur); + if(this.monitorTab){ + this.el.un("keydown", this.checkTab, this); + } + //this.wrap.removeClass('x-trigger-wrap-focus'); + Roo.bootstrap.TriggerField.superclass.onBlur.call(this); + }, + + // private + // This should be overriden by any subclass that needs to check whether or not the field can be blurred. + validateBlur : function(e, t){ + return true; + }, + + // private + onDisable : function(){ + this.inputEl().dom.disabled = true; + //Roo.bootstrap.TriggerField.superclass.onDisable.call(this); + //if(this.wrap){ + // this.wrap.addClass('x-item-disabled'); + //} + }, + + // private + onEnable : function(){ + this.inputEl().dom.disabled = false; + //Roo.bootstrap.TriggerField.superclass.onEnable.call(this); + //if(this.wrap){ + // this.el.removeClass('x-item-disabled'); + //} + }, + + // private + onShow : function(){ + var ae = this.getActionEl(); + + if(ae){ + ae.dom.style.display = ''; + ae.dom.style.visibility = 'visible'; + } + }, + + // private + + onHide : function(){ + var ae = this.getActionEl(); + ae.dom.style.display = 'none'; + }, + + /** + * The function that should handle the trigger's click event. This method does nothing by default until overridden + * by an implementing function. + * @method + * @param {EventObject} e + */ + onTriggerClick : Roo.emptyFn +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_UploadCropbox.js.html b/docs2/src/Roo_bootstrap_UploadCropbox.js.html new file mode 100644 index 0000000000..60c3f6459b --- /dev/null +++ b/docs2/src/Roo_bootstrap_UploadCropbox.js.html @@ -0,0 +1,1753 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/UploadCropbox.js +/* +* Licence: LGPL +*/ + +/** + * @class Roo.bootstrap.UploadCropbox + * @extends Roo.bootstrap.Component + * Bootstrap UploadCropbox class + * @cfg {String} emptyText show when image has been loaded + * @cfg {String} rotateNotify show when image too small to rotate + * @cfg {Number} errorTimeout default 3000 + * @cfg {Number} minWidth default 300 + * @cfg {Number} minHeight default 300 + * @cfg {Array} buttons default ['rotateLeft', 'pictureBtn', 'rotateRight'] + * @cfg {Boolean} isDocument (true|false) default false + * @cfg {String} url action url + * @cfg {String} paramName default 'imageUpload' + * @cfg {String} method default POST + * @cfg {Boolean} loadMask (true|false) default true + * @cfg {Boolean} loadingText default 'Loading...' + * + * @constructor + * Create a new UploadCropbox + * @param {Object} config The config object + */ + +Roo.bootstrap.UploadCropbox = function(config){ + Roo.bootstrap.UploadCropbox.superclass.constructor.call(this, config); + + this.addEvents({ + /** + * @event beforeselectfile + * Fire before select file + * @param {Roo.bootstrap.UploadCropbox} this + */ + "beforeselectfile" : true, + /** + * @event initial + * Fire after initEvent + * @param {Roo.bootstrap.UploadCropbox} this + */ + "initial" : true, + /** + * @event crop + * Fire after initEvent + * @param {Roo.bootstrap.UploadCropbox} this + * @param {String} data + */ + "crop" : true, + /** + * @event prepare + * Fire when preparing the file data + * @param {Roo.bootstrap.UploadCropbox} this + * @param {Object} file + */ + "prepare" : true, + /** + * @event exception + * Fire when get exception + * @param {Roo.bootstrap.UploadCropbox} this + * @param {XMLHttpRequest} xhr + */ + "exception" : true, + /** + * @event beforeloadcanvas + * Fire before load the canvas + * @param {Roo.bootstrap.UploadCropbox} this + * @param {String} src + */ + "beforeloadcanvas" : true, + /** + * @event trash + * Fire when trash image + * @param {Roo.bootstrap.UploadCropbox} this + */ + "trash" : true, + /** + * @event download + * Fire when download the image + * @param {Roo.bootstrap.UploadCropbox} this + */ + "download" : true, + /** + * @event footerbuttonclick + * Fire when footerbuttonclick + * @param {Roo.bootstrap.UploadCropbox} this + * @param {String} type + */ + "footerbuttonclick" : true, + /** + * @event resize + * Fire when resize + * @param {Roo.bootstrap.UploadCropbox} this + */ + "resize" : true, + /** + * @event rotate + * Fire when rotate the image + * @param {Roo.bootstrap.UploadCropbox} this + * @param {String} pos + */ + "rotate" : true, + /** + * @event inspect + * Fire when inspect the file + * @param {Roo.bootstrap.UploadCropbox} this + * @param {Object} file + */ + "inspect" : true, + /** + * @event upload + * Fire when xhr upload the file + * @param {Roo.bootstrap.UploadCropbox} this + * @param {Object} data + */ + "upload" : true, + /** + * @event arrange + * Fire when arrange the file data + * @param {Roo.bootstrap.UploadCropbox} this + * @param {Object} formData + */ + "arrange" : true + }); + + this.buttons = this.buttons || Roo.bootstrap.UploadCropbox.footer.STANDARD; +}; + +Roo.extend(Roo.bootstrap.UploadCropbox, Roo.bootstrap.Component, { + + emptyText : 'Click to upload image', + rotateNotify : 'Image is too small to rotate', + errorTimeout : 3000, + scale : 0, + baseScale : 1, + rotate : 0, + dragable : false, + pinching : false, + mouseX : 0, + mouseY : 0, + cropData : false, + minWidth : 300, + minHeight : 300, + file : false, + exif : {}, + baseRotate : 1, + cropType : 'image/jpeg', + buttons : false, + canvasLoaded : false, + isDocument : false, + method : 'POST', + paramName : 'imageUpload', + loadMask : true, + loadingText : 'Loading...', + maskEl : false, + + getAutoCreate : function() + { + var cfg = { + tag : 'div', + cls : 'roo-upload-cropbox', + cn : [ + { + tag : 'input', + cls : 'roo-upload-cropbox-selector', + type : 'file' + }, + { + tag : 'div', + cls : 'roo-upload-cropbox-body', + style : 'cursor:pointer', + cn : [ + { + tag : 'div', + cls : 'roo-upload-cropbox-preview' + }, + { + tag : 'div', + cls : 'roo-upload-cropbox-thumb' + }, + { + tag : 'div', + cls : 'roo-upload-cropbox-empty-notify', + html : this.emptyText + }, + { + tag : 'div', + cls : 'roo-upload-cropbox-error-notify alert alert-danger', + html : this.rotateNotify + } + ] + }, + { + tag : 'div', + cls : 'roo-upload-cropbox-footer', + cn : { + tag : 'div', + cls : 'btn-group btn-group-justified roo-upload-cropbox-btn-group', + cn : [] + } + } + ] + }; + + return cfg; + }, + + onRender : function(ct, position) + { + Roo.bootstrap.UploadCropbox.superclass.onRender.call(this, ct, position); + + if (this.buttons.length) { + + Roo.each(this.buttons, function(bb) { + + var btn = this.el.select('.roo-upload-cropbox-footer div.roo-upload-cropbox-btn-group').first().createChild(bb); + + btn.on('click', this.onFooterButtonClick.createDelegate(this, [bb.action], true)); + + }, this); + } + + if(this.loadMask){ + this.maskEl = this.el; + } + }, + + initEvents : function() + { + this.urlAPI = (window.createObjectURL && window) || + (window.URL && URL.revokeObjectURL && URL) || + (window.webkitURL && webkitURL); + + this.bodyEl = this.el.select('.roo-upload-cropbox-body', true).first(); + this.bodyEl.setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + + this.selectorEl = this.el.select('.roo-upload-cropbox-selector', true).first(); + this.selectorEl.hide(); + + this.previewEl = this.el.select('.roo-upload-cropbox-preview', true).first(); + this.previewEl.setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + + this.thumbEl = this.el.select('.roo-upload-cropbox-thumb', true).first(); + this.thumbEl.setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + this.thumbEl.hide(); + + this.notifyEl = this.el.select('.roo-upload-cropbox-empty-notify', true).first(); + this.notifyEl.setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + + this.errorEl = this.el.select('.roo-upload-cropbox-error-notify', true).first(); + this.errorEl.setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + this.errorEl.hide(); + + this.footerEl = this.el.select('.roo-upload-cropbox-footer', true).first(); + this.footerEl.setVisibilityMode(Roo.Element.DISPLAY).originalDisplay = 'block'; + this.footerEl.hide(); + + this.setThumbBoxSize(); + + this.bind(); + + this.resize(); + + this.fireEvent('initial', this); + }, + + bind : function() + { + var _this = this; + + window.addEventListener("resize", function() { _this.resize(); } ); + + this.bodyEl.on('click', this.beforeSelectFile, this); + + if(Roo.isTouch){ + this.bodyEl.on('touchstart', this.onTouchStart, this); + this.bodyEl.on('touchmove', this.onTouchMove, this); + this.bodyEl.on('touchend', this.onTouchEnd, this); + } + + if(!Roo.isTouch){ + this.bodyEl.on('mousedown', this.onMouseDown, this); + this.bodyEl.on('mousemove', this.onMouseMove, this); + var mousewheel = (/Firefox/i.test(navigator.userAgent))? 'DOMMouseScroll' : 'mousewheel'; + this.bodyEl.on(mousewheel, this.onMouseWheel, this); + Roo.get(document).on('mouseup', this.onMouseUp, this); + } + + this.selectorEl.on('change', this.onFileSelected, this); + }, + + reset : function() + { + this.scale = 0; + this.baseScale = 1; + this.rotate = 0; + this.baseRotate = 1; + this.dragable = false; + this.pinching = false; + this.mouseX = 0; + this.mouseY = 0; + this.cropData = false; + this.notifyEl.dom.innerHTML = this.emptyText; + + this.selectorEl.dom.value = ''; + + }, + + resize : function() + { + if(this.fireEvent('resize', this) != false){ + this.setThumbBoxPosition(); + this.setCanvasPosition(); + } + }, + + onFooterButtonClick : function(e, el, o, type) + { + switch (type) { + case 'rotate-left' : + this.onRotateLeft(e); + break; + case 'rotate-right' : + this.onRotateRight(e); + break; + case 'picture' : + this.beforeSelectFile(e); + break; + case 'trash' : + this.trash(e); + break; + case 'crop' : + this.crop(e); + break; + case 'download' : + this.download(e); + break; + default : + break; + } + + this.fireEvent('footerbuttonclick', this, type); + }, + + beforeSelectFile : function(e) + { + e.preventDefault(); + + if(this.fireEvent('beforeselectfile', this) != false){ + this.selectorEl.dom.click(); + } + }, + + onFileSelected : function(e) + { + e.preventDefault(); + + if(typeof(this.selectorEl.dom.files) == 'undefined' || !this.selectorEl.dom.files.length){ + return; + } + + var file = this.selectorEl.dom.files[0]; + + if(this.fireEvent('inspect', this, file) != false){ + this.prepare(file); + } + + }, + + trash : function(e) + { + this.fireEvent('trash', this); + }, + + download : function(e) + { + this.fireEvent('download', this); + }, + + loadCanvas : function(src) + { + if(this.fireEvent('beforeloadcanvas', this, src) != false){ + + this.reset(); + + this.imageEl = document.createElement('img'); + + var _this = this; + + this.imageEl.addEventListener("load", function(){ _this.onLoadCanvas(); }); + + this.imageEl.src = src; + } + }, + + onLoadCanvas : function() + { + this.imageEl.OriginWidth = this.imageEl.naturalWidth || this.imageEl.width; + this.imageEl.OriginHeight = this.imageEl.naturalHeight || this.imageEl.height; + + this.bodyEl.un('click', this.beforeSelectFile, this); + + this.notifyEl.hide(); + this.thumbEl.show(); + this.footerEl.show(); + + this.baseRotateLevel(); + + if(this.isDocument){ + this.setThumbBoxSize(); + } + + this.setThumbBoxPosition(); + + this.baseScaleLevel(); + + this.draw(); + + this.resize(); + + this.canvasLoaded = true; + + if(this.loadMask){ + this.maskEl.unmask(); + } + + }, + + setCanvasPosition : function() + { + if(!this.canvasEl){ + return; + } + + var pw = Math.ceil((this.bodyEl.getWidth() - this.canvasEl.width) / 2); + var ph = Math.ceil((this.bodyEl.getHeight() - this.canvasEl.height) / 2); + + this.previewEl.setLeft(pw); + this.previewEl.setTop(ph); + + }, + + onMouseDown : function(e) + { + e.stopEvent(); + + this.dragable = true; + this.pinching = false; + + if(this.isDocument && (this.canvasEl.width < this.thumbEl.getWidth() || this.canvasEl.height < this.thumbEl.getHeight())){ + this.dragable = false; + return; + } + + this.mouseX = Roo.isTouch ? e.browserEvent.touches[0].pageX : e.getPageX(); + this.mouseY = Roo.isTouch ? e.browserEvent.touches[0].pageY : e.getPageY(); + + }, + + onMouseMove : function(e) + { + e.stopEvent(); + + if(!this.canvasLoaded){ + return; + } + + if (!this.dragable){ + return; + } + + var minX = Math.ceil(this.thumbEl.getLeft(true)); + var minY = Math.ceil(this.thumbEl.getTop(true)); + + var maxX = Math.ceil(minX + this.thumbEl.getWidth() - this.canvasEl.width); + var maxY = Math.ceil(minY + this.thumbEl.getHeight() - this.canvasEl.height); + + var x = Roo.isTouch ? e.browserEvent.touches[0].pageX : e.getPageX(); + var y = Roo.isTouch ? e.browserEvent.touches[0].pageY : e.getPageY(); + + x = x - this.mouseX; + y = y - this.mouseY; + + var bgX = Math.ceil(x + this.previewEl.getLeft(true)); + var bgY = Math.ceil(y + this.previewEl.getTop(true)); + + bgX = (minX < bgX) ? minX : ((maxX > bgX) ? maxX : bgX); + bgY = (minY < bgY) ? minY : ((maxY > bgY) ? maxY : bgY); + + this.previewEl.setLeft(bgX); + this.previewEl.setTop(bgY); + + this.mouseX = Roo.isTouch ? e.browserEvent.touches[0].pageX : e.getPageX(); + this.mouseY = Roo.isTouch ? e.browserEvent.touches[0].pageY : e.getPageY(); + }, + + onMouseUp : function(e) + { + e.stopEvent(); + + this.dragable = false; + }, + + onMouseWheel : function(e) + { + e.stopEvent(); + + this.startScale = this.scale; + + this.scale = (e.getWheelDelta() == 1) ? (this.scale + 1) : (this.scale - 1); + + if(!this.zoomable()){ + this.scale = this.startScale; + return; + } + + this.draw(); + + return; + }, + + zoomable : function() + { + var minScale = this.thumbEl.getWidth() / this.minWidth; + + if(this.minWidth < this.minHeight){ + minScale = this.thumbEl.getHeight() / this.minHeight; + } + + var width = Math.ceil(this.imageEl.OriginWidth * this.getScaleLevel() / minScale); + var height = Math.ceil(this.imageEl.OriginHeight * this.getScaleLevel() / minScale); + + if( + this.isDocument && + (this.rotate == 0 || this.rotate == 180) && + ( + width > this.imageEl.OriginWidth || + height > this.imageEl.OriginHeight || + (width < this.minWidth && height < this.minHeight) + ) + ){ + return false; + } + + if( + this.isDocument && + (this.rotate == 90 || this.rotate == 270) && + ( + width > this.imageEl.OriginWidth || + height > this.imageEl.OriginHeight || + (width < this.minHeight && height < this.minWidth) + ) + ){ + return false; + } + + if( + !this.isDocument && + (this.rotate == 0 || this.rotate == 180) && + ( + width < this.minWidth || + width > this.imageEl.OriginWidth || + height < this.minHeight || + height > this.imageEl.OriginHeight + ) + ){ + return false; + } + + if( + !this.isDocument && + (this.rotate == 90 || this.rotate == 270) && + ( + width < this.minHeight || + width > this.imageEl.OriginWidth || + height < this.minWidth || + height > this.imageEl.OriginHeight + ) + ){ + return false; + } + + return true; + + }, + + onRotateLeft : function(e) + { + if(!this.isDocument && (this.canvasEl.height < this.thumbEl.getWidth() || this.canvasEl.width < this.thumbEl.getHeight())){ + + var minScale = this.thumbEl.getWidth() / this.minWidth; + + var bw = Math.ceil(this.canvasEl.width / this.getScaleLevel()); + var bh = Math.ceil(this.canvasEl.height / this.getScaleLevel()); + + this.startScale = this.scale; + + while (this.getScaleLevel() < minScale){ + + this.scale = this.scale + 1; + + if(!this.zoomable()){ + break; + } + + if( + Math.ceil(bw * this.getScaleLevel()) < this.thumbEl.getHeight() || + Math.ceil(bh * this.getScaleLevel()) < this.thumbEl.getWidth() + ){ + continue; + } + + this.rotate = (this.rotate < 90) ? 270 : this.rotate - 90; + + this.draw(); + + return; + } + + this.scale = this.startScale; + + this.onRotateFail(); + + return false; + } + + this.rotate = (this.rotate < 90) ? 270 : this.rotate - 90; + + if(this.isDocument){ + this.setThumbBoxSize(); + this.setThumbBoxPosition(); + this.setCanvasPosition(); + } + + this.draw(); + + this.fireEvent('rotate', this, 'left'); + + }, + + onRotateRight : function(e) + { + if(!this.isDocument && (this.canvasEl.height < this.thumbEl.getWidth() || this.canvasEl.width < this.thumbEl.getHeight())){ + + var minScale = this.thumbEl.getWidth() / this.minWidth; + + var bw = Math.ceil(this.canvasEl.width / this.getScaleLevel()); + var bh = Math.ceil(this.canvasEl.height / this.getScaleLevel()); + + this.startScale = this.scale; + + while (this.getScaleLevel() < minScale){ + + this.scale = this.scale + 1; + + if(!this.zoomable()){ + break; + } + + if( + Math.ceil(bw * this.getScaleLevel()) < this.thumbEl.getHeight() || + Math.ceil(bh * this.getScaleLevel()) < this.thumbEl.getWidth() + ){ + continue; + } + + this.rotate = (this.rotate > 180) ? 0 : this.rotate + 90; + + this.draw(); + + return; + } + + this.scale = this.startScale; + + this.onRotateFail(); + + return false; + } + + this.rotate = (this.rotate > 180) ? 0 : this.rotate + 90; + + if(this.isDocument){ + this.setThumbBoxSize(); + this.setThumbBoxPosition(); + this.setCanvasPosition(); + } + + this.draw(); + + this.fireEvent('rotate', this, 'right'); + }, + + onRotateFail : function() + { + this.errorEl.show(true); + + var _this = this; + + (function() { _this.errorEl.hide(true); }).defer(this.errorTimeout); + }, + + draw : function() + { + this.previewEl.dom.innerHTML = ''; + + var canvasEl = document.createElement("canvas"); + + var contextEl = canvasEl.getContext("2d"); + + canvasEl.width = this.imageEl.OriginWidth * this.getScaleLevel(); + canvasEl.height = this.imageEl.OriginWidth * this.getScaleLevel(); + var center = this.imageEl.OriginWidth / 2; + + if(this.imageEl.OriginWidth < this.imageEl.OriginHeight){ + canvasEl.width = this.imageEl.OriginHeight * this.getScaleLevel(); + canvasEl.height = this.imageEl.OriginHeight * this.getScaleLevel(); + center = this.imageEl.OriginHeight / 2; + } + + contextEl.scale(this.getScaleLevel(), this.getScaleLevel()); + + contextEl.translate(center, center); + contextEl.rotate(this.rotate * Math.PI / 180); + + contextEl.drawImage(this.imageEl, 0, 0, this.imageEl.OriginWidth, this.imageEl.OriginHeight, center * -1, center * -1, this.imageEl.OriginWidth, this.imageEl.OriginHeight); + + this.canvasEl = document.createElement("canvas"); + + this.contextEl = this.canvasEl.getContext("2d"); + + switch (this.rotate) { + case 0 : + + this.canvasEl.width = this.imageEl.OriginWidth * this.getScaleLevel(); + this.canvasEl.height = this.imageEl.OriginHeight * this.getScaleLevel(); + + this.contextEl.drawImage(canvasEl, 0, 0, this.canvasEl.width, this.canvasEl.height, 0, 0, this.canvasEl.width, this.canvasEl.height); + + break; + case 90 : + + this.canvasEl.width = this.imageEl.OriginHeight * this.getScaleLevel(); + this.canvasEl.height = this.imageEl.OriginWidth * this.getScaleLevel(); + + if(this.imageEl.OriginWidth > this.imageEl.OriginHeight){ + this.contextEl.drawImage(canvasEl, Math.abs(this.canvasEl.width - this.canvasEl.height), 0, this.canvasEl.width, this.canvasEl.height, 0, 0, this.canvasEl.width, this.canvasEl.height); + break; + } + + this.contextEl.drawImage(canvasEl, 0, 0, this.canvasEl.width, this.canvasEl.height, 0, 0, this.canvasEl.width, this.canvasEl.height); + + break; + case 180 : + + this.canvasEl.width = this.imageEl.OriginWidth * this.getScaleLevel(); + this.canvasEl.height = this.imageEl.OriginHeight * this.getScaleLevel(); + + if(this.imageEl.OriginWidth > this.imageEl.OriginHeight){ + this.contextEl.drawImage(canvasEl, 0, Math.abs(this.canvasEl.width - this.canvasEl.height), this.canvasEl.width, this.canvasEl.height, 0, 0, this.canvasEl.width, this.canvasEl.height); + break; + } + + this.contextEl.drawImage(canvasEl, Math.abs(this.canvasEl.width - this.canvasEl.height), 0, this.canvasEl.width, this.canvasEl.height, 0, 0, this.canvasEl.width, this.canvasEl.height); + + break; + case 270 : + + this.canvasEl.width = this.imageEl.OriginHeight * this.getScaleLevel(); + this.canvasEl.height = this.imageEl.OriginWidth * this.getScaleLevel(); + + if(this.imageEl.OriginWidth > this.imageEl.OriginHeight){ + this.contextEl.drawImage(canvasEl, 0, 0, this.canvasEl.width, this.canvasEl.height, 0, 0, this.canvasEl.width, this.canvasEl.height); + break; + } + + this.contextEl.drawImage(canvasEl, 0, Math.abs(this.canvasEl.width - this.canvasEl.height), this.canvasEl.width, this.canvasEl.height, 0, 0, this.canvasEl.width, this.canvasEl.height); + + break; + default : + break; + } + + this.previewEl.appendChild(this.canvasEl); + + this.setCanvasPosition(); + }, + + crop : function() + { + if(!this.canvasLoaded){ + return; + } + + var imageCanvas = document.createElement("canvas"); + + var imageContext = imageCanvas.getContext("2d"); + + imageCanvas.width = (this.imageEl.OriginWidth > this.imageEl.OriginHeight) ? this.imageEl.OriginWidth : this.imageEl.OriginHeight; + imageCanvas.height = (this.imageEl.OriginWidth > this.imageEl.OriginHeight) ? this.imageEl.OriginWidth : this.imageEl.OriginHeight; + + var center = imageCanvas.width / 2; + + imageContext.translate(center, center); + + imageContext.rotate(this.rotate * Math.PI / 180); + + imageContext.drawImage(this.imageEl, 0, 0, this.imageEl.OriginWidth, this.imageEl.OriginHeight, center * -1, center * -1, this.imageEl.OriginWidth, this.imageEl.OriginHeight); + + var canvas = document.createElement("canvas"); + + var context = canvas.getContext("2d"); + + canvas.width = this.minWidth; + canvas.height = this.minHeight; + + switch (this.rotate) { + case 0 : + + var width = (this.thumbEl.getWidth() / this.getScaleLevel() > this.imageEl.OriginWidth) ? this.imageEl.OriginWidth : (this.thumbEl.getWidth() / this.getScaleLevel()); + var height = (this.thumbEl.getHeight() / this.getScaleLevel() > this.imageEl.OriginHeight) ? this.imageEl.OriginHeight : (this.thumbEl.getHeight() / this.getScaleLevel()); + + var x = (this.thumbEl.getLeft(true) > this.previewEl.getLeft(true)) ? 0 : ((this.previewEl.getLeft(true) - this.thumbEl.getLeft(true)) / this.getScaleLevel()); + var y = (this.thumbEl.getTop(true) > this.previewEl.getTop(true)) ? 0 : ((this.previewEl.getTop(true) - this.thumbEl.getTop(true)) / this.getScaleLevel()); + + var targetWidth = this.minWidth - 2 * x; + var targetHeight = this.minHeight - 2 * y; + + var scale = 1; + + if((x == 0 && y == 0) || (x == 0 && y > 0)){ + scale = targetWidth / width; + } + + if(x > 0 && y == 0){ + scale = targetHeight / height; + } + + if(x > 0 && y > 0){ + scale = targetWidth / width; + + if(width < height){ + scale = targetHeight / height; + } + } + + context.scale(scale, scale); + + var sx = Math.min(this.canvasEl.width - this.thumbEl.getWidth(), this.thumbEl.getLeft(true) - this.previewEl.getLeft(true)); + var sy = Math.min(this.canvasEl.height - this.thumbEl.getHeight(), this.thumbEl.getTop(true) - this.previewEl.getTop(true)); + + sx = sx < 0 ? 0 : (sx / this.getScaleLevel()); + sy = sy < 0 ? 0 : (sy / this.getScaleLevel()); + + context.drawImage(imageCanvas, sx, sy, width, height, x, y, width, height); + + break; + case 90 : + + var width = (this.thumbEl.getWidth() / this.getScaleLevel() > this.imageEl.OriginHeight) ? this.imageEl.OriginHeight : (this.thumbEl.getWidth() / this.getScaleLevel()); + var height = (this.thumbEl.getHeight() / this.getScaleLevel() > this.imageEl.OriginWidth) ? this.imageEl.OriginWidth : (this.thumbEl.getHeight() / this.getScaleLevel()); + + var x = (this.thumbEl.getLeft(true) > this.previewEl.getLeft(true)) ? 0 : ((this.previewEl.getLeft(true) - this.thumbEl.getLeft(true)) / this.getScaleLevel()); + var y = (this.thumbEl.getTop(true) > this.previewEl.getTop(true)) ? 0 : ((this.previewEl.getTop(true) - this.thumbEl.getTop(true)) / this.getScaleLevel()); + + var targetWidth = this.minWidth - 2 * x; + var targetHeight = this.minHeight - 2 * y; + + var scale = 1; + + if((x == 0 && y == 0) || (x == 0 && y > 0)){ + scale = targetWidth / width; + } + + if(x > 0 && y == 0){ + scale = targetHeight / height; + } + + if(x > 0 && y > 0){ + scale = targetWidth / width; + + if(width < height){ + scale = targetHeight / height; + } + } + + context.scale(scale, scale); + + var sx = Math.min(this.canvasEl.width - this.thumbEl.getWidth(), this.thumbEl.getLeft(true) - this.previewEl.getLeft(true)); + var sy = Math.min(this.canvasEl.height - this.thumbEl.getHeight(), this.thumbEl.getTop(true) - this.previewEl.getTop(true)); + + sx = sx < 0 ? 0 : (sx / this.getScaleLevel()); + sy = sy < 0 ? 0 : (sy / this.getScaleLevel()); + + sx += (this.imageEl.OriginWidth > this.imageEl.OriginHeight) ? Math.abs(this.imageEl.OriginWidth - this.imageEl.OriginHeight) : 0; + + context.drawImage(imageCanvas, sx, sy, width, height, x, y, width, height); + + break; + case 180 : + + var width = (this.thumbEl.getWidth() / this.getScaleLevel() > this.imageEl.OriginWidth) ? this.imageEl.OriginWidth : (this.thumbEl.getWidth() / this.getScaleLevel()); + var height = (this.thumbEl.getHeight() / this.getScaleLevel() > this.imageEl.OriginHeight) ? this.imageEl.OriginHeight : (this.thumbEl.getHeight() / this.getScaleLevel()); + + var x = (this.thumbEl.getLeft(true) > this.previewEl.getLeft(true)) ? 0 : ((this.previewEl.getLeft(true) - this.thumbEl.getLeft(true)) / this.getScaleLevel()); + var y = (this.thumbEl.getTop(true) > this.previewEl.getTop(true)) ? 0 : ((this.previewEl.getTop(true) - this.thumbEl.getTop(true)) / this.getScaleLevel()); + + var targetWidth = this.minWidth - 2 * x; + var targetHeight = this.minHeight - 2 * y; + + var scale = 1; + + if((x == 0 && y == 0) || (x == 0 && y > 0)){ + scale = targetWidth / width; + } + + if(x > 0 && y == 0){ + scale = targetHeight / height; + } + + if(x > 0 && y > 0){ + scale = targetWidth / width; + + if(width < height){ + scale = targetHeight / height; + } + } + + context.scale(scale, scale); + + var sx = Math.min(this.canvasEl.width - this.thumbEl.getWidth(), this.thumbEl.getLeft(true) - this.previewEl.getLeft(true)); + var sy = Math.min(this.canvasEl.height - this.thumbEl.getHeight(), this.thumbEl.getTop(true) - this.previewEl.getTop(true)); + + sx = sx < 0 ? 0 : (sx / this.getScaleLevel()); + sy = sy < 0 ? 0 : (sy / this.getScaleLevel()); + + sx += (this.imageEl.OriginWidth > this.imageEl.OriginHeight) ? 0 : Math.abs(this.imageEl.OriginWidth - this.imageEl.OriginHeight); + sy += (this.imageEl.OriginWidth > this.imageEl.OriginHeight) ? Math.abs(this.imageEl.OriginWidth - this.imageEl.OriginHeight) : 0; + + context.drawImage(imageCanvas, sx, sy, width, height, x, y, width, height); + + break; + case 270 : + + var width = (this.thumbEl.getWidth() / this.getScaleLevel() > this.imageEl.OriginHeight) ? this.imageEl.OriginHeight : (this.thumbEl.getWidth() / this.getScaleLevel()); + var height = (this.thumbEl.getHeight() / this.getScaleLevel() > this.imageEl.OriginWidth) ? this.imageEl.OriginWidth : (this.thumbEl.getHeight() / this.getScaleLevel()); + + var x = (this.thumbEl.getLeft(true) > this.previewEl.getLeft(true)) ? 0 : ((this.previewEl.getLeft(true) - this.thumbEl.getLeft(true)) / this.getScaleLevel()); + var y = (this.thumbEl.getTop(true) > this.previewEl.getTop(true)) ? 0 : ((this.previewEl.getTop(true) - this.thumbEl.getTop(true)) / this.getScaleLevel()); + + var targetWidth = this.minWidth - 2 * x; + var targetHeight = this.minHeight - 2 * y; + + var scale = 1; + + if((x == 0 && y == 0) || (x == 0 && y > 0)){ + scale = targetWidth / width; + } + + if(x > 0 && y == 0){ + scale = targetHeight / height; + } + + if(x > 0 && y > 0){ + scale = targetWidth / width; + + if(width < height){ + scale = targetHeight / height; + } + } + + context.scale(scale, scale); + + var sx = Math.min(this.canvasEl.width - this.thumbEl.getWidth(), this.thumbEl.getLeft(true) - this.previewEl.getLeft(true)); + var sy = Math.min(this.canvasEl.height - this.thumbEl.getHeight(), this.thumbEl.getTop(true) - this.previewEl.getTop(true)); + + sx = sx < 0 ? 0 : (sx / this.getScaleLevel()); + sy = sy < 0 ? 0 : (sy / this.getScaleLevel()); + + sy += (this.imageEl.OriginWidth > this.imageEl.OriginHeight) ? 0 : Math.abs(this.imageEl.OriginWidth - this.imageEl.OriginHeight); + + context.drawImage(imageCanvas, sx, sy, width, height, x, y, width, height); + + break; + default : + break; + } + + this.cropData = canvas.toDataURL(this.cropType); + + if(this.fireEvent('crop', this, this.cropData) !== false){ + this.process(this.file, this.cropData); + } + + return; + + }, + + setThumbBoxSize : function() + { + var width, height; + + if(this.isDocument && typeof(this.imageEl) != 'undefined'){ + width = (this.imageEl.OriginWidth > this.imageEl.OriginHeight) ? Math.max(this.minWidth, this.minHeight) : Math.min(this.minWidth, this.minHeight); + height = (this.imageEl.OriginWidth > this.imageEl.OriginHeight) ? Math.min(this.minWidth, this.minHeight) : Math.max(this.minWidth, this.minHeight); + + this.minWidth = width; + this.minHeight = height; + + if(this.rotate == 90 || this.rotate == 270){ + this.minWidth = height; + this.minHeight = width; + } + } + + height = 300; + width = Math.ceil(this.minWidth * height / this.minHeight); + + if(this.minWidth > this.minHeight){ + width = 300; + height = Math.ceil(this.minHeight * width / this.minWidth); + } + + this.thumbEl.setStyle({ + width : width + 'px', + height : height + 'px' + }); + + return; + + }, + + setThumbBoxPosition : function() + { + var x = Math.ceil((this.bodyEl.getWidth() - this.thumbEl.getWidth()) / 2 ); + var y = Math.ceil((this.bodyEl.getHeight() - this.thumbEl.getHeight()) / 2); + + this.thumbEl.setLeft(x); + this.thumbEl.setTop(y); + + }, + + baseRotateLevel : function() + { + this.baseRotate = 1; + + if( + typeof(this.exif) != 'undefined' && + typeof(this.exif[Roo.bootstrap.UploadCropbox['tags']['Orientation']]) != 'undefined' && + [1, 3, 6, 8].indexOf(this.exif[Roo.bootstrap.UploadCropbox['tags']['Orientation']]) != -1 + ){ + this.baseRotate = this.exif[Roo.bootstrap.UploadCropbox['tags']['Orientation']]; + } + + this.rotate = Roo.bootstrap.UploadCropbox['Orientation'][this.baseRotate]; + + }, + + baseScaleLevel : function() + { + var width, height; + + if(this.isDocument){ + + if(this.baseRotate == 6 || this.baseRotate == 8){ + + height = this.thumbEl.getHeight(); + this.baseScale = height / this.imageEl.OriginWidth; + + if(this.imageEl.OriginHeight * this.baseScale > this.thumbEl.getWidth()){ + width = this.thumbEl.getWidth(); + this.baseScale = width / this.imageEl.OriginHeight; + } + + return; + } + + height = this.thumbEl.getHeight(); + this.baseScale = height / this.imageEl.OriginHeight; + + if(this.imageEl.OriginWidth * this.baseScale > this.thumbEl.getWidth()){ + width = this.thumbEl.getWidth(); + this.baseScale = width / this.imageEl.OriginWidth; + } + + return; + } + + if(this.baseRotate == 6 || this.baseRotate == 8){ + + width = this.thumbEl.getHeight(); + this.baseScale = width / this.imageEl.OriginHeight; + + if(this.imageEl.OriginHeight * this.baseScale < this.thumbEl.getWidth()){ + height = this.thumbEl.getWidth(); + this.baseScale = height / this.imageEl.OriginHeight; + } + + if(this.imageEl.OriginWidth > this.imageEl.OriginHeight){ + height = this.thumbEl.getWidth(); + this.baseScale = height / this.imageEl.OriginHeight; + + if(this.imageEl.OriginWidth * this.baseScale < this.thumbEl.getHeight()){ + width = this.thumbEl.getHeight(); + this.baseScale = width / this.imageEl.OriginWidth; + } + } + + return; + } + + width = this.thumbEl.getWidth(); + this.baseScale = width / this.imageEl.OriginWidth; + + if(this.imageEl.OriginHeight * this.baseScale < this.thumbEl.getHeight()){ + height = this.thumbEl.getHeight(); + this.baseScale = height / this.imageEl.OriginHeight; + } + + if(this.imageEl.OriginWidth > this.imageEl.OriginHeight){ + + height = this.thumbEl.getHeight(); + this.baseScale = height / this.imageEl.OriginHeight; + + if(this.imageEl.OriginWidth * this.baseScale < this.thumbEl.getWidth()){ + width = this.thumbEl.getWidth(); + this.baseScale = width / this.imageEl.OriginWidth; + } + + } + + return; + }, + + getScaleLevel : function() + { + return this.baseScale * Math.pow(1.1, this.scale); + }, + + onTouchStart : function(e) + { + if(!this.canvasLoaded){ + this.beforeSelectFile(e); + return; + } + + var touches = e.browserEvent.touches; + + if(!touches){ + return; + } + + if(touches.length == 1){ + this.onMouseDown(e); + return; + } + + if(touches.length != 2){ + return; + } + + var coords = []; + + for(var i = 0, finger; finger = touches[i]; i++){ + coords.push(finger.pageX, finger.pageY); + } + + var x = Math.pow(coords[0] - coords[2], 2); + var y = Math.pow(coords[1] - coords[3], 2); + + this.startDistance = Math.sqrt(x + y); + + this.startScale = this.scale; + + this.pinching = true; + this.dragable = false; + + }, + + onTouchMove : function(e) + { + if(!this.pinching && !this.dragable){ + return; + } + + var touches = e.browserEvent.touches; + + if(!touches){ + return; + } + + if(this.dragable){ + this.onMouseMove(e); + return; + } + + var coords = []; + + for(var i = 0, finger; finger = touches[i]; i++){ + coords.push(finger.pageX, finger.pageY); + } + + var x = Math.pow(coords[0] - coords[2], 2); + var y = Math.pow(coords[1] - coords[3], 2); + + this.endDistance = Math.sqrt(x + y); + + this.scale = this.startScale + Math.floor(Math.log(this.endDistance / this.startDistance) / Math.log(1.1)); + + if(!this.zoomable()){ + this.scale = this.startScale; + return; + } + + this.draw(); + + }, + + onTouchEnd : function(e) + { + this.pinching = false; + this.dragable = false; + + }, + + process : function(file, crop) + { + if(this.loadMask){ + this.maskEl.mask(this.loadingText); + } + + this.xhr = new XMLHttpRequest(); + + file.xhr = this.xhr; + + this.xhr.open(this.method, this.url, true); + + var headers = { + "Accept": "application/json", + "Cache-Control": "no-cache", + "X-Requested-With": "XMLHttpRequest" + }; + + for (var headerName in headers) { + var headerValue = headers[headerName]; + if (headerValue) { + this.xhr.setRequestHeader(headerName, headerValue); + } + } + + var _this = this; + + this.xhr.onload = function() + { + _this.xhrOnLoad(_this.xhr); + } + + this.xhr.onerror = function() + { + _this.xhrOnError(_this.xhr); + } + + var formData = new FormData(); + + formData.append('returnHTML', 'NO'); + + if(crop){ + formData.append('crop', crop); + } + + if(typeof(file) != 'undefined' && (typeof(file.id) == 'undefined' || file.id * 1 < 1)){ + formData.append(this.paramName, file, file.name); + } + + if(typeof(file.filename) != 'undefined'){ + formData.append('filename', file.filename); + } + + if(typeof(file.mimetype) != 'undefined'){ + formData.append('mimetype', file.mimetype); + } + + if(this.fireEvent('arrange', this, formData) != false){ + this.xhr.send(formData); + }; + }, + + xhrOnLoad : function(xhr) + { + if(this.loadMask){ + this.maskEl.unmask(); + } + + if (xhr.readyState !== 4) { + this.fireEvent('exception', this, xhr); + return; + } + + var response = Roo.decode(xhr.responseText); + + if(!response.success){ + this.fireEvent('exception', this, xhr); + return; + } + + var response = Roo.decode(xhr.responseText); + + this.fireEvent('upload', this, response); + + }, + + xhrOnError : function() + { + if(this.loadMask){ + this.maskEl.unmask(); + } + + Roo.log('xhr on error'); + + var response = Roo.decode(xhr.responseText); + + Roo.log(response); + + }, + + prepare : function(file) + { + if(this.loadMask){ + this.maskEl.mask(this.loadingText); + } + + this.file = false; + this.exif = {}; + + if(typeof(file) === 'string'){ + this.loadCanvas(file); + return; + } + + if(!file || !this.urlAPI){ + return; + } + + this.file = file; + this.cropType = file.type; + + var _this = this; + + if(this.fireEvent('prepare', this, this.file) != false){ + + var reader = new FileReader(); + + reader.onload = function (e) { + if (e.target.error) { + Roo.log(e.target.error); + return; + } + + var buffer = e.target.result, + dataView = new DataView(buffer), + offset = 2, + maxOffset = dataView.byteLength - 4, + markerBytes, + markerLength; + + if (dataView.getUint16(0) === 0xffd8) { + while (offset < maxOffset) { + markerBytes = dataView.getUint16(offset); + + if ((markerBytes >= 0xffe0 && markerBytes <= 0xffef) || markerBytes === 0xfffe) { + markerLength = dataView.getUint16(offset + 2) + 2; + if (offset + markerLength > dataView.byteLength) { + Roo.log('Invalid meta data: Invalid segment size.'); + break; + } + + if(markerBytes == 0xffe1){ + _this.parseExifData( + dataView, + offset, + markerLength + ); + } + + offset += markerLength; + + continue; + } + + break; + } + + } + + var url = _this.urlAPI.createObjectURL(_this.file); + + _this.loadCanvas(url); + + return; + } + + reader.readAsArrayBuffer(this.file); + + } + + }, + + parseExifData : function(dataView, offset, length) + { + var tiffOffset = offset + 10, + littleEndian, + dirOffset; + + if (dataView.getUint32(offset + 4) !== 0x45786966) { + // No Exif data, might be XMP data instead + return; + } + + // Check for the ASCII code for "Exif" (0x45786966): + if (dataView.getUint32(offset + 4) !== 0x45786966) { + // No Exif data, might be XMP data instead + return; + } + if (tiffOffset + 8 > dataView.byteLength) { + Roo.log('Invalid Exif data: Invalid segment size.'); + return; + } + // Check for the two null bytes: + if (dataView.getUint16(offset + 8) !== 0x0000) { + Roo.log('Invalid Exif data: Missing byte alignment offset.'); + return; + } + // Check the byte alignment: + switch (dataView.getUint16(tiffOffset)) { + case 0x4949: + littleEndian = true; + break; + case 0x4D4D: + littleEndian = false; + break; + default: + Roo.log('Invalid Exif data: Invalid byte alignment marker.'); + return; + } + // Check for the TIFF tag marker (0x002A): + if (dataView.getUint16(tiffOffset + 2, littleEndian) !== 0x002A) { + Roo.log('Invalid Exif data: Missing TIFF marker.'); + return; + } + // Retrieve the directory offset bytes, usually 0x00000008 or 8 decimal: + dirOffset = dataView.getUint32(tiffOffset + 4, littleEndian); + + this.parseExifTags( + dataView, + tiffOffset, + tiffOffset + dirOffset, + littleEndian + ); + }, + + parseExifTags : function(dataView, tiffOffset, dirOffset, littleEndian) + { + var tagsNumber, + dirEndOffset, + i; + if (dirOffset + 6 > dataView.byteLength) { + Roo.log('Invalid Exif data: Invalid directory offset.'); + return; + } + tagsNumber = dataView.getUint16(dirOffset, littleEndian); + dirEndOffset = dirOffset + 2 + 12 * tagsNumber; + if (dirEndOffset + 4 > dataView.byteLength) { + Roo.log('Invalid Exif data: Invalid directory size.'); + return; + } + for (i = 0; i < tagsNumber; i += 1) { + this.parseExifTag( + dataView, + tiffOffset, + dirOffset + 2 + 12 * i, // tag offset + littleEndian + ); + } + // Return the offset to the next directory: + return dataView.getUint32(dirEndOffset, littleEndian); + }, + + parseExifTag : function (dataView, tiffOffset, offset, littleEndian) + { + var tag = dataView.getUint16(offset, littleEndian); + + this.exif[tag] = this.getExifValue( + dataView, + tiffOffset, + offset, + dataView.getUint16(offset + 2, littleEndian), // tag type + dataView.getUint32(offset + 4, littleEndian), // tag length + littleEndian + ); + }, + + getExifValue : function (dataView, tiffOffset, offset, type, length, littleEndian) + { + var tagType = Roo.bootstrap.UploadCropbox.exifTagTypes[type], + tagSize, + dataOffset, + values, + i, + str, + c; + + if (!tagType) { + Roo.log('Invalid Exif data: Invalid tag type.'); + return; + } + + tagSize = tagType.size * length; + // Determine if the value is contained in the dataOffset bytes, + // or if the value at the dataOffset is a pointer to the actual data: + dataOffset = tagSize > 4 ? + tiffOffset + dataView.getUint32(offset + 8, littleEndian) : (offset + 8); + if (dataOffset + tagSize > dataView.byteLength) { + Roo.log('Invalid Exif data: Invalid data offset.'); + return; + } + if (length === 1) { + return tagType.getValue(dataView, dataOffset, littleEndian); + } + values = []; + for (i = 0; i < length; i += 1) { + values[i] = tagType.getValue(dataView, dataOffset + i * tagType.size, littleEndian); + } + + if (tagType.ascii) { + str = ''; + // Concatenate the chars: + for (i = 0; i < values.length; i += 1) { + c = values[i]; + // Ignore the terminating NULL byte(s): + if (c === '\u0000') { + break; + } + str += c; + } + return str; + } + return values; + } + +}); + +Roo.apply(Roo.bootstrap.UploadCropbox, { + tags : { + 'Orientation': 0x0112 + }, + + Orientation: { + 1: 0, //'top-left', +// 2: 'top-right', + 3: 180, //'bottom-right', +// 4: 'bottom-left', +// 5: 'left-top', + 6: 90, //'right-top', +// 7: 'right-bottom', + 8: 270 //'left-bottom' + }, + + exifTagTypes : { + // byte, 8-bit unsigned int: + 1: { + getValue: function (dataView, dataOffset) { + return dataView.getUint8(dataOffset); + }, + size: 1 + }, + // ascii, 8-bit byte: + 2: { + getValue: function (dataView, dataOffset) { + return String.fromCharCode(dataView.getUint8(dataOffset)); + }, + size: 1, + ascii: true + }, + // short, 16 bit int: + 3: { + getValue: function (dataView, dataOffset, littleEndian) { + return dataView.getUint16(dataOffset, littleEndian); + }, + size: 2 + }, + // long, 32 bit int: + 4: { + getValue: function (dataView, dataOffset, littleEndian) { + return dataView.getUint32(dataOffset, littleEndian); + }, + size: 4 + }, + // rational = two long values, first is numerator, second is denominator: + 5: { + getValue: function (dataView, dataOffset, littleEndian) { + return dataView.getUint32(dataOffset, littleEndian) / + dataView.getUint32(dataOffset + 4, littleEndian); + }, + size: 8 + }, + // slong, 32 bit signed int: + 9: { + getValue: function (dataView, dataOffset, littleEndian) { + return dataView.getInt32(dataOffset, littleEndian); + }, + size: 4 + }, + // srational, two slongs, first is numerator, second is denominator: + 10: { + getValue: function (dataView, dataOffset, littleEndian) { + return dataView.getInt32(dataOffset, littleEndian) / + dataView.getInt32(dataOffset + 4, littleEndian); + }, + size: 8 + } + }, + + footer : { + STANDARD : [ + { + tag : 'div', + cls : 'btn-group roo-upload-cropbox-rotate-left', + action : 'rotate-left', + cn : [ + { + tag : 'button', + cls : 'btn btn-default', + html : '<i class="fa fa-undo"></i>' + } + ] + }, + { + tag : 'div', + cls : 'btn-group roo-upload-cropbox-picture', + action : 'picture', + cn : [ + { + tag : 'button', + cls : 'btn btn-default', + html : '<i class="fa fa-picture-o"></i>' + } + ] + }, + { + tag : 'div', + cls : 'btn-group roo-upload-cropbox-rotate-right', + action : 'rotate-right', + cn : [ + { + tag : 'button', + cls : 'btn btn-default', + html : '<i class="fa fa-repeat"></i>' + } + ] + } + ], + DOCUMENT : [ + { + tag : 'div', + cls : 'btn-group roo-upload-cropbox-rotate-left', + action : 'rotate-left', + cn : [ + { + tag : 'button', + cls : 'btn btn-default', + html : '<i class="fa fa-undo"></i>' + } + ] + }, + { + tag : 'div', + cls : 'btn-group roo-upload-cropbox-download', + action : 'download', + cn : [ + { + tag : 'button', + cls : 'btn btn-default', + html : '<i class="fa fa-download"></i>' + } + ] + }, + { + tag : 'div', + cls : 'btn-group roo-upload-cropbox-crop', + action : 'crop', + cn : [ + { + tag : 'button', + cls : 'btn btn-default', + html : '<i class="fa fa-crop"></i>' + } + ] + }, + { + tag : 'div', + cls : 'btn-group roo-upload-cropbox-trash', + action : 'trash', + cn : [ + { + tag : 'button', + cls : 'btn btn-default', + html : '<i class="fa fa-trash"></i>' + } + ] + }, + { + tag : 'div', + cls : 'btn-group roo-upload-cropbox-rotate-right', + action : 'rotate-right', + cn : [ + { + tag : 'button', + cls : 'btn btn-default', + html : '<i class="fa fa-repeat"></i>' + } + ] + } + ], + ROTATOR : [ + { + tag : 'div', + cls : 'btn-group roo-upload-cropbox-rotate-left', + action : 'rotate-left', + cn : [ + { + tag : 'button', + cls : 'btn btn-default', + html : '<i class="fa fa-undo"></i>' + } + ] + }, + { + tag : 'div', + cls : 'btn-group roo-upload-cropbox-rotate-right', + action : 'rotate-right', + cn : [ + { + tag : 'button', + cls : 'btn btn-default', + html : '<i class="fa fa-repeat"></i>' + } + ] + } + ] + } +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_dash_NumberBox.js.html b/docs2/src/Roo_bootstrap_dash_NumberBox.js.html new file mode 100644 index 0000000000..2ef091c2cd --- /dev/null +++ b/docs2/src/Roo_bootstrap_dash_NumberBox.js.html @@ -0,0 +1,128 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/dash/NumberBox.js/* + * - LGPL + * + * numberBox + * + */ +Roo.bootstrap.dash = Roo.bootstrap.dash || {}; + +/** + * @class Roo.bootstrap.dash.NumberBox + * @extends Roo.bootstrap.Component + * Bootstrap NumberBox class + * @cfg {String} headline Box headline + * @cfg {String} content Box content + * @cfg {String} icon Box icon + * @cfg {String} footer Footer text + * @cfg {String} fhref Footer href + * + * @constructor + * Create a new NumberBox + * @param {Object} config The config object + */ + + +Roo.bootstrap.dash.NumberBox = function(config){ + Roo.bootstrap.dash.NumberBox.superclass.constructor.call(this, config); + +}; + +Roo.extend(Roo.bootstrap.dash.NumberBox, Roo.bootstrap.Component, { + + headline : '', + content : '', + icon : '', + footer : '', + fhref : '', + ficon : '', + + getAutoCreate : function(){ + + var cfg = { + tag : 'div', + cls : 'small-box ', + cn : [ + { + tag : 'div', + cls : 'inner', + cn :[ + { + tag : 'h3', + cls : 'roo-headline', + html : this.headline + }, + { + tag : 'p', + cls : 'roo-content', + html : this.content + } + ] + } + ] + }; + + if(this.icon){ + cfg.cn.push({ + tag : 'div', + cls : 'icon', + cn :[ + { + tag : 'i', + cls : 'ion ' + this.icon + } + ] + }); + } + + if(this.footer){ + var footer = { + tag : 'a', + cls : 'small-box-footer', + href : this.fhref || '#', + html : this.footer + }; + + cfg.cn.push(footer); + + } + + return cfg; + }, + + onRender : function(ct,position){ + Roo.bootstrap.dash.NumberBox.superclass.onRender.call(this,ct,position); + + + + + }, + + setHeadline: function (value) + { + this.el.select('.roo-headline',true).first().dom.innerHTML = value; + }, + + setFooter: function (value, href) + { + this.el.select('a.small-box-footer',true).first().dom.innerHTML = value; + + if(href){ + this.el.select('a.small-box-footer',true).first().attr('href', href); + } + + }, + + setContent: function (value) + { + this.el.select('.roo-content',true).first().dom.innerHTML = value; + }, + + initEvents: function() + { + + } + +}); + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_dash_TabBox.js.html b/docs2/src/Roo_bootstrap_dash_TabBox.js.html new file mode 100644 index 0000000000..2e89fb58f0 --- /dev/null +++ b/docs2/src/Roo_bootstrap_dash_TabBox.js.html @@ -0,0 +1,202 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/dash/TabBox.js/* + * - LGPL + * + * TabBox + * + */ +Roo.bootstrap.dash = Roo.bootstrap.dash || {}; + +/** + * @class Roo.bootstrap.dash.TabBox + * @extends Roo.bootstrap.Component + * Bootstrap TabBox class + * @cfg {String} title Title of the TabBox + * @cfg {String} icon Icon of the TabBox + * @cfg {Boolean} showtabs (true|false) show the tabs default true + * @cfg {Boolean} tabScrollable (true|false) tab scrollable when mobile view default false + * + * @constructor + * Create a new TabBox + * @param {Object} config The config object + */ + + +Roo.bootstrap.dash.TabBox = function(config){ + Roo.bootstrap.dash.TabBox.superclass.constructor.call(this, config); + this.addEvents({ + // raw events + /** + * @event addpane + * When a pane is added + * @param {Roo.bootstrap.dash.TabPane} pane + */ + "addpane" : true, + /** + * @event activatepane + * When a pane is activated + * @param {Roo.bootstrap.dash.TabPane} pane + */ + "activatepane" : true + + + }); + + this.panes = []; +}; + +Roo.extend(Roo.bootstrap.dash.TabBox, Roo.bootstrap.Component, { + + title : '', + icon : false, + showtabs : true, + tabScrollable : false, + + getChildContainer : function() + { + return this.el.select('.tab-content', true).first(); + }, + + getAutoCreate : function(){ + + var header = { + tag: 'li', + cls: 'pull-left header', + html: this.title, + cn : [] + }; + + if(this.icon){ + header.cn.push({ + tag: 'i', + cls: 'fa ' + this.icon + }); + } + + var h = { + tag: 'ul', + cls: 'nav nav-tabs pull-right', + cn: [ + header + ] + }; + + if(this.tabScrollable){ + h = { + tag: 'div', + cls: 'tab-header', + cn: [ + { + tag: 'ul', + cls: 'nav nav-tabs pull-right', + cn: [ + header + ] + } + ] + }; + } + + var cfg = { + tag: 'div', + cls: 'nav-tabs-custom', + cn: [ + h, + { + tag: 'div', + cls: 'tab-content no-padding', + cn: [] + } + ] + }; + + return cfg; + }, + initEvents : function() + { + //Roo.log('add add pane handler'); + this.on('addpane', this.onAddPane, this); + }, + /** + * Updates the box title + * @param {String} html to set the title to. + */ + setTitle : function(value) + { + this.el.select('.nav-tabs .header', true).first().dom.innerHTML = value; + }, + onAddPane : function(pane) + { + this.panes.push(pane); + //Roo.log('addpane'); + //Roo.log(pane); + // tabs are rendere left to right.. + if(!this.showtabs){ + return; + } + + var ctr = this.el.select('.nav-tabs', true).first(); + + + var existing = ctr.select('.nav-tab',true); + var qty = existing.getCount();; + + + var tab = ctr.createChild({ + tag : 'li', + cls : 'nav-tab' + (qty ? '' : ' active'), + cn : [ + { + tag : 'a', + href:'#', + html : pane.title + } + ] + }, qty ? existing.first().dom : ctr.select('.header', true).first().dom ); + pane.tab = tab; + + tab.on('click', this.onTabClick.createDelegate(this, [pane], true)); + if (!qty) { + pane.el.addClass('active'); + } + + + }, + onTabClick : function(ev,un,ob,pane) + { + //Roo.log('tab - prev default'); + ev.preventDefault(); + + + this.el.select('.nav-tabs li.nav-tab', true).removeClass('active'); + pane.tab.addClass('active'); + //Roo.log(pane.title); + this.getChildContainer().select('.tab-pane',true).removeClass('active'); + // technically we should have a deactivate event.. but maybe add later. + // and it should not de-activate the selected tab... + this.fireEvent('activatepane', pane); + pane.el.addClass('active'); + pane.fireEvent('activate'); + + + }, + + getActivePane : function() + { + var r = false; + Roo.each(this.panes, function(p) { + if(p.el.hasClass('active')){ + r = p; + return false; + } + + return; + }); + + return r; + } + + +}); + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_dash_TabPane.js.html b/docs2/src/Roo_bootstrap_dash_TabPane.js.html new file mode 100644 index 0000000000..60780b6b10 --- /dev/null +++ b/docs2/src/Roo_bootstrap_dash_TabPane.js.html @@ -0,0 +1,84 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/dash/TabPane.js/* + * - LGPL + * + * Tab pane + * + */ +Roo.bootstrap.dash = Roo.bootstrap.dash || {}; +/** + * @class Roo.bootstrap.TabPane + * @extends Roo.bootstrap.Component + * Bootstrap TabPane class + * @cfg {Boolean} active (false | true) Default false + * @cfg {String} title title of panel + + * + * @constructor + * Create a new TabPane + * @param {Object} config The config object + */ + +Roo.bootstrap.dash.TabPane = function(config){ + Roo.bootstrap.dash.TabPane.superclass.constructor.call(this, config); + + this.addEvents({ + // raw events + /** + * @event activate + * When a pane is activated + * @param {Roo.bootstrap.dash.TabPane} pane + */ + "activate" : true + + }); +}; + +Roo.extend(Roo.bootstrap.dash.TabPane, Roo.bootstrap.Component, { + + active : false, + title : '', + + // the tabBox that this is attached to. + tab : false, + + getAutoCreate : function() + { + var cfg = { + tag: 'div', + cls: 'tab-pane' + }; + + if(this.active){ + cfg.cls += ' active'; + } + + return cfg; + }, + initEvents : function() + { + //Roo.log('trigger add pane handler'); + this.parent().fireEvent('addpane', this) + }, + + /** + * Updates the tab title + * @param {String} html to set the title to. + */ + setTitle: function(str) + { + if (!this.tab) { + return; + } + this.title = str; + this.tab.select('a', true).first().dom.innerHTML = str; + + } + + + +}); + + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_htmleditor_ToolbarStandard.js.html b/docs2/src/Roo_bootstrap_htmleditor_ToolbarStandard.js.html new file mode 100644 index 0000000000..092ceb386d --- /dev/null +++ b/docs2/src/Roo_bootstrap_htmleditor_ToolbarStandard.js.html @@ -0,0 +1,286 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/htmleditor/ToolbarStandard.js +Roo.namespace('Roo.bootstrap.htmleditor'); +/** + * @class Roo.bootstrap.HtmlEditorToolbar1 + * Basic Toolbar + * + * Usage: + * + new Roo.bootstrap.HtmlEditor({ + .... + toolbars : [ + new Roo.bootstrap.HtmlEditorToolbar1({ + disable : { fonts: 1 , format: 1, ..., ... , ...], + btns : [ .... ] + }) + } + + * + * @cfg {Object} disable List of elements to disable.. + * @cfg {Array} btns List of additional buttons. + * + * + * NEEDS Extra CSS? + * .x-html-editor-tb .x-edit-none .x-btn-text { background: none; } + */ + +Roo.bootstrap.htmleditor.ToolbarStandard = function(config) +{ + + Roo.apply(this, config); + + // default disabled, based on 'good practice'.. + this.disable = this.disable || {}; + Roo.applyIf(this.disable, { + fontSize : true, + colors : true, + specialElements : true + }); + Roo.bootstrap.htmleditor.ToolbarStandard.superclass.constructor.call(this, config); + + this.editor = config.editor; + this.editorcore = config.editor.editorcore; + + this.buttons = new Roo.util.MixedCollection(false, function(o) { return o.cmd; }); + + //Roo.form.HtmlEditorToolbar1.superclass.constructor.call(this, editor.wrap.dom.firstChild, [], config); + // dont call parent... till later. +} +Roo.extend(Roo.bootstrap.htmleditor.ToolbarStandard, Roo.bootstrap.NavSimplebar, { + + bar : true, + + editor : false, + editorcore : false, + + + formats : [ + "p" , + "h1","h2","h3","h4","h5","h6", + "pre", "code", + "abbr", "acronym", "address", "cite", "samp", "var", + 'div','span' + ], + + onRender : function(ct, position) + { + // Roo.log("Call onRender: " + this.xtype); + + Roo.bootstrap.htmleditor.ToolbarStandard.superclass.onRender.call(this, ct, position); + Roo.log(this.el); + this.el.dom.style.marginBottom = '0'; + var _this = this; + var editorcore = this.editorcore; + var editor= this.editor; + + var children = []; + var btn = function(id,cmd , toggle, handler, html){ + + var event = toggle ? 'toggle' : 'click'; + + var a = { + size : 'sm', + xtype: 'Button', + xns: Roo.bootstrap, + //glyphicon : id, + fa: id, + cmd : id || cmd, + enableToggle:toggle !== false, + html : html || '', + pressed : toggle ? false : null, + listeners : {} + }; + a.listeners[toggle ? 'toggle' : 'click'] = function() { + handler ? handler.call(_this,this) :_this.onBtnClick.call(_this, cmd || id); + }; + children.push(a); + return a; + } + + // var cb_box = function... + + var style = { + xtype: 'Button', + size : 'sm', + xns: Roo.bootstrap, + fa : 'font', + //html : 'submit' + menu : { + xtype: 'Menu', + xns: Roo.bootstrap, + items: [] + } + }; + Roo.each(this.formats, function(f) { + style.menu.items.push({ + xtype :'MenuItem', + xns: Roo.bootstrap, + html : '<'+ f+' style="margin:2px">'+f +'</'+ f+'>', + tagname : f, + listeners : { + click : function() + { + editorcore.insertTag(this.tagname); + editor.focus(); + } + } + + }); + }); + children.push(style); + + btn('bold',false,true); + btn('italic',false,true); + btn('align-left', 'justifyleft',true); + btn('align-center', 'justifycenter',true); + btn('align-right' , 'justifyright',true); + btn('link', false, false, function(btn) { + //Roo.log("create link?"); + var url = prompt(this.createLinkText, this.defaultLinkValue); + if(url && url != 'http:/'+'/'){ + this.editorcore.relayCmd('createlink', url); + } + }), + btn('list','insertunorderedlist',true); + btn('pencil', false,true, function(btn){ + Roo.log(this); + this.toggleSourceEdit(btn.pressed); + }); + + if (this.editor.btns.length > 0) { + for (var i = 0; i<this.editor.btns.length; i++) { + children.push(this.editor.btns[i]); + } + } + + /* + var cog = { + xtype: 'Button', + size : 'sm', + xns: Roo.bootstrap, + glyphicon : 'cog', + //html : 'submit' + menu : { + xtype: 'Menu', + xns: Roo.bootstrap, + items: [] + } + }; + + cog.menu.items.push({ + xtype :'MenuItem', + xns: Roo.bootstrap, + html : Clean styles, + tagname : f, + listeners : { + click : function() + { + editorcore.insertTag(this.tagname); + editor.focus(); + } + } + + }); + */ + + + this.xtype = 'NavSimplebar'; + + for(var i=0;i< children.length;i++) { + + this.buttons.add(this.addxtypeChild(children[i])); + + } + + editor.on('editorevent', this.updateToolbar, this); + }, + onBtnClick : function(id) + { + this.editorcore.relayCmd(id); + this.editorcore.focus(); + }, + + /** + * Protected method that will not generally be called directly. It triggers + * a toolbar update by reading the markup state of the current selection in the editor. + */ + updateToolbar: function(){ + + if(!this.editorcore.activated){ + this.editor.onFirstFocus(); // is this neeed? + return; + } + + var btns = this.buttons; + var doc = this.editorcore.doc; + btns.get('bold').setActive(doc.queryCommandState('bold')); + btns.get('italic').setActive(doc.queryCommandState('italic')); + //btns.get('underline').setActive(doc.queryCommandState('underline')); + + btns.get('align-left').setActive(doc.queryCommandState('justifyleft')); + btns.get('align-center').setActive(doc.queryCommandState('justifycenter')); + btns.get('align-right').setActive(doc.queryCommandState('justifyright')); + + //btns[frameId + '-insertorderedlist').setActive(doc.queryCommandState('insertorderedlist')); + btns.get('list').setActive(doc.queryCommandState('insertunorderedlist')); + /* + + var ans = this.editorcore.getAllAncestors(); + if (this.formatCombo) { + + + var store = this.formatCombo.store; + this.formatCombo.setValue(""); + for (var i =0; i < ans.length;i++) { + if (ans[i] && store.query('tag',ans[i].tagName.toLowerCase(), false).length) { + // select it.. + this.formatCombo.setValue(ans[i].tagName.toLowerCase()); + break; + } + } + } + + + + // hides menus... - so this cant be on a menu... + Roo.bootstrap.MenuMgr.hideAll(); + */ + Roo.bootstrap.MenuMgr.hideAll(); + //this.editorsyncValue(); + }, + onFirstFocus: function() { + this.buttons.each(function(item){ + item.enable(); + }); + }, + toggleSourceEdit : function(sourceEditMode){ + + + if(sourceEditMode){ + Roo.log("disabling buttons"); + this.buttons.each( function(item){ + if(item.cmd != 'pencil'){ + item.disable(); + } + }); + + }else{ + Roo.log("enabling buttons"); + if(this.editorcore.initialized){ + this.buttons.each( function(item){ + item.enable(); + }); + } + + } + Roo.log("calling toggole on editor"); + // tell the editor that it's been pressed.. + this.editor.toggleSourceEdit(sourceEditMode); + + } +}); + + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_layout_Basic.js.html b/docs2/src/Roo_bootstrap_layout_Basic.js.html new file mode 100644 index 0000000000..351f2031e4 --- /dev/null +++ b/docs2/src/Roo_bootstrap_layout_Basic.js.html @@ -0,0 +1,327 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/layout/Basic.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.bootstrap.layout.Basic + * @extends Roo.util.Observable + * This class represents a lightweight region in a layout manager. This region does not move dom nodes + * and does not have a titlebar, tabs or any other features. All it does is size and position + * panels. To create a BasicLayoutRegion, add lightweight:true or basic:true to your regions config. + * @cfg {Roo.bootstrap.layout.Manager} mgr The manager + * @cfg {string} region the region that it inhabits.. + * @cfg {bool} skipConfig skip config? + * + + */ +Roo.bootstrap.layout.Basic = function(config){ + + this.mgr = config.mgr; + + this.position = config.region; + + var skipConfig = config.skipConfig; + + this.events = { + /** + * @scope Roo.BasicLayoutRegion + */ + + /** + * @event beforeremove + * Fires before a panel is removed (or closed). To cancel the removal set "e.cancel = true" on the event argument. + * @param {Roo.LayoutRegion} this + * @param {Roo.ContentPanel} panel The panel + * @param {Object} e The cancel event object + */ + "beforeremove" : true, + /** + * @event invalidated + * Fires when the layout for this region is changed. + * @param {Roo.LayoutRegion} this + */ + "invalidated" : true, + /** + * @event visibilitychange + * Fires when this region is shown or hidden + * @param {Roo.LayoutRegion} this + * @param {Boolean} visibility true or false + */ + "visibilitychange" : true, + /** + * @event paneladded + * Fires when a panel is added. + * @param {Roo.LayoutRegion} this + * @param {Roo.ContentPanel} panel The panel + */ + "paneladded" : true, + /** + * @event panelremoved + * Fires when a panel is removed. + * @param {Roo.LayoutRegion} this + * @param {Roo.ContentPanel} panel The panel + */ + "panelremoved" : true, + /** + * @event beforecollapse + * Fires when this region before collapse. + * @param {Roo.LayoutRegion} this + */ + "beforecollapse" : true, + /** + * @event collapsed + * Fires when this region is collapsed. + * @param {Roo.LayoutRegion} this + */ + "collapsed" : true, + /** + * @event expanded + * Fires when this region is expanded. + * @param {Roo.LayoutRegion} this + */ + "expanded" : true, + /** + * @event slideshow + * Fires when this region is slid into view. + * @param {Roo.LayoutRegion} this + */ + "slideshow" : true, + /** + * @event slidehide + * Fires when this region slides out of view. + * @param {Roo.LayoutRegion} this + */ + "slidehide" : true, + /** + * @event panelactivated + * Fires when a panel is activated. + * @param {Roo.LayoutRegion} this + * @param {Roo.ContentPanel} panel The activated panel + */ + "panelactivated" : true, + /** + * @event resized + * Fires when the user resizes this region. + * @param {Roo.LayoutRegion} this + * @param {Number} newSize The new size (width for east/west, height for north/south) + */ + "resized" : true + }; + /** A collection of panels in this region. @type Roo.util.MixedCollection */ + this.panels = new Roo.util.MixedCollection(); + this.panels.getKey = this.getPanelId.createDelegate(this); + this.box = null; + this.activePanel = null; + // ensure listeners are added... + + if (config.listeners || config.events) { + Roo.bootstrap.layout.Basic.superclass.constructor.call(this, { + listeners : config.listeners || {}, + events : config.events || {} + }); + } + + if(skipConfig !== true){ + this.applyConfig(config); + } +}; + +Roo.extend(Roo.bootstrap.layout.Basic, Roo.util.Observable, +{ + getPanelId : function(p){ + return p.getId(); + }, + + applyConfig : function(config){ + this.margins = config.margins || this.margins || {top: 0, left: 0, right:0, bottom: 0}; + this.config = config; + + }, + + /** + * Resizes the region to the specified size. For vertical regions (west, east) this adjusts + * the width, for horizontal (north, south) the height. + * @param {Number} newSize The new width or height + */ + resizeTo : function(newSize){ + var el = this.el ? this.el : + (this.activePanel ? this.activePanel.getEl() : null); + if(el){ + switch(this.position){ + case "east": + case "west": + el.setWidth(newSize); + this.fireEvent("resized", this, newSize); + break; + case "north": + case "south": + el.setHeight(newSize); + this.fireEvent("resized", this, newSize); + break; + } + } + }, + + getBox : function(){ + return this.activePanel ? this.activePanel.getEl().getBox(false, true) : null; + }, + + getMargins : function(){ + return this.margins; + }, + + updateBox : function(box){ + this.box = box; + var el = this.activePanel.getEl(); + el.dom.style.left = box.x + "px"; + el.dom.style.top = box.y + "px"; + this.activePanel.setSize(box.width, box.height); + }, + + /** + * Returns the container element for this region. + * @return {Roo.Element} + */ + getEl : function(){ + return this.activePanel; + }, + + /** + * Returns true if this region is currently visible. + * @return {Boolean} + */ + isVisible : function(){ + return this.activePanel ? true : false; + }, + + setActivePanel : function(panel){ + panel = this.getPanel(panel); + if(this.activePanel && this.activePanel != panel){ + this.activePanel.setActiveState(false); + this.activePanel.getEl().setLeftTop(-10000,-10000); + } + this.activePanel = panel; + panel.setActiveState(true); + if(this.box){ + panel.setSize(this.box.width, this.box.height); + } + this.fireEvent("panelactivated", this, panel); + this.fireEvent("invalidated"); + }, + + /** + * Show the specified panel. + * @param {Number/String/ContentPanel} panelId The panels index, id or the panel itself + * @return {Roo.ContentPanel} The shown panel or null + */ + showPanel : function(panel){ + panel = this.getPanel(panel); + if(panel){ + this.setActivePanel(panel); + } + return panel; + }, + + /** + * Get the active panel for this region. + * @return {Roo.ContentPanel} The active panel or null + */ + getActivePanel : function(){ + return this.activePanel; + }, + + /** + * Add the passed ContentPanel(s) + * @param {ContentPanel...} panel The ContentPanel(s) to add (you can pass more than one) + * @return {Roo.ContentPanel} The panel added (if only one was added) + */ + add : function(panel){ + if(arguments.length > 1){ + for(var i = 0, len = arguments.length; i < len; i++) { + this.add(arguments[i]); + } + return null; + } + if(this.hasPanel(panel)){ + this.showPanel(panel); + return panel; + } + var el = panel.getEl(); + if(el.dom.parentNode != this.mgr.el.dom){ + this.mgr.el.dom.appendChild(el.dom); + } + if(panel.setRegion){ + panel.setRegion(this); + } + this.panels.add(panel); + el.setStyle("position", "absolute"); + if(!panel.background){ + this.setActivePanel(panel); + if(this.config.initialSize && this.panels.getCount()==1){ + this.resizeTo(this.config.initialSize); + } + } + this.fireEvent("paneladded", this, panel); + return panel; + }, + + /** + * Returns true if the panel is in this region. + * @param {Number/String/ContentPanel} panel The panels index, id or the panel itself + * @return {Boolean} + */ + hasPanel : function(panel){ + if(typeof panel == "object"){ // must be panel obj + panel = panel.getId(); + } + return this.getPanel(panel) ? true : false; + }, + + /** + * Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed. + * @param {Number/String/ContentPanel} panel The panels index, id or the panel itself + * @param {Boolean} preservePanel Overrides the config preservePanel option + * @return {Roo.ContentPanel} The panel that was removed + */ + remove : function(panel, preservePanel){ + panel = this.getPanel(panel); + if(!panel){ + return null; + } + var e = {}; + this.fireEvent("beforeremove", this, panel, e); + if(e.cancel === true){ + return null; + } + var panelId = panel.getId(); + this.panels.removeKey(panelId); + return panel; + }, + + /** + * Returns the panel specified or null if it's not in this region. + * @param {Number/String/ContentPanel} panel The panels index, id or the panel itself + * @return {Roo.ContentPanel} + */ + getPanel : function(id){ + if(typeof id == "object"){ // must be panel obj + return id; + } + return this.panels.get(id); + }, + + /** + * Returns this regions position (north/south/east/west/center). + * @return {String} + */ + getPosition: function(){ + return this.position; + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_layout_Border.js.html b/docs2/src/Roo_bootstrap_layout_Border.js.html new file mode 100644 index 0000000000..d70b9bec50 --- /dev/null +++ b/docs2/src/Roo_bootstrap_layout_Border.js.html @@ -0,0 +1,480 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/layout/Border.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.bootstrap.layout.Border + * @extends Roo.bootstrap.layout.Manager + * This class represents a common layout manager used in desktop applications. For screenshots and more details, + * please see: examples/bootstrap/nested.html<br><br> + +<b>The container the layout is rendered into can be either the body element or any other element. +If it is not the body element, the container needs to either be an absolute positioned element, +or you will need to add "position:relative" to the css of the container. You will also need to specify +the container size if it is not the body element.</b> + +* @constructor +* Create a new Border +* @param {Object} config Configuration options + */ +Roo.bootstrap.layout.Border = function(config){ + config = config || {}; + Roo.bootstrap.layout.Border.superclass.constructor.call(this, config); + + + + Roo.each(Roo.bootstrap.layout.Border.regions, function(region) { + if(config[region]){ + config[region].region = region; + this.addRegion(config[region]); + } + },this); + +}; + +Roo.bootstrap.layout.Border.regions = ["north","south","east","west","center"]; + +Roo.extend(Roo.bootstrap.layout.Border, Roo.bootstrap.layout.Manager, { + + parent : false, // this might point to a 'nest' or a ??? + + /** + * Creates and adds a new region if it doesn't already exist. + * @param {String} target The target region key (north, south, east, west or center). + * @param {Object} config The regions config object + * @return {BorderLayoutRegion} The new region + */ + addRegion : function(config) + { + if(!this.regions[config.region]){ + var r = this.factory(config); + this.bindRegion(r); + } + return this.regions[config.region]; + }, + + // private (kinda) + bindRegion : function(r){ + this.regions[r.config.region] = r; + + r.on("visibilitychange", this.layout, this); + r.on("paneladded", this.layout, this); + r.on("panelremoved", this.layout, this); + r.on("invalidated", this.layout, this); + r.on("resized", this.onRegionResized, this); + r.on("collapsed", this.onRegionCollapsed, this); + r.on("expanded", this.onRegionExpanded, this); + }, + + /** + * Performs a layout update. + */ + layout : function() + { + if(this.updating) { + return; + } + + // render all the rebions if they have not been done alreayd? + Roo.each(Roo.bootstrap.layout.Border.regions, function(region) { + if(this.regions[region] && !this.regions[region].bodyEl){ + this.regions[region].onRender(this.el) + } + },this); + + var size = this.getViewSize(); + var w = size.width; + var h = size.height; + var centerW = w; + var centerH = h; + var centerY = 0; + var centerX = 0; + //var x = 0, y = 0; + + var rs = this.regions; + var north = rs["north"]; + var south = rs["south"]; + var west = rs["west"]; + var east = rs["east"]; + var center = rs["center"]; + //if(this.hideOnLayout){ // not supported anymore + //c.el.setStyle("display", "none"); + //} + if(north && north.isVisible()){ + var b = north.getBox(); + var m = north.getMargins(); + b.width = w - (m.left+m.right); + b.x = m.left; + b.y = m.top; + centerY = b.height + b.y + m.bottom; + centerH -= centerY; + north.updateBox(this.safeBox(b)); + } + if(south && south.isVisible()){ + var b = south.getBox(); + var m = south.getMargins(); + b.width = w - (m.left+m.right); + b.x = m.left; + var totalHeight = (b.height + m.top + m.bottom); + b.y = h - totalHeight + m.top; + centerH -= totalHeight; + south.updateBox(this.safeBox(b)); + } + if(west && west.isVisible()){ + var b = west.getBox(); + var m = west.getMargins(); + b.height = centerH - (m.top+m.bottom); + b.x = m.left; + b.y = centerY + m.top; + var totalWidth = (b.width + m.left + m.right); + centerX += totalWidth; + centerW -= totalWidth; + west.updateBox(this.safeBox(b)); + } + if(east && east.isVisible()){ + var b = east.getBox(); + var m = east.getMargins(); + b.height = centerH - (m.top+m.bottom); + var totalWidth = (b.width + m.left + m.right); + b.x = w - totalWidth + m.left; + b.y = centerY + m.top; + centerW -= totalWidth; + east.updateBox(this.safeBox(b)); + } + if(center){ + var m = center.getMargins(); + var centerBox = { + x: centerX + m.left, + y: centerY + m.top, + width: centerW - (m.left+m.right), + height: centerH - (m.top+m.bottom) + }; + //if(this.hideOnLayout){ + //center.el.setStyle("display", "block"); + //} + center.updateBox(this.safeBox(centerBox)); + } + this.el.repaint(); + this.fireEvent("layout", this); + }, + + // private + safeBox : function(box){ + box.width = Math.max(0, box.width); + box.height = Math.max(0, box.height); + return box; + }, + + /** + * Adds a ContentPanel (or subclass) to this layout. + * @param {String} target The target region key (north, south, east, west or center). + * @param {Roo.ContentPanel} panel The panel to add + * @return {Roo.ContentPanel} The added panel + */ + add : function(target, panel){ + + target = target.toLowerCase(); + return this.regions[target].add(panel); + }, + + /** + * Remove a ContentPanel (or subclass) to this layout. + * @param {String} target The target region key (north, south, east, west or center). + * @param {Number/String/Roo.ContentPanel} panel The index, id or panel to remove + * @return {Roo.ContentPanel} The removed panel + */ + remove : function(target, panel){ + target = target.toLowerCase(); + return this.regions[target].remove(panel); + }, + + /** + * Searches all regions for a panel with the specified id + * @param {String} panelId + * @return {Roo.ContentPanel} The panel or null if it wasn't found + */ + findPanel : function(panelId){ + var rs = this.regions; + for(var target in rs){ + if(typeof rs[target] != "function"){ + var p = rs[target].getPanel(panelId); + if(p){ + return p; + } + } + } + return null; + }, + + /** + * Searches all regions for a panel with the specified id and activates (shows) it. + * @param {String/ContentPanel} panelId The panels id or the panel itself + * @return {Roo.ContentPanel} The shown panel or null + */ + showPanel : function(panelId) { + var rs = this.regions; + for(var target in rs){ + var r = rs[target]; + if(typeof r != "function"){ + if(r.hasPanel(panelId)){ + return r.showPanel(panelId); + } + } + } + return null; + }, + + /** + * Restores this layout's state using Roo.state.Manager or the state provided by the passed provider. + * @param {Roo.state.Provider} provider (optional) An alternate state provider + */ + /* + restoreState : function(provider){ + if(!provider){ + provider = Roo.state.Manager; + } + var sm = new Roo.LayoutStateManager(); + sm.init(this, provider); + }, +*/ + + + /** + * Adds a xtype elements to the layout. + * <pre><code> + +layout.addxtype({ + xtype : 'ContentPanel', + region: 'west', + items: [ .... ] + } +); + +layout.addxtype({ + xtype : 'NestedLayoutPanel', + region: 'west', + layout: { + center: { }, + west: { } + }, + items : [ ... list of content panels or nested layout panels.. ] + } +); +</code></pre> + * @param {Object} cfg Xtype definition of item to add. + */ + addxtype : function(cfg) + { + // basically accepts a pannel... + // can accept a layout region..!?!? + //Roo.log('Roo.BorderLayout add ' + cfg.xtype) + + + // theory? children can only be panels?? + + //if (!cfg.xtype.match(/Panel$/)) { + // return false; + //} + var ret = false; + + if (typeof(cfg.region) == 'undefined') { + Roo.log("Failed to add Panel, region was not set"); + Roo.log(cfg); + return false; + } + var region = cfg.region; + delete cfg.region; + + + var xitems = []; + if (cfg.items) { + xitems = cfg.items; + delete cfg.items; + } + var nb = false; + + if ( region == 'center') { + Roo.log("Center: " + cfg.title); + } + + + switch(cfg.xtype) + { + case 'Content': // ContentPanel (el, cfg) + case 'Scroll': // ContentPanel (el, cfg) + case 'View': + cfg.autoCreate = cfg.autoCreate || true; + ret = new cfg.xns[cfg.xtype](cfg); // new panel!!!!! + //} else { + // var el = this.el.createChild(); + // ret = new Roo[cfg.xtype](el, cfg); // new panel!!!!! + //} + + this.add(region, ret); + break; + + /* + case 'TreePanel': // our new panel! + cfg.el = this.el.createChild(); + ret = new Roo[cfg.xtype](cfg); // new panel!!!!! + this.add(region, ret); + break; + */ + + case 'Nest': + // create a new Layout (which is a Border Layout... + + var clayout = cfg.layout; + clayout.el = this.el.createChild(); + clayout.items = clayout.items || []; + + delete cfg.layout; + + // replace this exitems with the clayout ones.. + xitems = clayout.items; + + // force background off if it's in center... + if (region == 'center' && this.active && this.getRegion('center').panels.length < 1) { + cfg.background = false; + } + cfg.layout = new Roo.bootstrap.layout.Border(clayout); + + + ret = new cfg.xns[cfg.xtype](cfg); // new panel!!!!! + //console.log('adding nested layout panel ' + cfg.toSource()); + this.add(region, ret); + nb = {}; /// find first... + break; + + case 'Grid': + + // needs grid and region + + //var el = this.getRegion(region).el.createChild(); + /* + *var el = this.el.createChild(); + // create the grid first... + cfg.grid.container = el; + cfg.grid = new cfg.grid.xns[cfg.grid.xtype](cfg.grid); + */ + + if (region == 'center' && this.active ) { + cfg.background = false; + } + + ret = new cfg.xns[cfg.xtype](cfg); // new panel!!!!! + + this.add(region, ret); + /* + if (cfg.background) { + // render grid on panel activation (if panel background) + ret.on('activate', function(gp) { + if (!gp.grid.rendered) { + // gp.grid.render(el); + } + }); + } else { + // cfg.grid.render(el); + } + */ + break; + + + case 'Border': // it can get called on it'self... - might need to check if this is fixed? + // it was the old xcomponent building that caused this before. + // espeically if border is the top element in the tree. + ret = this; + break; + + + + + + default: + /* + if (typeof(Roo[cfg.xtype]) != 'undefined') { + + ret = new Roo[cfg.xtype](cfg); // new panel!!!!! + this.add(region, ret); + } else { + */ + Roo.log(cfg); + throw "Can not add '" + cfg.xtype + "' to Border"; + return null; + + + + } + this.beginUpdate(); + // add children.. + var region = ''; + var abn = {}; + Roo.each(xitems, function(i) { + region = nb && i.region ? i.region : false; + + var add = ret.addxtype(i); + + if (region) { + nb[region] = nb[region] == undefined ? 0 : nb[region]+1; + if (!i.background) { + abn[region] = nb[region] ; + } + } + + }); + this.endUpdate(); + + // make the last non-background panel active.. + //if (nb) { Roo.log(abn); } + if (nb) { + + for(var r in abn) { + region = this.getRegion(r); + if (region) { + // tried using nb[r], but it does not work.. + + region.showPanel(abn[r]); + + } + } + } + return ret; + + }, + + +// private + factory : function(cfg) + { + + var validRegions = Roo.bootstrap.layout.Border.regions; + + var target = cfg.region; + cfg.mgr = this; + + var r = Roo.bootstrap.layout; + Roo.log(target); + switch(target){ + case "north": + return new r.North(cfg); + case "south": + return new r.South(cfg); + case "east": + return new r.East(cfg); + case "west": + return new r.West(cfg); + case "center": + return new r.Center(cfg); + } + throw 'Layout region "'+target+'" not supported.'; + } + + +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_layout_Center.js.html b/docs2/src/Roo_bootstrap_layout_Center.js.html new file mode 100644 index 0000000000..3acbbe5a55 --- /dev/null +++ b/docs2/src/Roo_bootstrap_layout_Center.js.html @@ -0,0 +1,45 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/layout/Center.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/* + * These classes are private internal classes + */ +Roo.bootstrap.layout.Center = function(config){ + config.region = "center"; + Roo.bootstrap.layout.Region.call(this, config); + this.visible = true; + this.minWidth = config.minWidth || 20; + this.minHeight = config.minHeight || 20; +}; + +Roo.extend(Roo.bootstrap.layout.Center, Roo.bootstrap.layout.Region, { + hide : function(){ + // center panel can't be hidden + }, + + show : function(){ + // center panel can't be hidden + }, + + getMinWidth: function(){ + return this.minWidth; + }, + + getMinHeight: function(){ + return this.minHeight; + } +}); + + + + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_layout_East.js.html b/docs2/src/Roo_bootstrap_layout_East.js.html new file mode 100644 index 0000000000..79737d7d88 --- /dev/null +++ b/docs2/src/Roo_bootstrap_layout_East.js.html @@ -0,0 +1,46 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/layout/East.js +Roo.bootstrap.layout.East = function(config){ + config.region = "east"; + config.cursor = "e-resize"; + Roo.bootstrap.layout.Split.call(this, config); + if(this.split){ + this.split.placement = Roo.bootstrap.SplitBar.RIGHT; + this.split.orientation = Roo.bootstrap.SplitBar.HORIZONTAL; + this.split.el.addClass("roo-layout-split-h"); + } + var size = config.initialSize || config.width; + if(typeof size != "undefined"){ + this.el.setWidth(size); + } +}; +Roo.extend(Roo.bootstrap.layout.East, Roo.bootstrap.layout.Split, { + orientation: Roo.bootstrap.SplitBar.HORIZONTAL, + getBox : function(){ + if(this.collapsed){ + return this.collapsedEl.getBox(); + } + var box = this.el.getBox(); + if(this.split){ + var sw = this.split.el.getWidth(); + box.width += sw; + box.x -= sw; + } + return box; + }, + + updateBox : function(box){ + if(this.split && !this.collapsed){ + var sw = this.split.el.getWidth(); + box.width -= sw; + this.split.el.setLeft(box.x); + this.split.el.setTop(box.y); + this.split.el.setHeight(box.height); + box.x += sw; + } + if(this.collapsed){ + this.updateBody(null, box.height); + } + Roo.bootstrap.layout.Region.prototype.updateBox.call(this, box); + } +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_layout_Manager.js.html b/docs2/src/Roo_bootstrap_layout_Manager.js.html new file mode 100644 index 0000000000..3f71fefd71 --- /dev/null +++ b/docs2/src/Roo_bootstrap_layout_Manager.js.html @@ -0,0 +1,190 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/layout/Manager.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.bootstrap.layout.Manager + * @extends Roo.bootstrap.Component + * Base class for layout managers. + */ +Roo.bootstrap.layout.Manager = function(config) +{ + Roo.bootstrap.layout.Manager.superclass.constructor.call(this,config); + + + + + + /** false to disable window resize monitoring @type Boolean */ + this.monitorWindowResize = true; + this.regions = {}; + this.addEvents({ + /** + * @event layout + * Fires when a layout is performed. + * @param {Roo.LayoutManager} this + */ + "layout" : true, + /** + * @event regionresized + * Fires when the user resizes a region. + * @param {Roo.LayoutRegion} region The resized region + * @param {Number} newSize The new size (width for east/west, height for north/south) + */ + "regionresized" : true, + /** + * @event regioncollapsed + * Fires when a region is collapsed. + * @param {Roo.LayoutRegion} region The collapsed region + */ + "regioncollapsed" : true, + /** + * @event regionexpanded + * Fires when a region is expanded. + * @param {Roo.LayoutRegion} region The expanded region + */ + "regionexpanded" : true + }); + this.updating = false; + + if (config.el) { + this.el = Roo.get(config.el); + this.initEvents(); + } + +}; + +Roo.extend(Roo.bootstrap.layout.Manager, Roo.bootstrap.Component, { + + + regions : null, + + monitorWindowResize : true, + + + updating : false, + + + onRender : function(ct, position) + { + if(!this.el){ + this.el = Roo.get(ct); + this.initEvents(); + } + //this.fireEvent('render',this); + }, + + + initEvents: function() + { + + + // ie scrollbar fix + if(this.el.dom == document.body && Roo.isIE && !config.allowScroll){ + document.body.scroll = "no"; + }else if(this.el.dom != document.body && this.el.getStyle('position') == 'static'){ + this.el.position('relative'); + } + this.id = this.el.id; + this.el.addClass("roo-layout-container"); + Roo.EventManager.onWindowResize(this.onWindowResize, this, true); + if(this.el.dom != document.body ) { + this.el.on('resize', this.layout,this); + this.el.on('show', this.layout,this); + } + + }, + + /** + * Returns true if this layout is currently being updated + * @return {Boolean} + */ + isUpdating : function(){ + return this.updating; + }, + + /** + * Suspend the LayoutManager from doing auto-layouts while + * making multiple add or remove calls + */ + beginUpdate : function(){ + this.updating = true; + }, + + /** + * Restore auto-layouts and optionally disable the manager from performing a layout + * @param {Boolean} noLayout true to disable a layout update + */ + endUpdate : function(noLayout){ + this.updating = false; + if(!noLayout){ + this.layout(); + } + }, + + layout: function(){ + // abstract... + }, + + onRegionResized : function(region, newSize){ + this.fireEvent("regionresized", region, newSize); + this.layout(); + }, + + onRegionCollapsed : function(region){ + this.fireEvent("regioncollapsed", region); + }, + + onRegionExpanded : function(region){ + this.fireEvent("regionexpanded", region); + }, + + /** + * Returns the size of the current view. This method normalizes document.body and element embedded layouts and + * performs box-model adjustments. + * @return {Object} The size as an object {width: (the width), height: (the height)} + */ + getViewSize : function() + { + var size; + if(this.el.dom != document.body){ + size = this.el.getSize(); + }else{ + size = {width: Roo.lib.Dom.getViewWidth(), height: Roo.lib.Dom.getViewHeight()}; + } + size.width -= this.el.getBorderWidth("lr")-this.el.getPadding("lr"); + size.height -= this.el.getBorderWidth("tb")-this.el.getPadding("tb"); + return size; + }, + + /** + * Returns the Element this layout is bound to. + * @return {Roo.Element} + */ + getEl : function(){ + return this.el; + }, + + /** + * Returns the specified region. + * @param {String} target The region key ('center', 'north', 'south', 'east' or 'west') + * @return {Roo.LayoutRegion} + */ + getRegion : function(target){ + return this.regions[target.toLowerCase()]; + }, + + onWindowResize : function(){ + if(this.monitorWindowResize){ + this.layout(); + } + } +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_layout_North.js.html b/docs2/src/Roo_bootstrap_layout_North.js.html new file mode 100644 index 0000000000..9fb4791d2b --- /dev/null +++ b/docs2/src/Roo_bootstrap_layout_North.js.html @@ -0,0 +1,55 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/layout/North.js + + + + +Roo.bootstrap.layout.North = function(config) +{ + config.region = 'north'; + config.cursor = 'n-resize'; + + Roo.bootstrap.layout.Split.call(this, config); + + + if(this.split){ + this.split.placement = Roo.bootstrap.SplitBar.TOP; + this.split.orientation = Roo.bootstrap.SplitBar.VERTICAL; + this.split.el.addClass("roo-layout-split-v"); + } + var size = config.initialSize || config.height; + if(typeof size != "undefined"){ + this.el.setHeight(size); + } +}; +Roo.extend(Roo.bootstrap.layout.North, Roo.bootstrap.layout.Split, +{ + orientation: Roo.bootstrap.SplitBar.VERTICAL, + + + + getBox : function(){ + if(this.collapsed){ + return this.collapsedEl.getBox(); + } + var box = this.el.getBox(); + if(this.split){ + box.height += this.split.el.getHeight(); + } + return box; + }, + + updateBox : function(box){ + if(this.split && !this.collapsed){ + box.height -= this.split.el.getHeight(); + this.split.el.setLeft(box.x); + this.split.el.setTop(box.y+box.height); + this.split.el.setWidth(box.width); + } + if(this.collapsed){ + this.updateBody(box.width, null); + } + Roo.bootstrap.layout.Region.prototype.updateBox.call(this, box); + } +}); + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_layout_Region.js.html b/docs2/src/Roo_bootstrap_layout_Region.js.html new file mode 100644 index 0000000000..286638c72c --- /dev/null +++ b/docs2/src/Roo_bootstrap_layout_Region.js.html @@ -0,0 +1,742 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/layout/Region.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.bootstrap.layout.Region + * @extends Roo.bootstrap.layout.Basic + * This class represents a region in a layout manager. + + * @cfg {Object} margins Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0}) + * @cfg {Object} cmargins Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0}) + * @cfg {String} tabPosition (top|bottom) "top" or "bottom" (defaults to "bottom") + * @cfg {Boolean} alwaysShowTabs True to always display tabs even when there is only 1 panel (defaults to false) + * @cfg {Boolean} autoScroll True to enable overflow scrolling (defaults to false) + * @cfg {Boolean} titlebar True to display a title bar (defaults to true) + * @cfg {String} title The title for the region (overrides panel titles) + * @cfg {Boolean} animate True to animate expand/collapse (defaults to false) + * @cfg {Boolean} autoHide False to disable auto hiding when the mouse leaves the "floated" region (defaults to true) + * @cfg {Boolean} preservePanels True to preserve removed panels so they can be readded later (defaults to false) + * @cfg {Boolean} closeOnTab True to place the close icon on the tabs instead of the region titlebar (defaults to false) + * @cfg {Boolean} hideTabs True to hide the tab strip (defaults to false) + * @cfg {Boolean} resizeTabs True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within + * the space available, similar to FireFox 1.5 tabs (defaults to false) + * @cfg {Number} minTabWidth The minimum tab width (defaults to 40) + * @cfg {Number} preferredTabWidth The preferred tab width (defaults to 150) + * @cfg {String} overflow (hidden|visible) if you have menus in the region, then you need to set this to visible. + + * @cfg {Boolean} hidden True to start the region hidden (defaults to false) + * @cfg {Boolean} hideWhenEmpty True to hide the region when it has no panels + * @cfg {Boolean} disableTabTips True to disable tab tooltips + * @cfg {Number} width For East/West panels + * @cfg {Number} height For North/South panels + * @cfg {Boolean} split To show the splitter + * @cfg {Boolean} toolbar xtype configuration for a toolbar - shows on right of tabbar + * + * @cfg {string} cls Extra CSS classes to add to region + * + * @cfg {Roo.bootstrap.layout.Manager} mgr The manager + * @cfg {string} region the region that it inhabits.. + * + + * @xxxcfg {Boolean} collapsible DISABLED False to disable collapsing (defaults to true) + * @xxxcfg {Boolean} collapsed DISABLED True to set the initial display to collapsed (defaults to false) + + * @xxxcfg {String} collapsedTitle DISABLED Optional string message to display in the collapsed block of a north or south region + * @xxxxcfg {Boolean} floatable DISABLED False to disable floating (defaults to true) + * @xxxxcfg {Boolean} showPin True to show a pin button NOT SUPPORTED YET + */ +Roo.bootstrap.layout.Region = function(config) +{ + this.applyConfig(config); + + var mgr = config.mgr; + var pos = config.region; + config.skipConfig = true; + Roo.bootstrap.layout.Region.superclass.constructor.call(this, config); + + if (mgr.el) { + this.onRender(mgr.el); + } + + this.visible = true; + this.collapsed = false; + this.unrendered_panels = []; +}; + +Roo.extend(Roo.bootstrap.layout.Region, Roo.bootstrap.layout.Basic, { + + position: '', // set by wrapper (eg. north/south etc..) + unrendered_panels : null, // unrendered panels. + + tabPosition : false, + + mgr: false, // points to 'Border' + + + createBody : function(){ + /** This region's body element + * @type Roo.Element */ + this.bodyEl = this.el.createChild({ + tag: "div", + cls: "roo-layout-panel-body tab-content" // bootstrap added... + }); + }, + + onRender: function(ctr, pos) + { + var dh = Roo.DomHelper; + /** This region's container element + * @type Roo.Element */ + this.el = dh.append(ctr.dom, { + tag: "div", + cls: (this.config.cls || '') + " roo-layout-region roo-layout-panel roo-layout-panel-" + this.position + }, true); + /** This region's title element + * @type Roo.Element */ + + this.titleEl = dh.append(this.el.dom, { + tag: "div", + unselectable: "on", + cls: "roo-unselectable roo-layout-panel-hd breadcrumb roo-layout-title-" + this.position, + children:[ + {tag: "span", cls: "roo-unselectable roo-layout-panel-hd-text", unselectable: "on", html: "&#160;"}, + {tag: "div", cls: "roo-unselectable roo-layout-panel-hd-tools", unselectable: "on"} + ] + }, true); + + this.titleEl.enableDisplayMode(); + /** This region's title text element + * @type HTMLElement */ + this.titleTextEl = this.titleEl.dom.firstChild; + this.tools = Roo.get(this.titleEl.dom.childNodes[1], true); + /* + this.closeBtn = this.createTool(this.tools.dom, "roo-layout-close"); + this.closeBtn.enableDisplayMode(); + this.closeBtn.on("click", this.closeClicked, this); + this.closeBtn.hide(); + */ + this.createBody(this.config); + if(this.config.hideWhenEmpty){ + this.hide(); + this.on("paneladded", this.validateVisibility, this); + this.on("panelremoved", this.validateVisibility, this); + } + if(this.autoScroll){ + this.bodyEl.setStyle("overflow", "auto"); + }else{ + this.bodyEl.setStyle("overflow", this.config.overflow || 'hidden'); + } + //if(c.titlebar !== false){ + if((!this.config.titlebar && !this.config.title) || this.config.titlebar === false){ + this.titleEl.hide(); + }else{ + this.titleEl.show(); + if(this.config.title){ + this.titleTextEl.innerHTML = this.config.title; + } + } + //} + if(this.config.collapsed){ + this.collapse(true); + } + if(this.config.hidden){ + this.hide(); + } + + if (this.unrendered_panels && this.unrendered_panels.length) { + for (var i =0;i< this.unrendered_panels.length; i++) { + this.add(this.unrendered_panels[i]); + } + this.unrendered_panels = null; + + } + + }, + + applyConfig : function(c) + { + /* + *if(c.collapsible && this.position != "center" && !this.collapsedEl){ + var dh = Roo.DomHelper; + if(c.titlebar !== false){ + this.collapseBtn = this.createTool(this.tools.dom, "roo-layout-collapse-"+this.position); + this.collapseBtn.on("click", this.collapse, this); + this.collapseBtn.enableDisplayMode(); + /* + if(c.showPin === true || this.showPin){ + this.stickBtn = this.createTool(this.tools.dom, "roo-layout-stick"); + this.stickBtn.enableDisplayMode(); + this.stickBtn.on("click", this.expand, this); + this.stickBtn.hide(); + } + + } + */ + /** This region's collapsed element + * @type Roo.Element */ + /* + * + this.collapsedEl = dh.append(this.mgr.el.dom, {cls: "x-layout-collapsed x-layout-collapsed-"+this.position, children:[ + {cls: "x-layout-collapsed-tools", children:[{cls: "x-layout-ctools-inner"}]} + ]}, true); + + if(c.floatable !== false){ + this.collapsedEl.addClassOnOver("x-layout-collapsed-over"); + this.collapsedEl.on("click", this.collapseClick, this); + } + + if(c.collapsedTitle && (this.position == "north" || this.position== "south")) { + this.collapsedTitleTextEl = dh.append(this.collapsedEl.dom, {tag: "div", cls: "x-unselectable x-layout-panel-hd-text", + id: "message", unselectable: "on", style:{"float":"left"}}); + this.collapsedTitleTextEl.innerHTML = c.collapsedTitle; + } + this.expandBtn = this.createTool(this.collapsedEl.dom.firstChild.firstChild, "x-layout-expand-"+this.position); + this.expandBtn.on("click", this.expand, this); + + } + + if(this.collapseBtn){ + this.collapseBtn.setVisible(c.collapsible == true); + } + + this.cmargins = c.cmargins || this.cmargins || + (this.position == "west" || this.position == "east" ? + {top: 0, left: 2, right:2, bottom: 0} : + {top: 2, left: 0, right:0, bottom: 2}); + */ + this.margins = c.margins || this.margins || {top: 0, left: 0, right:0, bottom: 0}; + + + this.tabPosition = [ 'top','bottom', 'west'].indexOf(c.tabPosition) > -1 ? c.tabPosition : "top"; + + this.autoScroll = c.autoScroll || false; + + + + + this.duration = c.duration || .30; + this.slideDuration = c.slideDuration || .45; + this.config = c; + + }, + /** + * Returns true if this region is currently visible. + * @return {Boolean} + */ + isVisible : function(){ + return this.visible; + }, + + /** + * Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option) + * @param {String} title (optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, "&amp;#160;") + */ + //setCollapsedTitle : function(title){ + // title = title || "&#160;"; + // if(this.collapsedTitleTextEl){ + // this.collapsedTitleTextEl.innerHTML = title; + // } + //}, + + getBox : function(){ + var b; + // if(!this.collapsed){ + b = this.el.getBox(false, true); + // }else{ + // b = this.collapsedEl.getBox(false, true); + //} + return b; + }, + + getMargins : function(){ + return this.margins; + //return this.collapsed ? this.cmargins : this.margins; + }, +/* + highlight : function(){ + this.el.addClass("x-layout-panel-dragover"); + }, + + unhighlight : function(){ + this.el.removeClass("x-layout-panel-dragover"); + }, +*/ + updateBox : function(box) + { + if (!this.bodyEl) { + return; // not rendered yet.. + } + + this.box = box; + if(!this.collapsed){ + this.el.dom.style.left = box.x + "px"; + this.el.dom.style.top = box.y + "px"; + this.updateBody(box.width, box.height); + }else{ + this.collapsedEl.dom.style.left = box.x + "px"; + this.collapsedEl.dom.style.top = box.y + "px"; + this.collapsedEl.setSize(box.width, box.height); + } + if(this.tabs){ + this.tabs.autoSizeTabs(); + } + }, + + updateBody : function(w, h) + { + if(w !== null){ + this.el.setWidth(w); + w -= this.el.getBorderWidth("rl"); + if(this.config.adjustments){ + w += this.config.adjustments[0]; + } + } + if(h !== null && h > 0){ + this.el.setHeight(h); + h = this.titleEl && this.titleEl.isDisplayed() ? h - (this.titleEl.getHeight()||0) : h; + h -= this.el.getBorderWidth("tb"); + if(this.config.adjustments){ + h += this.config.adjustments[1]; + } + this.bodyEl.setHeight(h); + if(this.tabs){ + h = this.tabs.syncHeight(h); + } + } + if(this.panelSize){ + w = w !== null ? w : this.panelSize.width; + h = h !== null ? h : this.panelSize.height; + } + if(this.activePanel){ + var el = this.activePanel.getEl(); + w = w !== null ? w : el.getWidth(); + h = h !== null ? h : el.getHeight(); + this.panelSize = {width: w, height: h}; + this.activePanel.setSize(w, h); + } + if(Roo.isIE && this.tabs){ + this.tabs.el.repaint(); + } + }, + + /** + * Returns the container element for this region. + * @return {Roo.Element} + */ + getEl : function(){ + return this.el; + }, + + /** + * Hides this region. + */ + hide : function(){ + //if(!this.collapsed){ + this.el.dom.style.left = "-2000px"; + this.el.hide(); + //}else{ + // this.collapsedEl.dom.style.left = "-2000px"; + // this.collapsedEl.hide(); + // } + this.visible = false; + this.fireEvent("visibilitychange", this, false); + }, + + /** + * Shows this region if it was previously hidden. + */ + show : function(){ + //if(!this.collapsed){ + this.el.show(); + //}else{ + // this.collapsedEl.show(); + // } + this.visible = true; + this.fireEvent("visibilitychange", this, true); + }, +/* + closeClicked : function(){ + if(this.activePanel){ + this.remove(this.activePanel); + } + }, + + collapseClick : function(e){ + if(this.isSlid){ + e.stopPropagation(); + this.slideIn(); + }else{ + e.stopPropagation(); + this.slideOut(); + } + }, +*/ + /** + * Collapses this region. + * @param {Boolean} skipAnim (optional) true to collapse the element without animation (if animate is true) + */ + /* + collapse : function(skipAnim, skipCheck = false){ + if(this.collapsed) { + return; + } + + if(skipCheck || this.fireEvent("beforecollapse", this) != false){ + + this.collapsed = true; + if(this.split){ + this.split.el.hide(); + } + if(this.config.animate && skipAnim !== true){ + this.fireEvent("invalidated", this); + this.animateCollapse(); + }else{ + this.el.setLocation(-20000,-20000); + this.el.hide(); + this.collapsedEl.show(); + this.fireEvent("collapsed", this); + this.fireEvent("invalidated", this); + } + } + + }, +*/ + animateCollapse : function(){ + // overridden + }, + + /** + * Expands this region if it was previously collapsed. + * @param {Roo.EventObject} e The event that triggered the expand (or null if calling manually) + * @param {Boolean} skipAnim (optional) true to expand the element without animation (if animate is true) + */ + /* + expand : function(e, skipAnim){ + if(e) { + e.stopPropagation(); + } + if(!this.collapsed || this.el.hasActiveFx()) { + return; + } + if(this.isSlid){ + this.afterSlideIn(); + skipAnim = true; + } + this.collapsed = false; + if(this.config.animate && skipAnim !== true){ + this.animateExpand(); + }else{ + this.el.show(); + if(this.split){ + this.split.el.show(); + } + this.collapsedEl.setLocation(-2000,-2000); + this.collapsedEl.hide(); + this.fireEvent("invalidated", this); + this.fireEvent("expanded", this); + } + }, +*/ + animateExpand : function(){ + // overridden + }, + + initTabs : function() + { + //this.bodyEl.setStyle("overflow", "hidden"); -- this is set in render? + + var ts = new Roo.bootstrap.panel.Tabs({ + el: this.bodyEl.dom, + region : this, + tabPosition: this.tabPosition ? this.tabPosition : 'top', + disableTooltips: this.config.disableTabTips, + toolbar : this.config.toolbar + }); + + if(this.config.hideTabs){ + ts.stripWrap.setDisplayed(false); + } + this.tabs = ts; + ts.resizeTabs = this.config.resizeTabs === true; + ts.minTabWidth = this.config.minTabWidth || 40; + ts.maxTabWidth = this.config.maxTabWidth || 250; + ts.preferredTabWidth = this.config.preferredTabWidth || 150; + ts.monitorResize = false; + //ts.bodyEl.setStyle("overflow", this.config.autoScroll ? "auto" : "hidden"); // this is set in render? + ts.bodyEl.addClass('roo-layout-tabs-body'); + this.panels.each(this.initPanelAsTab, this); + }, + + initPanelAsTab : function(panel){ + var ti = this.tabs.addTab( + panel.getEl().id, + panel.getTitle(), + null, + this.config.closeOnTab && panel.isClosable(), + panel.tpl + ); + if(panel.tabTip !== undefined){ + ti.setTooltip(panel.tabTip); + } + ti.on("activate", function(){ + this.setActivePanel(panel); + }, this); + + if(this.config.closeOnTab){ + ti.on("beforeclose", function(t, e){ + e.cancel = true; + this.remove(panel); + }, this); + } + + panel.tabItem = ti; + + return ti; + }, + + updatePanelTitle : function(panel, title) + { + if(this.activePanel == panel){ + this.updateTitle(title); + } + if(this.tabs){ + var ti = this.tabs.getTab(panel.getEl().id); + ti.setText(title); + if(panel.tabTip !== undefined){ + ti.setTooltip(panel.tabTip); + } + } + }, + + updateTitle : function(title){ + if(this.titleTextEl && !this.config.title){ + this.titleTextEl.innerHTML = (typeof title != "undefined" && title.length > 0 ? title : "&#160;"); + } + }, + + setActivePanel : function(panel) + { + panel = this.getPanel(panel); + if(this.activePanel && this.activePanel != panel){ + if(this.activePanel.setActiveState(false) === false){ + return; + } + } + this.activePanel = panel; + panel.setActiveState(true); + if(this.panelSize){ + panel.setSize(this.panelSize.width, this.panelSize.height); + } + if(this.closeBtn){ + this.closeBtn.setVisible(!this.config.closeOnTab && !this.isSlid && panel.isClosable()); + } + this.updateTitle(panel.getTitle()); + if(this.tabs){ + this.fireEvent("invalidated", this); + } + this.fireEvent("panelactivated", this, panel); + }, + + /** + * Shows the specified panel. + * @param {Number/String/ContentPanel} panelId The panel's index, id or the panel itself + * @return {Roo.ContentPanel} The shown panel, or null if a panel could not be found from panelId + */ + showPanel : function(panel) + { + panel = this.getPanel(panel); + if(panel){ + if(this.tabs){ + var tab = this.tabs.getTab(panel.getEl().id); + if(tab.isHidden()){ + this.tabs.unhideTab(tab.id); + } + tab.activate(); + }else{ + this.setActivePanel(panel); + } + } + return panel; + }, + + /** + * Get the active panel for this region. + * @return {Roo.ContentPanel} The active panel or null + */ + getActivePanel : function(){ + return this.activePanel; + }, + + validateVisibility : function(){ + if(this.panels.getCount() < 1){ + this.updateTitle("&#160;"); + this.closeBtn.hide(); + this.hide(); + }else{ + if(!this.isVisible()){ + this.show(); + } + } + }, + + /** + * Adds the passed ContentPanel(s) to this region. + * @param {ContentPanel...} panel The ContentPanel(s) to add (you can pass more than one) + * @return {Roo.ContentPanel} The panel added (if only one was added; null otherwise) + */ + add : function(panel) + { + if(arguments.length > 1){ + for(var i = 0, len = arguments.length; i < len; i++) { + this.add(arguments[i]); + } + return null; + } + + // if we have not been rendered yet, then we can not really do much of this.. + if (!this.bodyEl) { + this.unrendered_panels.push(panel); + return panel; + } + + + + + if(this.hasPanel(panel)){ + this.showPanel(panel); + return panel; + } + panel.setRegion(this); + this.panels.add(panel); + /* if(this.panels.getCount() == 1 && !this.config.alwaysShowTabs){ + // sinle panel - no tab...?? would it not be better to render it with the tabs, + // and hide them... ??? + this.bodyEl.dom.appendChild(panel.getEl().dom); + if(panel.background !== true){ + this.setActivePanel(panel); + } + this.fireEvent("paneladded", this, panel); + return panel; + } + */ + if(!this.tabs){ + this.initTabs(); + }else{ + this.initPanelAsTab(panel); + } + + + if(panel.background !== true){ + this.tabs.activate(panel.getEl().id); + } + this.fireEvent("paneladded", this, panel); + return panel; + }, + + /** + * Hides the tab for the specified panel. + * @param {Number/String/ContentPanel} panel The panel's index, id or the panel itself + */ + hidePanel : function(panel){ + if(this.tabs && (panel = this.getPanel(panel))){ + this.tabs.hideTab(panel.getEl().id); + } + }, + + /** + * Unhides the tab for a previously hidden panel. + * @param {Number/String/ContentPanel} panel The panel's index, id or the panel itself + */ + unhidePanel : function(panel){ + if(this.tabs && (panel = this.getPanel(panel))){ + this.tabs.unhideTab(panel.getEl().id); + } + }, + + clearPanels : function(){ + while(this.panels.getCount() > 0){ + this.remove(this.panels.first()); + } + }, + + /** + * Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed. + * @param {Number/String/ContentPanel} panel The panel's index, id or the panel itself + * @param {Boolean} preservePanel Overrides the config preservePanel option + * @return {Roo.ContentPanel} The panel that was removed + */ + remove : function(panel, preservePanel) + { + panel = this.getPanel(panel); + if(!panel){ + return null; + } + var e = {}; + this.fireEvent("beforeremove", this, panel, e); + if(e.cancel === true){ + return null; + } + preservePanel = (typeof preservePanel != "undefined" ? preservePanel : (this.config.preservePanels === true || panel.preserve === true)); + var panelId = panel.getId(); + this.panels.removeKey(panelId); + if(preservePanel){ + document.body.appendChild(panel.getEl().dom); + } + if(this.tabs){ + this.tabs.removeTab(panel.getEl().id); + }else if (!preservePanel){ + this.bodyEl.dom.removeChild(panel.getEl().dom); + } + if(this.panels.getCount() == 1 && this.tabs && !this.config.alwaysShowTabs){ + var p = this.panels.first(); + var tempEl = document.createElement("div"); // temp holder to keep IE from deleting the node + tempEl.appendChild(p.getEl().dom); + this.bodyEl.update(""); + this.bodyEl.dom.appendChild(p.getEl().dom); + tempEl = null; + this.updateTitle(p.getTitle()); + this.tabs = null; + this.bodyEl.setStyle("overflow", this.config.autoScroll ? "auto" : "hidden"); + this.setActivePanel(p); + } + panel.setRegion(null); + if(this.activePanel == panel){ + this.activePanel = null; + } + if(this.config.autoDestroy !== false && preservePanel !== true){ + try{panel.destroy();}catch(e){} + } + this.fireEvent("panelremoved", this, panel); + return panel; + }, + + /** + * Returns the TabPanel component used by this region + * @return {Roo.TabPanel} + */ + getTabs : function(){ + return this.tabs; + }, + + createTool : function(parentEl, className){ + var btn = Roo.DomHelper.append(parentEl, { + tag: "div", + cls: "x-layout-tools-button", + children: [ { + tag: "div", + cls: "roo-layout-tools-button-inner " + className, + html: "&#160;" + }] + }, true); + btn.addClassOnOver("roo-layout-tools-button-over"); + return btn; + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_layout_South.js.html b/docs2/src/Roo_bootstrap_layout_South.js.html new file mode 100644 index 0000000000..0217d85059 --- /dev/null +++ b/docs2/src/Roo_bootstrap_layout_South.js.html @@ -0,0 +1,50 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/layout/South.js + + + +Roo.bootstrap.layout.South = function(config){ + config.region = 'south'; + config.cursor = 's-resize'; + Roo.bootstrap.layout.Split.call(this, config); + if(this.split){ + this.split.placement = Roo.bootstrap.SplitBar.BOTTOM; + this.split.orientation = Roo.bootstrap.SplitBar.VERTICAL; + this.split.el.addClass("roo-layout-split-v"); + } + var size = config.initialSize || config.height; + if(typeof size != "undefined"){ + this.el.setHeight(size); + } +}; + +Roo.extend(Roo.bootstrap.layout.South, Roo.bootstrap.layout.Split, { + orientation: Roo.bootstrap.SplitBar.VERTICAL, + getBox : function(){ + if(this.collapsed){ + return this.collapsedEl.getBox(); + } + var box = this.el.getBox(); + if(this.split){ + var sh = this.split.el.getHeight(); + box.height += sh; + box.y -= sh; + } + return box; + }, + + updateBox : function(box){ + if(this.split && !this.collapsed){ + var sh = this.split.el.getHeight(); + box.height -= sh; + box.y += sh; + this.split.el.setLeft(box.x); + this.split.el.setTop(box.y-sh); + this.split.el.setWidth(box.width); + } + if(this.collapsed){ + this.updateBody(box.width, null); + } + Roo.bootstrap.layout.Region.prototype.updateBox.call(this, box); + } +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_layout_Split.js.html b/docs2/src/Roo_bootstrap_layout_Split.js.html new file mode 100644 index 0000000000..178fd9e0ac --- /dev/null +++ b/docs2/src/Roo_bootstrap_layout_Split.js.html @@ -0,0 +1,364 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/layout/Split.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + + +/** + * @class Roo.SplitLayoutRegion + * @extends Roo.LayoutRegion + * Adds a splitbar and other (private) useful functionality to a {@link Roo.LayoutRegion}. + */ +Roo.bootstrap.layout.Split = function(config){ + this.cursor = config.cursor; + Roo.bootstrap.layout.Split.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.layout.Split, Roo.bootstrap.layout.Region, +{ + splitTip : "Drag to resize.", + collapsibleSplitTip : "Drag to resize. Double click to hide.", + useSplitTips : false, + + applyConfig : function(config){ + Roo.bootstrap.layout.Split.superclass.applyConfig.call(this, config); + }, + + onRender : function(ctr,pos) { + + Roo.bootstrap.layout.Split.superclass.onRender.call(this, ctr,pos); + if(!this.config.split){ + return; + } + if(!this.split){ + + var splitEl = Roo.DomHelper.append(ctr.dom, { + tag: "div", + id: this.el.id + "-split", + cls: "roo-layout-split roo-layout-split-"+this.position, + html: "&#160;" + }); + /** The SplitBar for this region + * @type Roo.SplitBar */ + // does not exist yet... + Roo.log([this.position, this.orientation]); + + this.split = new Roo.bootstrap.SplitBar({ + dragElement : splitEl, + resizingElement: this.el, + orientation : this.orientation + }); + + this.split.on("moved", this.onSplitMove, this); + this.split.useShim = this.config.useShim === true; + this.split.getMaximumSize = this[this.position == 'north' || this.position == 'south' ? 'getVMaxSize' : 'getHMaxSize'].createDelegate(this); + if(this.useSplitTips){ + this.split.el.dom.title = this.config.collapsible ? this.collapsibleSplitTip : this.splitTip; + } + //if(config.collapsible){ + // this.split.el.on("dblclick", this.collapse, this); + //} + } + if(typeof this.config.minSize != "undefined"){ + this.split.minSize = this.config.minSize; + } + if(typeof this.config.maxSize != "undefined"){ + this.split.maxSize = this.config.maxSize; + } + if(this.config.hideWhenEmpty || this.config.hidden || this.config.collapsed){ + this.hideSplitter(); + } + + }, + + getHMaxSize : function(){ + var cmax = this.config.maxSize || 10000; + var center = this.mgr.getRegion("center"); + return Math.min(cmax, (this.el.getWidth()+center.getEl().getWidth())-center.getMinWidth()); + }, + + getVMaxSize : function(){ + var cmax = this.config.maxSize || 10000; + var center = this.mgr.getRegion("center"); + return Math.min(cmax, (this.el.getHeight()+center.getEl().getHeight())-center.getMinHeight()); + }, + + onSplitMove : function(split, newSize){ + this.fireEvent("resized", this, newSize); + }, + + /** + * Returns the {@link Roo.SplitBar} for this region. + * @return {Roo.SplitBar} + */ + getSplitBar : function(){ + return this.split; + }, + + hide : function(){ + this.hideSplitter(); + Roo.bootstrap.layout.Split.superclass.hide.call(this); + }, + + hideSplitter : function(){ + if(this.split){ + this.split.el.setLocation(-2000,-2000); + this.split.el.hide(); + } + }, + + show : function(){ + if(this.split){ + this.split.el.show(); + } + Roo.bootstrap.layout.Split.superclass.show.call(this); + }, + + beforeSlide: function(){ + if(Roo.isGecko){// firefox overflow auto bug workaround + this.bodyEl.clip(); + if(this.tabs) { + this.tabs.bodyEl.clip(); + } + if(this.activePanel){ + this.activePanel.getEl().clip(); + + if(this.activePanel.beforeSlide){ + this.activePanel.beforeSlide(); + } + } + } + }, + + afterSlide : function(){ + if(Roo.isGecko){// firefox overflow auto bug workaround + this.bodyEl.unclip(); + if(this.tabs) { + this.tabs.bodyEl.unclip(); + } + if(this.activePanel){ + this.activePanel.getEl().unclip(); + if(this.activePanel.afterSlide){ + this.activePanel.afterSlide(); + } + } + } + }, + + initAutoHide : function(){ + if(this.autoHide !== false){ + if(!this.autoHideHd){ + var st = new Roo.util.DelayedTask(this.slideIn, this); + this.autoHideHd = { + "mouseout": function(e){ + if(!e.within(this.el, true)){ + st.delay(500); + } + }, + "mouseover" : function(e){ + st.cancel(); + }, + scope : this + }; + } + this.el.on(this.autoHideHd); + } + }, + + clearAutoHide : function(){ + if(this.autoHide !== false){ + this.el.un("mouseout", this.autoHideHd.mouseout); + this.el.un("mouseover", this.autoHideHd.mouseover); + } + }, + + clearMonitor : function(){ + Roo.get(document).un("click", this.slideInIf, this); + }, + + // these names are backwards but not changed for compat + slideOut : function(){ + if(this.isSlid || this.el.hasActiveFx()){ + return; + } + this.isSlid = true; + if(this.collapseBtn){ + this.collapseBtn.hide(); + } + this.closeBtnState = this.closeBtn.getStyle('display'); + this.closeBtn.hide(); + if(this.stickBtn){ + this.stickBtn.show(); + } + this.el.show(); + this.el.alignTo(this.collapsedEl, this.getCollapseAnchor()); + this.beforeSlide(); + this.el.setStyle("z-index", 10001); + this.el.slideIn(this.getSlideAnchor(), { + callback: function(){ + this.afterSlide(); + this.initAutoHide(); + Roo.get(document).on("click", this.slideInIf, this); + this.fireEvent("slideshow", this); + }, + scope: this, + block: true + }); + }, + + afterSlideIn : function(){ + this.clearAutoHide(); + this.isSlid = false; + this.clearMonitor(); + this.el.setStyle("z-index", ""); + if(this.collapseBtn){ + this.collapseBtn.show(); + } + this.closeBtn.setStyle('display', this.closeBtnState); + if(this.stickBtn){ + this.stickBtn.hide(); + } + this.fireEvent("slidehide", this); + }, + + slideIn : function(cb){ + if(!this.isSlid || this.el.hasActiveFx()){ + Roo.callback(cb); + return; + } + this.isSlid = false; + this.beforeSlide(); + this.el.slideOut(this.getSlideAnchor(), { + callback: function(){ + this.el.setLeftTop(-10000, -10000); + this.afterSlide(); + this.afterSlideIn(); + Roo.callback(cb); + }, + scope: this, + block: true + }); + }, + + slideInIf : function(e){ + if(!e.within(this.el)){ + this.slideIn(); + } + }, + + animateCollapse : function(){ + this.beforeSlide(); + this.el.setStyle("z-index", 20000); + var anchor = this.getSlideAnchor(); + this.el.slideOut(anchor, { + callback : function(){ + this.el.setStyle("z-index", ""); + this.collapsedEl.slideIn(anchor, {duration:.3}); + this.afterSlide(); + this.el.setLocation(-10000,-10000); + this.el.hide(); + this.fireEvent("collapsed", this); + }, + scope: this, + block: true + }); + }, + + animateExpand : function(){ + this.beforeSlide(); + this.el.alignTo(this.collapsedEl, this.getCollapseAnchor(), this.getExpandAdj()); + this.el.setStyle("z-index", 20000); + this.collapsedEl.hide({ + duration:.1 + }); + this.el.slideIn(this.getSlideAnchor(), { + callback : function(){ + this.el.setStyle("z-index", ""); + this.afterSlide(); + if(this.split){ + this.split.el.show(); + } + this.fireEvent("invalidated", this); + this.fireEvent("expanded", this); + }, + scope: this, + block: true + }); + }, + + anchors : { + "west" : "left", + "east" : "right", + "north" : "top", + "south" : "bottom" + }, + + sanchors : { + "west" : "l", + "east" : "r", + "north" : "t", + "south" : "b" + }, + + canchors : { + "west" : "tl-tr", + "east" : "tr-tl", + "north" : "tl-bl", + "south" : "bl-tl" + }, + + getAnchor : function(){ + return this.anchors[this.position]; + }, + + getCollapseAnchor : function(){ + return this.canchors[this.position]; + }, + + getSlideAnchor : function(){ + return this.sanchors[this.position]; + }, + + getAlignAdj : function(){ + var cm = this.cmargins; + switch(this.position){ + case "west": + return [0, 0]; + break; + case "east": + return [0, 0]; + break; + case "north": + return [0, 0]; + break; + case "south": + return [0, 0]; + break; + } + }, + + getExpandAdj : function(){ + var c = this.collapsedEl, cm = this.cmargins; + switch(this.position){ + case "west": + return [-(cm.right+c.getWidth()+cm.left), 0]; + break; + case "east": + return [cm.right+c.getWidth()+cm.left, 0]; + break; + case "north": + return [0, -(cm.top+cm.bottom+c.getHeight())]; + break; + case "south": + return [0, cm.top+cm.bottom+c.getHeight()]; + break; + } + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_layout_West.js.html b/docs2/src/Roo_bootstrap_layout_West.js.html new file mode 100644 index 0000000000..981eec1fbd --- /dev/null +++ b/docs2/src/Roo_bootstrap_layout_West.js.html @@ -0,0 +1,50 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/layout/West.js +Roo.bootstrap.layout.West = function(config){ + config.region = "west"; + config.cursor = "w-resize"; + + Roo.bootstrap.layout.Split.call(this, config); + if(this.split){ + this.split.placement = Roo.bootstrap.SplitBar.LEFT; + this.split.orientation = Roo.bootstrap.SplitBar.HORIZONTAL; + this.split.el.addClass("roo-layout-split-h"); + } + +}; +Roo.extend(Roo.bootstrap.layout.West, Roo.bootstrap.layout.Split, { + orientation: Roo.bootstrap.SplitBar.HORIZONTAL, + + onRender: function(ctr, pos) + { + Roo.bootstrap.layout.West.superclass.onRender.call(this, ctr,pos); + var size = this.config.initialSize || this.config.width; + if(typeof size != "undefined"){ + this.el.setWidth(size); + } + }, + + getBox : function(){ + if(this.collapsed){ + return this.collapsedEl.getBox(); + } + var box = this.el.getBox(); + if(this.split){ + box.width += this.split.el.getWidth(); + } + return box; + }, + + updateBox : function(box){ + if(this.split && !this.collapsed){ + var sw = this.split.el.getWidth(); + box.width -= sw; + this.split.el.setLeft(box.x+box.width); + this.split.el.setTop(box.y); + this.split.el.setHeight(box.height); + } + if(this.collapsed){ + this.updateBody(null, box.height); + } + Roo.bootstrap.layout.Region.prototype.updateBox.call(this, box); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_layout_layout-ns.js.html b/docs2/src/Roo_bootstrap_layout_layout-ns.js.html new file mode 100644 index 0000000000..04dd1438ea --- /dev/null +++ b/docs2/src/Roo_bootstrap_layout_layout-ns.js.html @@ -0,0 +1 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/layout/layout-ns.jsRoo.namespace("Roo.bootstrap.layout"); \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_menu_Item.js.html b/docs2/src/Roo_bootstrap_menu_Item.js.html new file mode 100644 index 0000000000..9781a1ebbf --- /dev/null +++ b/docs2/src/Roo_bootstrap_menu_Item.js.html @@ -0,0 +1,143 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/menu/Item.js/* + * - LGPL + * + * menu item + * + */ +Roo.bootstrap.menu = Roo.bootstrap.menu || {}; + +/** + * @class Roo.bootstrap.menu.Item + * @extends Roo.bootstrap.Component + * Bootstrap MenuItem class + * @cfg {Boolean} submenu (true | false) default false + * @cfg {String} html text of the item + * @cfg {String} href the link + * @cfg {Boolean} disable (true | false) default false + * @cfg {Boolean} preventDefault (true | false) default true + * @cfg {String} icon Font awesome icon + * @cfg {String} pos Submenu align to (left | right) default right + * + * + * @constructor + * Create a new Item + * @param {Object} config The config object + */ + + +Roo.bootstrap.menu.Item = function(config){ + Roo.bootstrap.menu.Item.superclass.constructor.call(this, config); + this.addEvents({ + /** + * @event mouseover + * Fires when the mouse is hovering over this menu + * @param {Roo.bootstrap.menu.Item} this + * @param {Roo.EventObject} e + */ + mouseover : true, + /** + * @event mouseout + * Fires when the mouse exits this menu + * @param {Roo.bootstrap.menu.Item} this + * @param {Roo.EventObject} e + */ + mouseout : true, + // raw events + /** + * @event click + * The raw click event for the entire grid. + * @param {Roo.EventObject} e + */ + click : true + }); +}; + +Roo.extend(Roo.bootstrap.menu.Item, Roo.bootstrap.Component, { + + submenu : false, + href : '', + html : '', + preventDefault: true, + disable : false, + icon : false, + pos : 'right', + + getAutoCreate : function() + { + var text = [ + { + tag : 'span', + cls : 'roo-menu-item-text', + html : this.html + } + ]; + + if(this.icon){ + text.unshift({ + tag : 'i', + cls : 'fa ' + this.icon + }) + } + + var cfg = { + tag : 'li', + cn : [ + { + tag : 'a', + href : this.href || '#', + cn : text + } + ] + }; + + if(this.disable){ + cfg.cls = (typeof(cfg.cls) == 'undefined') ? 'disabled' : (cfg.cls + ' disabled'); + } + + if(this.submenu){ + cfg.cls = (typeof(cfg.cls) == 'undefined') ? 'dropdown-submenu' : (cfg.cls + ' dropdown-submenu'); + + if(this.pos == 'left'){ + cfg.cls = (typeof(cfg.cls) == 'undefined') ? 'pull-left' : (cfg.cls + ' pull-left'); + } + } + + return cfg; + }, + + initEvents : function() + { + this.el.on('mouseover', this.onMouseOver, this); + this.el.on('mouseout', this.onMouseOut, this); + + this.el.select('a', true).first().on('click', this.onClick, this); + + }, + + onClick : function(e) + { + if(this.preventDefault){ + e.preventDefault(); + } + + this.fireEvent("click", this, e); + }, + + onMouseOver : function(e) + { + if(this.submenu && this.pos == 'left'){ + this.el.select('ul.dropdown-menu', true).first().setLeft(this.el.select('ul.dropdown-menu', true).first().getWidth() * -1); + } + + this.fireEvent("mouseover", this, e); + }, + + onMouseOut : function(e) + { + this.fireEvent("mouseout", this, e); + } +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_menu_Menu.js.html b/docs2/src/Roo_bootstrap_menu_Menu.js.html new file mode 100644 index 0000000000..2f99536a18 --- /dev/null +++ b/docs2/src/Roo_bootstrap_menu_Menu.js.html @@ -0,0 +1,224 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/menu/Menu.js/* + * - LGPL + * + * menu + * + */ +Roo.bootstrap.menu = Roo.bootstrap.menu || {}; + +/** + * @class Roo.bootstrap.menu.Menu + * @extends Roo.bootstrap.Component + * Bootstrap Menu class - container for Menu + * @cfg {String} html Text of the menu + * @cfg {String} weight (default | primary | success | info | warning | danger | inverse) + * @cfg {String} icon Font awesome icon + * @cfg {String} pos Menu align to (top | bottom) default bottom + * + * + * @constructor + * Create a new Menu + * @param {Object} config The config object + */ + + +Roo.bootstrap.menu.Menu = function(config){ + Roo.bootstrap.menu.Menu.superclass.constructor.call(this, config); + + this.addEvents({ + /** + * @event beforeshow + * Fires before this menu is displayed + * @param {Roo.bootstrap.menu.Menu} this + */ + beforeshow : true, + /** + * @event beforehide + * Fires before this menu is hidden + * @param {Roo.bootstrap.menu.Menu} this + */ + beforehide : true, + /** + * @event show + * Fires after this menu is displayed + * @param {Roo.bootstrap.menu.Menu} this + */ + show : true, + /** + * @event hide + * Fires after this menu is hidden + * @param {Roo.bootstrap.menu.Menu} this + */ + hide : true, + /** + * @event click + * Fires when this menu is clicked (or when the enter key is pressed while it is active) + * @param {Roo.bootstrap.menu.Menu} this + * @param {Roo.EventObject} e + */ + click : true + }); + +}; + +Roo.extend(Roo.bootstrap.menu.Menu, Roo.bootstrap.Component, { + + submenu : false, + html : '', + weight : 'default', + icon : false, + pos : 'bottom', + + + getChildContainer : function() { + if(this.isSubMenu){ + return this.el; + } + + return this.el.select('ul.dropdown-menu', true).first(); + }, + + getAutoCreate : function() + { + var text = [ + { + tag : 'span', + cls : 'roo-menu-text', + html : this.html + } + ]; + + if(this.icon){ + text.unshift({ + tag : 'i', + cls : 'fa ' + this.icon + }) + } + + + var cfg = { + tag : 'div', + cls : 'btn-group', + cn : [ + { + tag : 'button', + cls : 'dropdown-button btn btn-' + this.weight, + cn : text + }, + { + tag : 'button', + cls : 'dropdown-toggle btn btn-' + this.weight, + cn : [ + { + tag : 'span', + cls : 'caret' + } + ] + }, + { + tag : 'ul', + cls : 'dropdown-menu' + } + ] + + }; + + if(this.pos == 'top'){ + cfg.cls += ' dropup'; + } + + if(this.isSubMenu){ + cfg = { + tag : 'ul', + cls : 'dropdown-menu' + } + } + + return cfg; + }, + + onRender : function(ct, position) + { + this.isSubMenu = ct.hasClass('dropdown-submenu'); + + Roo.bootstrap.menu.Menu.superclass.onRender.call(this, ct, position); + }, + + initEvents : function() + { + if(this.isSubMenu){ + return; + } + + this.hidden = true; + + this.triggerEl = this.el.select('button.dropdown-toggle', true).first(); + this.triggerEl.on('click', this.onTriggerPress, this); + + this.buttonEl = this.el.select('button.dropdown-button', true).first(); + this.buttonEl.on('click', this.onClick, this); + + }, + + list : function() + { + if(this.isSubMenu){ + return this.el; + } + + return this.el.select('ul.dropdown-menu', true).first(); + }, + + onClick : function(e) + { + this.fireEvent("click", this, e); + }, + + onTriggerPress : function(e) + { + if (this.isVisible()) { + this.hide(); + } else { + this.show(); + } + }, + + isVisible : function(){ + return !this.hidden; + }, + + show : function() + { + this.fireEvent("beforeshow", this); + + this.hidden = false; + this.el.addClass('open'); + + Roo.get(document).on("mouseup", this.onMouseUp, this); + + this.fireEvent("show", this); + + + }, + + hide : function() + { + this.fireEvent("beforehide", this); + + this.hidden = true; + this.el.removeClass('open'); + + Roo.get(document).un("mouseup", this.onMouseUp); + + this.fireEvent("hide", this); + }, + + onMouseUp : function() + { + this.hide(); + } + +}); + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_menu_Separator.js.html b/docs2/src/Roo_bootstrap_menu_Separator.js.html new file mode 100644 index 0000000000..762099714c --- /dev/null +++ b/docs2/src/Roo_bootstrap_menu_Separator.js.html @@ -0,0 +1,39 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/menu/Separator.js/* + * - LGPL + * + * menu separator + * + */ +Roo.bootstrap.menu = Roo.bootstrap.menu || {}; + +/** + * @class Roo.bootstrap.menu.Separator + * @extends Roo.bootstrap.Component + * Bootstrap Separator class + * + * @constructor + * Create a new Separator + * @param {Object} config The config object + */ + + +Roo.bootstrap.menu.Separator = function(config){ + Roo.bootstrap.menu.Separator.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.menu.Separator, Roo.bootstrap.Component, { + + getAutoCreate : function(){ + var cfg = { + tag : 'li', + cls: 'divider' + }; + + return cfg; + } + +}); + + + + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_panel_Content.js.html b/docs2/src/Roo_bootstrap_panel_Content.js.html new file mode 100644 index 0000000000..1751072059 --- /dev/null +++ b/docs2/src/Roo_bootstrap_panel_Content.js.html @@ -0,0 +1,526 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/panel/Content.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.ContentPanel + * @extends Roo.util.Observable + * A basic ContentPanel element. + * @cfg {Boolean} fitToFrame True for this panel to adjust its size to fit when the region resizes (defaults to false) + * @cfg {Boolean} fitContainer When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false) + * @cfg {Boolean/Object} autoCreate True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create + * @cfg {Boolean} closable True if the panel can be closed/removed + * @cfg {Boolean} background True if the panel should not be activated when it is added (defaults to false) + * @cfg {String/HTMLElement/Element} resizeEl An element to resize if {@link #fitToFrame} is true (instead of this panel's element) + * @cfg {Toolbar} toolbar A toolbar for this panel + * @cfg {Boolean} autoScroll True to scroll overflow in this panel (use with {@link #fitToFrame}) + * @cfg {String} title The title for this panel + * @cfg {Array} adjustments Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0]) + * @cfg {String} url Calls {@link #setUrl} with this value + * @cfg {String} region (center|north|south|east|west) which region to put this panel on (when used with xtype constructors) + * @cfg {String/Object} params When used with {@link #url}, calls {@link #setUrl} with this value + * @cfg {Boolean} loadOnce When used with {@link #url}, calls {@link #setUrl} with this value + * @cfg {String} content Raw content to fill content panel with (uses setContent on construction.) + * @cfg {Boolean} badges render the badges + + * @constructor + * Create a new ContentPanel. + * @param {String/HTMLElement/Roo.Element} el The container element for this panel + * @param {String/Object} config A string to set only the title or a config object + * @param {String} content (optional) Set the HTML content for this panel + * @param {String} region (optional) Used by xtype constructors to add to regions. (values center,east,west,south,north) + */ +Roo.bootstrap.panel.Content = function( config){ + + this.tpl = config.tpl || false; + + var el = config.el; + var content = config.content; + + if(config.autoCreate){ // xtype is available if this is called from factory + el = Roo.id(); + } + this.el = Roo.get(el); + if(!this.el && config && config.autoCreate){ + if(typeof config.autoCreate == "object"){ + if(!config.autoCreate.id){ + config.autoCreate.id = config.id||el; + } + this.el = Roo.DomHelper.append(document.body, + config.autoCreate, true); + }else{ + var elcfg = { tag: "div", + cls: "roo-layout-inactive-content", + id: config.id||el + }; + if (config.html) { + elcfg.html = config.html; + + } + + this.el = Roo.DomHelper.append(document.body, elcfg , true); + } + } + this.closable = false; + this.loaded = false; + this.active = false; + + + if (config.toolbar && !config.toolbar.el && config.toolbar.xtype) { + + this.toolbar = new config.toolbar.xns[config.toolbar.xtype](config.toolbar); + + this.wrapEl = this.el; //this.el.wrap(); + var ti = []; + if (config.toolbar.items) { + ti = config.toolbar.items ; + delete config.toolbar.items ; + } + + var nitems = []; + this.toolbar.render(this.wrapEl, 'before'); + for(var i =0;i < ti.length;i++) { + // Roo.log(['add child', items[i]]); + nitems.push(this.toolbar.addxtype(Roo.apply({}, ti[i]))); + } + this.toolbar.items = nitems; + this.toolbar.el.insertBefore(this.wrapEl.dom.firstChild); + delete config.toolbar; + + } + /* + // xtype created footer. - not sure if will work as we normally have to render first.. + if (this.footer && !this.footer.el && this.footer.xtype) { + if (!this.wrapEl) { + this.wrapEl = this.el.wrap(); + } + + this.footer.container = this.wrapEl.createChild(); + + this.footer = Roo.factory(this.footer, Roo); + + } + */ + + if(typeof config == "string"){ + this.title = config; + }else{ + Roo.apply(this, config); + } + + if(this.resizeEl){ + this.resizeEl = Roo.get(this.resizeEl, true); + }else{ + this.resizeEl = this.el; + } + // handle view.xtype + + + + + this.addEvents({ + /** + * @event activate + * Fires when this panel is activated. + * @param {Roo.ContentPanel} this + */ + "activate" : true, + /** + * @event deactivate + * Fires when this panel is activated. + * @param {Roo.ContentPanel} this + */ + "deactivate" : true, + + /** + * @event resize + * Fires when this panel is resized if fitToFrame is true. + * @param {Roo.ContentPanel} this + * @param {Number} width The width after any component adjustments + * @param {Number} height The height after any component adjustments + */ + "resize" : true, + + /** + * @event render + * Fires when this tab is created + * @param {Roo.ContentPanel} this + */ + "render" : true + + + + }); + + + + + if(this.autoScroll){ + this.resizeEl.setStyle("overflow", "auto"); + } else { + // fix randome scrolling + //this.el.on('scroll', function() { + // Roo.log('fix random scolling'); + // this.scrollTo('top',0); + //}); + } + content = content || this.content; + if(content){ + this.setContent(content); + } + if(config && config.url){ + this.setUrl(this.url, this.params, this.loadOnce); + } + + + + Roo.bootstrap.panel.Content.superclass.constructor.call(this); + + if (this.view && typeof(this.view.xtype) != 'undefined') { + this.view.el = this.el.appendChild(document.createElement("div")); + this.view = Roo.factory(this.view); + this.view.render && this.view.render(false, ''); + } + + + this.fireEvent('render', this); +}; + +Roo.extend(Roo.bootstrap.panel.Content, Roo.bootstrap.Component, { + + tabTip : '', + + setRegion : function(region){ + this.region = region; + this.setActiveClass(region && !this.background); + }, + + + setActiveClass: function(state) + { + if(state){ + this.el.replaceClass("roo-layout-inactive-content", "roo-layout-active-content"); + this.el.setStyle('position','relative'); + }else{ + this.el.replaceClass("roo-layout-active-content", "roo-layout-inactive-content"); + this.el.setStyle('position', 'absolute'); + } + }, + + /** + * Returns the toolbar for this Panel if one was configured. + * @return {Roo.Toolbar} + */ + getToolbar : function(){ + return this.toolbar; + }, + + setActiveState : function(active) + { + this.active = active; + this.setActiveClass(active); + if(!active){ + if(this.fireEvent("deactivate", this) === false){ + return false; + } + return true; + } + this.fireEvent("activate", this); + return true; + }, + /** + * Updates this panel's element + * @param {String} content The new content + * @param {Boolean} loadScripts (optional) true to look for and process scripts + */ + setContent : function(content, loadScripts){ + this.el.update(content, loadScripts); + }, + + ignoreResize : function(w, h){ + if(this.lastSize && this.lastSize.width == w && this.lastSize.height == h){ + return true; + }else{ + this.lastSize = {width: w, height: h}; + return false; + } + }, + /** + * Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates. + * @return {Roo.UpdateManager} The UpdateManager + */ + getUpdateManager : function(){ + return this.el.getUpdateManager(); + }, + /** + * Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}. + * @param {Object/String/Function} url The url for this request or a function to call to get the url or a config object containing any of the following options: +<pre><code> +panel.load({ + url: "your-url.php", + params: {param1: "foo", param2: "bar"}, // or a URL encoded string + callback: yourFunction, + scope: yourObject, //(optional scope) + discardUrl: false, + nocache: false, + text: "Loading...", + timeout: 30, + scripts: false +}); +</code></pre> + * The only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i> + * are shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance. + * @param {String/Object} params (optional) The parameters to pass as either a URL encoded string "param1=1&amp;param2=2" or an object {param1: 1, param2: 2} + * @param {Function} callback (optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse) + * @param {Boolean} discardUrl (optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL. + * @return {Roo.ContentPanel} this + */ + load : function(){ + var um = this.el.getUpdateManager(); + um.update.apply(um, arguments); + return this; + }, + + + /** + * Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL. + * @param {String/Function} url The URL to load the content from or a function to call to get the URL + * @param {String/Object} params (optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null) + * @param {Boolean} loadOnce (optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false) + * @return {Roo.UpdateManager} The UpdateManager + */ + setUrl : function(url, params, loadOnce){ + if(this.refreshDelegate){ + this.removeListener("activate", this.refreshDelegate); + } + this.refreshDelegate = this._handleRefresh.createDelegate(this, [url, params, loadOnce]); + this.on("activate", this.refreshDelegate); + return this.el.getUpdateManager(); + }, + + _handleRefresh : function(url, params, loadOnce){ + if(!loadOnce || !this.loaded){ + var updater = this.el.getUpdateManager(); + updater.update(url, params, this._setLoaded.createDelegate(this)); + } + }, + + _setLoaded : function(){ + this.loaded = true; + }, + + /** + * Returns this panel's id + * @return {String} + */ + getId : function(){ + return this.el.id; + }, + + /** + * Returns this panel's element - used by regiosn to add. + * @return {Roo.Element} + */ + getEl : function(){ + return this.wrapEl || this.el; + }, + + + + adjustForComponents : function(width, height) + { + //Roo.log('adjustForComponents '); + if(this.resizeEl != this.el){ + width -= this.el.getFrameWidth('lr'); + height -= this.el.getFrameWidth('tb'); + } + if(this.toolbar){ + var te = this.toolbar.getEl(); + te.setWidth(width); + height -= te.getHeight(); + } + if(this.footer){ + var te = this.footer.getEl(); + te.setWidth(width); + height -= te.getHeight(); + } + + + if(this.adjustments){ + width += this.adjustments[0]; + height += this.adjustments[1]; + } + return {"width": width, "height": height}; + }, + + setSize : function(width, height){ + if(this.fitToFrame && !this.ignoreResize(width, height)){ + if(this.fitContainer && this.resizeEl != this.el){ + this.el.setSize(width, height); + } + var size = this.adjustForComponents(width, height); + this.resizeEl.setSize(this.autoWidth ? "auto" : size.width, this.autoHeight ? "auto" : size.height); + this.fireEvent('resize', this, size.width, size.height); + } + }, + + /** + * Returns this panel's title + * @return {String} + */ + getTitle : function(){ + + if (typeof(this.title) != 'object') { + return this.title; + } + + var t = ''; + for (var k in this.title) { + if (!this.title.hasOwnProperty(k)) { + continue; + } + + if (k.indexOf('-') >= 0) { + var s = k.split('-'); + for (var i = 0; i<s.length; i++) { + t += "<span class='visible-"+s[i]+"'>"+this.title[k]+"</span>"; + } + } else { + t += "<span class='visible-"+k+"'>"+this.title[k]+"</span>"; + } + } + return t; + }, + + /** + * Set this panel's title + * @param {String} title + */ + setTitle : function(title){ + this.title = title; + if(this.region){ + this.region.updatePanelTitle(this, title); + } + }, + + /** + * Returns true is this panel was configured to be closable + * @return {Boolean} + */ + isClosable : function(){ + return this.closable; + }, + + beforeSlide : function(){ + this.el.clip(); + this.resizeEl.clip(); + }, + + afterSlide : function(){ + this.el.unclip(); + this.resizeEl.unclip(); + }, + + /** + * Force a content refresh from the URL specified in the {@link #setUrl} method. + * Will fail silently if the {@link #setUrl} method has not been called. + * This does not activate the panel, just updates its content. + */ + refresh : function(){ + if(this.refreshDelegate){ + this.loaded = false; + this.refreshDelegate(); + } + }, + + /** + * Destroys this panel + */ + destroy : function(){ + this.el.removeAllListeners(); + var tempEl = document.createElement("span"); + tempEl.appendChild(this.el.dom); + tempEl.innerHTML = ""; + this.el.remove(); + this.el = null; + }, + + /** + * form - if the content panel contains a form - this is a reference to it. + * @type {Roo.form.Form} + */ + form : false, + /** + * view - if the content panel contains a view (Roo.DatePicker / Roo.View / Roo.JsonView) + * This contains a reference to it. + * @type {Roo.View} + */ + view : false, + + /** + * Adds a xtype elements to the panel - currently only supports Forms, View, JsonView. + * <pre><code> + +layout.addxtype({ + xtype : 'Form', + items: [ .... ] + } +); + +</code></pre> + * @param {Object} cfg Xtype definition of item to add. + */ + + + getChildContainer: function () { + return this.getEl(); + } + + + /* + var ret = new Roo.factory(cfg); + return ret; + + + // add form.. + if (cfg.xtype.match(/^Form$/)) { + + var el; + //if (this.footer) { + // el = this.footer.container.insertSibling(false, 'before'); + //} else { + el = this.el.createChild(); + //} + + this.form = new Roo.form.Form(cfg); + + + if ( this.form.allItems.length) { + this.form.render(el.dom); + } + return this.form; + } + // should only have one of theses.. + if ([ 'View', 'JsonView', 'DatePicker'].indexOf(cfg.xtype) > -1) { + // views.. should not be just added - used named prop 'view'' + + cfg.el = this.el.appendChild(document.createElement("div")); + // factory? + + var ret = new Roo.factory(cfg); + + ret.render && ret.render(false, ''); // render blank.. + this.view = ret; + return ret; + } + return false; + } + \*/ +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_panel_Grid.js.html b/docs2/src/Roo_bootstrap_panel_Grid.js.html new file mode 100644 index 0000000000..90798fd19e --- /dev/null +++ b/docs2/src/Roo_bootstrap_panel_Grid.js.html @@ -0,0 +1,144 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/panel/Grid.js +/** + * @class Roo.bootstrap.panel.Grid + * @extends Roo.bootstrap.panel.Content + * @constructor + * Create a new GridPanel. + * @cfg {Roo.bootstrap.Table} grid The grid for this panel + * @param {Object} config A the config object + + */ + + + +Roo.bootstrap.panel.Grid = function(config) +{ + + + this.wrapper = Roo.DomHelper.append(document.body, // wrapper for IE7 strict & safari scroll issue + {tag: "div", cls: "roo-layout-grid-wrapper roo-layout-inactive-content"}, true); + + config.el = this.wrapper; + //this.el = this.wrapper; + + if (config.container) { + // ctor'ed from a Border/panel.grid + + + this.wrapper.setStyle("overflow", "hidden"); + this.wrapper.addClass('roo-grid-container'); + + } + + + if(config.toolbar){ + var tool_el = this.wrapper.createChild(); + this.toolbar = Roo.factory(config.toolbar); + var ti = []; + if (config.toolbar.items) { + ti = config.toolbar.items ; + delete config.toolbar.items ; + } + + var nitems = []; + this.toolbar.render(tool_el); + for(var i =0;i < ti.length;i++) { + // Roo.log(['add child', items[i]]); + nitems.push(this.toolbar.addxtype(Roo.apply({}, ti[i]))); + } + this.toolbar.items = nitems; + + delete config.toolbar; + } + + Roo.bootstrap.panel.Grid.superclass.constructor.call(this, config); + config.grid.scrollBody = true;; + config.grid.monitorWindowResize = false; // turn off autosizing + config.grid.autoHeight = false; + config.grid.autoWidth = false; + + this.grid = new config.grid.xns[config.grid.xtype](config.grid); + + if (config.background) { + // render grid on panel activation (if panel background) + this.on('activate', function(gp) { + if (!gp.grid.rendered) { + gp.grid.render(this.wrapper); + gp.grid.getGridEl().replaceClass("roo-layout-inactive-content", "roo-layout-component-panel"); + } + }); + + } else { + this.grid.render(this.wrapper); + this.grid.getGridEl().replaceClass("roo-layout-inactive-content", "roo-layout-component-panel"); + + } + //this.wrapper.dom.appendChild(config.grid.getGridEl().dom); + // ??? needed ??? config.el = this.wrapper; + + + + + // xtype created footer. - not sure if will work as we normally have to render first.. + if (this.footer && !this.footer.el && this.footer.xtype) { + + var ctr = this.grid.getView().getFooterPanel(true); + this.footer.dataSource = this.grid.dataSource; + this.footer = Roo.factory(this.footer, Roo); + this.footer.render(ctr); + + } + + + + + +}; + +Roo.extend(Roo.bootstrap.panel.Grid, Roo.bootstrap.panel.Content, { + getId : function(){ + return this.grid.id; + }, + + /** + * Returns the grid for this panel + * @return {Roo.bootstrap.Table} + */ + getGrid : function(){ + return this.grid; + }, + + setSize : function(width, height){ + if(!this.ignoreResize(width, height)){ + var grid = this.grid; + var size = this.adjustForComponents(width, height); + var gridel = grid.getGridEl(); + gridel.setSize(size.width, size.height); + /* + var thd = grid.getGridEl().select('thead',true).first(); + var tbd = grid.getGridEl().select('tbody', true).first(); + if (tbd) { + tbd.setSize(width, height - thd.getHeight()); + } + */ + grid.autoSize(); + } + }, + + + + beforeSlide : function(){ + this.grid.getView().scroller.clip(); + }, + + afterSlide : function(){ + this.grid.getView().scroller.unclip(); + }, + + destroy : function(){ + this.grid.destroy(); + delete this.grid; + Roo.bootstrap.panel.Grid.superclass.destroy.call(this); + } +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_panel_Nest.js.html b/docs2/src/Roo_bootstrap_panel_Nest.js.html new file mode 100644 index 0000000000..aeec218cea --- /dev/null +++ b/docs2/src/Roo_bootstrap_panel_Nest.js.html @@ -0,0 +1,133 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/panel/Nest.js +/** + * @class Roo.bootstrap.panel.Nest + * @extends Roo.bootstrap.panel.Content + * @constructor + * Create a new Panel, that can contain a layout.Border. + * + * + * @param {Roo.BorderLayout} layout The layout for this panel + * @param {String/Object} config A string to set only the title or a config object + */ +Roo.bootstrap.panel.Nest = function(config) +{ + // construct with only one argument.. + /* FIXME - implement nicer consturctors + if (layout.layout) { + config = layout; + layout = config.layout; + delete config.layout; + } + if (layout.xtype && !layout.getEl) { + // then layout needs constructing.. + layout = Roo.factory(layout, Roo); + } + */ + + config.el = config.layout.getEl(); + + Roo.bootstrap.panel.Nest.superclass.constructor.call(this, config); + + config.layout.monitorWindowResize = false; // turn off autosizing + this.layout = config.layout; + this.layout.getEl().addClass("roo-layout-nested-layout"); + this.layout.parent = this; + + + + +}; + +Roo.extend(Roo.bootstrap.panel.Nest, Roo.bootstrap.panel.Content, { + + setSize : function(width, height){ + if(!this.ignoreResize(width, height)){ + var size = this.adjustForComponents(width, height); + var el = this.layout.getEl(); + if (size.height < 1) { + el.setWidth(size.width); + } else { + el.setSize(size.width, size.height); + } + var touch = el.dom.offsetWidth; + this.layout.layout(); + // ie requires a double layout on the first pass + if(Roo.isIE && !this.initialized){ + this.initialized = true; + this.layout.layout(); + } + } + }, + + // activate all subpanels if not currently active.. + + setActiveState : function(active){ + this.active = active; + this.setActiveClass(active); + + if(!active){ + this.fireEvent("deactivate", this); + return; + } + + this.fireEvent("activate", this); + // not sure if this should happen before or after.. + if (!this.layout) { + return; // should not happen.. + } + var reg = false; + for (var r in this.layout.regions) { + reg = this.layout.getRegion(r); + if (reg.getActivePanel()) { + //reg.showPanel(reg.getActivePanel()); // force it to activate.. + reg.setActivePanel(reg.getActivePanel()); + continue; + } + if (!reg.panels.length) { + continue; + } + reg.showPanel(reg.getPanel(0)); + } + + + + + }, + + /** + * Returns the nested BorderLayout for this panel + * @return {Roo.BorderLayout} + */ + getLayout : function(){ + return this.layout; + }, + + /** + * Adds a xtype elements to the layout of the nested panel + * <pre><code> + +panel.addxtype({ + xtype : 'ContentPanel', + region: 'west', + items: [ .... ] + } +); + +panel.addxtype({ + xtype : 'NestedLayoutPanel', + region: 'west', + layout: { + center: { }, + west: { } + }, + items : [ ... list of content panels or nested layout panels.. ] + } +); +</code></pre> + * @param {Object} cfg Xtype definition of item to add. + */ + addxtype : function(cfg) { + return this.layout.addxtype(cfg); + + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_panel_TabItem.js.html b/docs2/src/Roo_bootstrap_panel_TabItem.js.html new file mode 100644 index 0000000000..8bb1e46fff --- /dev/null +++ b/docs2/src/Roo_bootstrap_panel_TabItem.js.html @@ -0,0 +1,324 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/panel/TabItem.js +/** + * @class Roo.TabPanelItem + * @extends Roo.util.Observable + * Represents an individual item (tab plus body) in a TabPanel. + * @param {Roo.TabPanel} tabPanel The {@link Roo.TabPanel} this TabPanelItem belongs to + * @param {String} id The id of this TabPanelItem + * @param {String} text The text for the tab of this TabPanelItem + * @param {Boolean} closable True to allow this TabPanelItem to be closable (defaults to false) + */ +Roo.bootstrap.panel.TabItem = function(config){ + /** + * The {@link Roo.TabPanel} this TabPanelItem belongs to + * @type Roo.TabPanel + */ + this.tabPanel = config.panel; + /** + * The id for this TabPanelItem + * @type String + */ + this.id = config.id; + /** @private */ + this.disabled = false; + /** @private */ + this.text = config.text; + /** @private */ + this.loaded = false; + this.closable = config.closable; + + /** + * The body element for this TabPanelItem. + * @type Roo.Element + */ + this.bodyEl = Roo.get(this.tabPanel.createItemBody(this.tabPanel.bodyEl.dom, config.id)); + this.bodyEl.setVisibilityMode(Roo.Element.VISIBILITY); + this.bodyEl.setStyle("display", "block"); + this.bodyEl.setStyle("zoom", "1"); + //this.hideAction(); + + var els = this.tabPanel.createStripElements(this.tabPanel.stripEl.dom, config.text, config.closable, config.tpl); + /** @private */ + this.el = Roo.get(els.el); + this.inner = Roo.get(els.inner, true); + this.textEl = Roo.bootstrap.version == 4 ? + this.el : Roo.get(this.el.dom.firstChild, true); + + this.pnode = this.linode = Roo.get(els.el.parentNode, true); + this.status_node = Roo.bootstrap.version == 4 ? this.el : this.linode; + + +// this.el.on("mousedown", this.onTabMouseDown, this); + this.el.on("click", this.onTabClick, this); + /** @private */ + if(config.closable){ + var c = Roo.get(els.close, true); + c.dom.title = this.closeText; + c.addClassOnOver("close-over"); + c.on("click", this.closeClick, this); + } + + this.addEvents({ + /** + * @event activate + * Fires when this tab becomes the active tab. + * @param {Roo.TabPanel} tabPanel The parent TabPanel + * @param {Roo.TabPanelItem} this + */ + "activate": true, + /** + * @event beforeclose + * Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true). + * @param {Roo.TabPanelItem} this + * @param {Object} e Set cancel to true on this object to cancel the close. + */ + "beforeclose": true, + /** + * @event close + * Fires when this tab is closed. + * @param {Roo.TabPanelItem} this + */ + "close": true, + /** + * @event deactivate + * Fires when this tab is no longer the active tab. + * @param {Roo.TabPanel} tabPanel The parent TabPanel + * @param {Roo.TabPanelItem} this + */ + "deactivate" : true + }); + this.hidden = false; + + Roo.bootstrap.panel.TabItem.superclass.constructor.call(this); +}; + +Roo.extend(Roo.bootstrap.panel.TabItem, Roo.util.Observable, + { + purgeListeners : function(){ + Roo.util.Observable.prototype.purgeListeners.call(this); + this.el.removeAllListeners(); + }, + /** + * Shows this TabPanelItem -- this <b>does not</b> deactivate the currently active TabPanelItem. + */ + show : function(){ + this.status_node.addClass("active"); + this.showAction(); + if(Roo.isOpera){ + this.tabPanel.stripWrap.repaint(); + } + this.fireEvent("activate", this.tabPanel, this); + }, + + /** + * Returns true if this tab is the active tab. + * @return {Boolean} + */ + isActive : function(){ + return this.tabPanel.getActiveTab() == this; + }, + + /** + * Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd. + */ + hide : function(){ + this.status_node.removeClass("active"); + this.hideAction(); + this.fireEvent("deactivate", this.tabPanel, this); + }, + + hideAction : function(){ + this.bodyEl.hide(); + this.bodyEl.setStyle("position", "absolute"); + this.bodyEl.setLeft("-20000px"); + this.bodyEl.setTop("-20000px"); + }, + + showAction : function(){ + this.bodyEl.setStyle("position", "relative"); + this.bodyEl.setTop(""); + this.bodyEl.setLeft(""); + this.bodyEl.show(); + }, + + /** + * Set the tooltip for the tab. + * @param {String} tooltip The tab's tooltip + */ + setTooltip : function(text){ + if(Roo.QuickTips && Roo.QuickTips.isEnabled()){ + this.textEl.dom.qtip = text; + this.textEl.dom.removeAttribute('title'); + }else{ + this.textEl.dom.title = text; + } + }, + + onTabClick : function(e){ + e.preventDefault(); + this.tabPanel.activate(this.id); + }, + + onTabMouseDown : function(e){ + e.preventDefault(); + this.tabPanel.activate(this.id); + }, +/* + getWidth : function(){ + return this.inner.getWidth(); + }, + + setWidth : function(width){ + var iwidth = width - this.linode.getPadding("lr"); + this.inner.setWidth(iwidth); + this.textEl.setWidth(iwidth-this.inner.getPadding("lr")); + this.linode.setWidth(width); + }, +*/ + /** + * Show or hide the tab + * @param {Boolean} hidden True to hide or false to show. + */ + setHidden : function(hidden){ + this.hidden = hidden; + this.linode.setStyle("display", hidden ? "none" : ""); + }, + + /** + * Returns true if this tab is "hidden" + * @return {Boolean} + */ + isHidden : function(){ + return this.hidden; + }, + + /** + * Returns the text for this tab + * @return {String} + */ + getText : function(){ + return this.text; + }, + /* + autoSize : function(){ + //this.el.beginMeasure(); + this.textEl.setWidth(1); + /* + * #2804 [new] Tabs in Roojs + * increase the width by 2-4 pixels to prevent the ellipssis showing in chrome + */ + //this.setWidth(this.textEl.dom.scrollWidth+this.linode.getPadding("lr")+this.inner.getPadding("lr") + 2); + //this.el.endMeasure(); + //}, + + /** + * Sets the text for the tab (Note: this also sets the tooltip text) + * @param {String} text The tab's text and tooltip + */ + setText : function(text){ + this.text = text; + this.textEl.update(text); + this.setTooltip(text); + //if(!this.tabPanel.resizeTabs){ + // this.autoSize(); + //} + }, + /** + * Activates this TabPanelItem -- this <b>does</b> deactivate the currently active TabPanelItem. + */ + activate : function(){ + this.tabPanel.activate(this.id); + }, + + /** + * Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem. + */ + disable : function(){ + if(this.tabPanel.active != this){ + this.disabled = true; + this.status_node.addClass("disabled"); + } + }, + + /** + * Enables this TabPanelItem if it was previously disabled. + */ + enable : function(){ + this.disabled = false; + this.status_node.removeClass("disabled"); + }, + + /** + * Sets the content for this TabPanelItem. + * @param {String} content The content + * @param {Boolean} loadScripts true to look for and load scripts + */ + setContent : function(content, loadScripts){ + this.bodyEl.update(content, loadScripts); + }, + + /** + * Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates. + * @return {Roo.UpdateManager} The UpdateManager + */ + getUpdateManager : function(){ + return this.bodyEl.getUpdateManager(); + }, + + /** + * Set a URL to be used to load the content for this TabPanelItem. + * @param {String/Function} url The URL to load the content from, or a function to call to get the URL + * @param {String/Object} params (optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null) + * @param {Boolean} loadOnce (optional) Whether to only load the content once. If this is false it makes the Ajax call every time this TabPanelItem is activated. (Defaults to false) + * @return {Roo.UpdateManager} The UpdateManager + */ + setUrl : function(url, params, loadOnce){ + if(this.refreshDelegate){ + this.un('activate', this.refreshDelegate); + } + this.refreshDelegate = this._handleRefresh.createDelegate(this, [url, params, loadOnce]); + this.on("activate", this.refreshDelegate); + return this.bodyEl.getUpdateManager(); + }, + + /** @private */ + _handleRefresh : function(url, params, loadOnce){ + if(!loadOnce || !this.loaded){ + var updater = this.bodyEl.getUpdateManager(); + updater.update(url, params, this._setLoaded.createDelegate(this)); + } + }, + + /** + * Forces a content refresh from the URL specified in the {@link #setUrl} method. + * Will fail silently if the setUrl method has not been called. + * This does not activate the panel, just updates its content. + */ + refresh : function(){ + if(this.refreshDelegate){ + this.loaded = false; + this.refreshDelegate(); + } + }, + + /** @private */ + _setLoaded : function(){ + this.loaded = true; + }, + + /** @private */ + closeClick : function(e){ + var o = {}; + e.stopEvent(); + this.fireEvent("beforeclose", this, o); + if(o.cancel !== true){ + this.tabPanel.removeTab(this.id); + } + }, + /** + * The text displayed in the tooltip for the close icon. + * @type String + */ + closeText : "Close this tab" +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_panel_Tabs.js.html b/docs2/src/Roo_bootstrap_panel_Tabs.js.html new file mode 100644 index 0000000000..4838a24b32 --- /dev/null +++ b/docs2/src/Roo_bootstrap_panel_Tabs.js.html @@ -0,0 +1,612 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/panel/Tabs.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.TabPanel + * @extends Roo.util.Observable + * A lightweight tab container. + * <br><br> + * Usage: + * <pre><code> +// basic tabs 1, built from existing content +var tabs = new Roo.TabPanel("tabs1"); +tabs.addTab("script", "View Script"); +tabs.addTab("markup", "View Markup"); +tabs.activate("script"); + +// more advanced tabs, built from javascript +var jtabs = new Roo.TabPanel("jtabs"); +jtabs.addTab("jtabs-1", "Normal Tab", "My content was added during construction."); + +// set up the UpdateManager +var tab2 = jtabs.addTab("jtabs-2", "Ajax Tab 1"); +var updater = tab2.getUpdateManager(); +updater.setDefaultUrl("ajax1.htm"); +tab2.on('activate', updater.refresh, updater, true); + +// Use setUrl for Ajax loading +var tab3 = jtabs.addTab("jtabs-3", "Ajax Tab 2"); +tab3.setUrl("ajax2.htm", null, true); + +// Disabled tab +var tab4 = jtabs.addTab("tabs1-5", "Disabled Tab", "Can't see me cause I'm disabled"); +tab4.disable(); + +jtabs.activate("jtabs-1"); + * </code></pre> + * @constructor + * Create a new TabPanel. + * @param {String/HTMLElement/Roo.Element} container The id, DOM element or Roo.Element container where this TabPanel is to be rendered. + * @param {Object/Boolean} config Config object to set any properties for this TabPanel, or true to render the tabs on the bottom. + */ +Roo.bootstrap.panel.Tabs = function(config){ + /** + * The container element for this TabPanel. + * @type Roo.Element + */ + this.el = Roo.get(config.el); + delete config.el; + if(config){ + if(typeof config == "boolean"){ + this.tabPosition = config ? "bottom" : "top"; + }else{ + Roo.apply(this, config); + } + } + + if(this.tabPosition == "bottom"){ + // if tabs are at the bottom = create the body first. + this.bodyEl = Roo.get(this.createBody(this.el.dom)); + this.el.addClass("roo-tabs-bottom"); + } + // next create the tabs holders + + if (this.tabPosition == "west"){ + + var reg = this.region; // fake it.. + while (reg) { + if (!reg.mgr.parent) { + break; + } + reg = reg.mgr.parent.region; + } + Roo.log("got nest?"); + Roo.log(reg); + if (reg.mgr.getRegion('west')) { + var ctrdom = reg.mgr.getRegion('west').bodyEl.dom; + this.stripWrap = Roo.get(this.createStrip(ctrdom ), true); + this.stripEl = Roo.get(this.createStripList(this.stripWrap.dom), true); + this.stripEl.setVisibilityMode(Roo.Element.DISPLAY); + this.stripBody = Roo.get(this.stripWrap.dom.firstChild.firstChild, true); + + + } + + + } else { + + this.stripWrap = Roo.get(this.createStrip(this.el.dom), true); + this.stripEl = Roo.get(this.createStripList(this.stripWrap.dom), true); + this.stripEl.setVisibilityMode(Roo.Element.DISPLAY); + this.stripBody = Roo.get(this.stripWrap.dom.firstChild.firstChild, true); + } + + + if(Roo.isIE){ + Roo.fly(this.stripWrap.dom.firstChild).setStyle("overflow-x", "hidden"); + } + + // finally - if tabs are at the top, then create the body last.. + if(this.tabPosition != "bottom"){ + /** The body element that contains {@link Roo.TabPanelItem} bodies. + + * @type Roo.Element + */ + this.bodyEl = Roo.get(this.createBody(this.el.dom)); + this.el.addClass("roo-tabs-top"); + } + this.items = []; + + this.bodyEl.setStyle("position", "relative"); + + this.active = null; + this.activateDelegate = this.activate.createDelegate(this); + + this.addEvents({ + /** + * @event tabchange + * Fires when the active tab changes + * @param {Roo.TabPanel} this + * @param {Roo.TabPanelItem} activePanel The new active tab + */ + "tabchange": true, + /** + * @event beforetabchange + * Fires before the active tab changes, set cancel to true on the "e" parameter to cancel the change + * @param {Roo.TabPanel} this + * @param {Object} e Set cancel to true on this object to cancel the tab change + * @param {Roo.TabPanelItem} tab The tab being changed to + */ + "beforetabchange" : true + }); + + Roo.EventManager.onWindowResize(this.onResize, this); + this.cpad = this.el.getPadding("lr"); + this.hiddenCount = 0; + + + // toolbar on the tabbar support... + if (this.toolbar) { + alert("no toolbar support yet"); + this.toolbar = false; + /* + var tcfg = this.toolbar; + tcfg.container = this.stripEl.child('td.x-tab-strip-toolbar'); + this.toolbar = new Roo.Toolbar(tcfg); + if (Roo.isSafari) { + var tbl = tcfg.container.child('table', true); + tbl.setAttribute('width', '100%'); + } + */ + + } + + + + Roo.bootstrap.panel.Tabs.superclass.constructor.call(this); +}; + +Roo.extend(Roo.bootstrap.panel.Tabs, Roo.util.Observable, { + /* + *@cfg {String} tabPosition "top" or "bottom" (defaults to "top") + */ + tabPosition : "top", + /* + *@cfg {Number} currentTabWidth The width of the current tab (defaults to 0) + */ + currentTabWidth : 0, + /* + *@cfg {Number} minTabWidth The minimum width of a tab (defaults to 40) (ignored if {@link #resizeTabs} is not true) + */ + minTabWidth : 40, + /* + *@cfg {Number} maxTabWidth The maximum width of a tab (defaults to 250) (ignored if {@link #resizeTabs} is not true) + */ + maxTabWidth : 250, + /* + *@cfg {Number} preferredTabWidth The preferred (default) width of a tab (defaults to 175) (ignored if {@link #resizeTabs} is not true) + */ + preferredTabWidth : 175, + /* + *@cfg {Boolean} resizeTabs True to enable dynamic tab resizing (defaults to false) + */ + resizeTabs : false, + /* + *@cfg {Boolean} monitorResize Set this to true to turn on window resize monitoring (ignored if {@link #resizeTabs} is not true) (defaults to true) + */ + monitorResize : true, + /* + *@cfg {Object} toolbar xtype description of toolbar to show at the right of the tab bar. + */ + toolbar : false, // set by caller.. + + region : false, /// set by caller + + disableTooltips : true, // not used yet... + + /** + * Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one. + * @param {String} id The id of the div to use <b>or create</b> + * @param {String} text The text for the tab + * @param {String} content (optional) Content to put in the TabPanelItem body + * @param {Boolean} closable (optional) True to create a close icon on the tab + * @return {Roo.TabPanelItem} The created TabPanelItem + */ + addTab : function(id, text, content, closable, tpl) + { + var item = new Roo.bootstrap.panel.TabItem({ + panel: this, + id : id, + text : text, + closable : closable, + tpl : tpl + }); + this.addTabItem(item); + if(content){ + item.setContent(content); + } + return item; + }, + + /** + * Returns the {@link Roo.TabPanelItem} with the specified id/index + * @param {String/Number} id The id or index of the TabPanelItem to fetch. + * @return {Roo.TabPanelItem} + */ + getTab : function(id){ + return this.items[id]; + }, + + /** + * Hides the {@link Roo.TabPanelItem} with the specified id/index + * @param {String/Number} id The id or index of the TabPanelItem to hide. + */ + hideTab : function(id){ + var t = this.items[id]; + if(!t.isHidden()){ + t.setHidden(true); + this.hiddenCount++; + this.autoSizeTabs(); + } + }, + + /** + * "Unhides" the {@link Roo.TabPanelItem} with the specified id/index. + * @param {String/Number} id The id or index of the TabPanelItem to unhide. + */ + unhideTab : function(id){ + var t = this.items[id]; + if(t.isHidden()){ + t.setHidden(false); + this.hiddenCount--; + this.autoSizeTabs(); + } + }, + + /** + * Adds an existing {@link Roo.TabPanelItem}. + * @param {Roo.TabPanelItem} item The TabPanelItem to add + */ + addTabItem : function(item) + { + this.items[item.id] = item; + this.items.push(item); + this.autoSizeTabs(); + // if(this.resizeTabs){ + // item.setWidth(this.currentTabWidth || this.preferredTabWidth); + // this.autoSizeTabs(); +// }else{ +// item.autoSize(); + // } + }, + + /** + * Removes a {@link Roo.TabPanelItem}. + * @param {String/Number} id The id or index of the TabPanelItem to remove. + */ + removeTab : function(id){ + var items = this.items; + var tab = items[id]; + if(!tab) { return; } + var index = items.indexOf(tab); + if(this.active == tab && items.length > 1){ + var newTab = this.getNextAvailable(index); + if(newTab) { + newTab.activate(); + } + } + this.stripEl.dom.removeChild(tab.pnode.dom); + if(tab.bodyEl.dom.parentNode == this.bodyEl.dom){ // if it was moved already prevent error + this.bodyEl.dom.removeChild(tab.bodyEl.dom); + } + items.splice(index, 1); + delete this.items[tab.id]; + tab.fireEvent("close", tab); + tab.purgeListeners(); + this.autoSizeTabs(); + }, + + getNextAvailable : function(start){ + var items = this.items; + var index = start; + // look for a next tab that will slide over to + // replace the one being removed + while(index < items.length){ + var item = items[++index]; + if(item && !item.isHidden()){ + return item; + } + } + // if one isn't found select the previous tab (on the left) + index = start; + while(index >= 0){ + var item = items[--index]; + if(item && !item.isHidden()){ + return item; + } + } + return null; + }, + + /** + * Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored. + * @param {String/Number} id The id or index of the TabPanelItem to disable. + */ + disableTab : function(id){ + var tab = this.items[id]; + if(tab && this.active != tab){ + tab.disable(); + } + }, + + /** + * Enables a {@link Roo.TabPanelItem} that is disabled. + * @param {String/Number} id The id or index of the TabPanelItem to enable. + */ + enableTab : function(id){ + var tab = this.items[id]; + tab.enable(); + }, + + /** + * Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated. + * @param {String/Number} id The id or index of the TabPanelItem to activate. + * @return {Roo.TabPanelItem} The TabPanelItem. + */ + activate : function(id) + { + //Roo.log('activite:' + id); + + var tab = this.items[id]; + if(!tab){ + return null; + } + if(tab == this.active || tab.disabled){ + return tab; + } + var e = {}; + this.fireEvent("beforetabchange", this, e, tab); + if(e.cancel !== true && !tab.disabled){ + if(this.active){ + this.active.hide(); + } + this.active = this.items[id]; + this.active.show(); + this.fireEvent("tabchange", this, this.active); + } + return tab; + }, + + /** + * Gets the active {@link Roo.TabPanelItem}. + * @return {Roo.TabPanelItem} The active TabPanelItem or null if none are active. + */ + getActiveTab : function(){ + return this.active; + }, + + /** + * Updates the tab body element to fit the height of the container element + * for overflow scrolling + * @param {Number} targetHeight (optional) Override the starting height from the elements height + */ + syncHeight : function(targetHeight){ + var height = (targetHeight || this.el.getHeight())-this.el.getBorderWidth("tb")-this.el.getPadding("tb"); + var bm = this.bodyEl.getMargins(); + var newHeight = height-(this.stripWrap.getHeight()||0)-(bm.top+bm.bottom); + this.bodyEl.setHeight(newHeight); + return newHeight; + }, + + onResize : function(){ + if(this.monitorResize){ + this.autoSizeTabs(); + } + }, + + /** + * Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing) + */ + beginUpdate : function(){ + this.updating = true; + }, + + /** + * Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing) + */ + endUpdate : function(){ + this.updating = false; + this.autoSizeTabs(); + }, + + /** + * Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing) + */ + autoSizeTabs : function() + { + var count = this.items.length; + var vcount = count - this.hiddenCount; + + if (vcount < 2) { + this.stripEl.hide(); + } else { + this.stripEl.show(); + } + + if(!this.resizeTabs || count < 1 || vcount < 1 || this.updating) { + return; + } + + + var w = Math.max(this.el.getWidth() - this.cpad, 10); + var availWidth = Math.floor(w / vcount); + var b = this.stripBody; + if(b.getWidth() > w){ + var tabs = this.items; + this.setTabWidth(Math.max(availWidth, this.minTabWidth)-2); + if(availWidth < this.minTabWidth){ + /*if(!this.sleft){ // incomplete scrolling code + this.createScrollButtons(); + } + this.showScroll(); + this.stripClip.setWidth(w - (this.sleft.getWidth()+this.sright.getWidth()));*/ + } + }else{ + if(this.currentTabWidth < this.preferredTabWidth){ + this.setTabWidth(Math.min(availWidth, this.preferredTabWidth)-2); + } + } + }, + + /** + * Returns the number of tabs in this TabPanel. + * @return {Number} + */ + getCount : function(){ + return this.items.length; + }, + + /** + * Resizes all the tabs to the passed width + * @param {Number} The new width + */ + setTabWidth : function(width){ + this.currentTabWidth = width; + for(var i = 0, len = this.items.length; i < len; i++) { + if(!this.items[i].isHidden()) { + this.items[i].setWidth(width); + } + } + }, + + /** + * Destroys this TabPanel + * @param {Boolean} removeEl (optional) True to remove the element from the DOM as well (defaults to undefined) + */ + destroy : function(removeEl){ + Roo.EventManager.removeResizeListener(this.onResize, this); + for(var i = 0, len = this.items.length; i < len; i++){ + this.items[i].purgeListeners(); + } + if(removeEl === true){ + this.el.update(""); + this.el.remove(); + } + }, + + createStrip : function(container) + { + var strip = document.createElement("nav"); + strip.className = Roo.bootstrap.version == 4 ? + "navbar-light bg-light" : + "navbar navbar-default"; //"x-tabs-wrap"; + container.appendChild(strip); + return strip; + }, + + createStripList : function(strip) + { + // div wrapper for retard IE + // returns the "tr" element. + strip.innerHTML = '<ul class="nav nav-tabs" role="tablist"></ul>'; + //'<div class="x-tabs-strip-wrap">'+ + // '<table class="x-tabs-strip" cellspacing="0" cellpadding="0" border="0"><tbody><tr>'+ + // '<td class="x-tab-strip-toolbar"></td></tr></tbody></table></div>'; + return strip.firstChild; //.firstChild.firstChild.firstChild; + }, + createBody : function(container) + { + var body = document.createElement("div"); + Roo.id(body, "tab-body"); + //Roo.fly(body).addClass("x-tabs-body"); + Roo.fly(body).addClass("tab-content"); + container.appendChild(body); + return body; + }, + createItemBody :function(bodyEl, id){ + var body = Roo.getDom(id); + if(!body){ + body = document.createElement("div"); + body.id = id; + } + //Roo.fly(body).addClass("x-tabs-item-body"); + Roo.fly(body).addClass("tab-pane"); + bodyEl.insertBefore(body, bodyEl.firstChild); + return body; + }, + /** @private */ + createStripElements : function(stripEl, text, closable, tpl) + { + var td = document.createElement("li"); // was td.. + td.className = 'nav-item'; + + //stripEl.insertBefore(td, stripEl.childNodes[stripEl.childNodes.length-1]); + + + stripEl.appendChild(td); + /*if(closable){ + td.className = "x-tabs-closable"; + if(!this.closeTpl){ + this.closeTpl = new Roo.Template( + '<a href="#" class="x-tabs-right"><span class="x-tabs-left"><em class="x-tabs-inner">' + + '<span unselectable="on"' + (this.disableTooltips ? '' : ' title="{text}"') +' class="x-tabs-text">{text}</span>' + + '<div unselectable="on" class="close-icon">&#160;</div></em></span></a>' + ); + } + var el = this.closeTpl.overwrite(td, {"text": text}); + var close = el.getElementsByTagName("div")[0]; + var inner = el.getElementsByTagName("em")[0]; + return {"el": el, "close": close, "inner": inner}; + } else { + */ + // not sure what this is.. +// if(!this.tabTpl){ + //this.tabTpl = new Roo.Template( + // '<a href="#" class="x-tabs-right"><span class="x-tabs-left"><em class="x-tabs-inner">' + + // '<span unselectable="on"' + (this.disableTooltips ? '' : ' title="{text}"') +' class="x-tabs-text">{text}</span></em></span></a>' + //); +// this.tabTpl = new Roo.Template( +// '<a href="#">' + +// '<span unselectable="on"' + +// (this.disableTooltips ? '' : ' title="{text}"') + +// ' >{text}</span></a>' +// ); +// +// } + + + var template = tpl || this.tabTpl || false; + + if(!template){ + template = new Roo.Template( + Roo.bootstrap.version == 4 ? + ( + '<a class="nav-link" href="#" unselectable="on"' + + (this.disableTooltips ? '' : ' title="{text}"') + + ' >{text}</a>' + ) : ( + '<a class="nav-link" href="#">' + + '<span unselectable="on"' + + (this.disableTooltips ? '' : ' title="{text}"') + + ' >{text}</span></a>' + ) + ); + } + + switch (typeof(template)) { + case 'object' : + break; + case 'string' : + template = new Roo.Template(template); + break; + default : + break; + } + + var el = template.overwrite(td, {"text": text}); + + var inner = el.getElementsByTagName("span")[0]; + + return {"el": el, "inner": inner}; + + } + + +}); + \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_panel_panel-ns.js.html b/docs2/src/Roo_bootstrap_panel_panel-ns.js.html new file mode 100644 index 0000000000..621b4ce25e --- /dev/null +++ b/docs2/src/Roo_bootstrap_panel_panel-ns.js.html @@ -0,0 +1 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/panel/panel-ns.jsRoo.namespace("Roo.bootstrap.panel"); \ No newline at end of file diff --git a/docs2/src/Roo_bootstrap_version.js.html b/docs2/src/Roo_bootstrap_version.js.html new file mode 100644 index 0000000000..a496b18051 --- /dev/null +++ b/docs2/src/Roo_bootstrap_version.js.html @@ -0,0 +1,15 @@ +/home/alan/gitlive/roojs1/Roo/bootstrap/version.js/** + * set the version of bootstrap based on the stylesheet... + * + */ + +Roo.bootstrap.version = ( + function() { + var ret=3; + Roo.each(document.styleSheets[0], function(s) { + if (s.href.match(/css-bootstrap4/)) { + ret=4; + } + }); + return ret; +})(); \ No newline at end of file diff --git a/docs2/src/Roo_data_ArrayReader.js.html b/docs2/src/Roo_data_ArrayReader.js.html new file mode 100644 index 0000000000..8c059b5c6b --- /dev/null +++ b/docs2/src/Roo_data_ArrayReader.js.html @@ -0,0 +1,84 @@ +/home/alan/gitlive/roojs1/Roo/data/ArrayReader.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.data.ArrayReader + * @extends Roo.data.DataReader + * Data reader class to create an Array of Roo.data.Record objects from an Array. + * Each element of that Array represents a row of data fields. The + * fields are pulled into a Record object using as a subscript, the <em>mapping</em> property + * of the field definition if it exists, or the field's ordinal position in the definition.<br> + * <p> + * Example code:. + * <pre><code> +var RecordDef = Roo.data.Record.create([ + {name: 'name', mapping: 1}, // "mapping" only needed if an "id" field is present which + {name: 'occupation', mapping: 2} // precludes using the ordinal position as the index. +]); +var myReader = new Roo.data.ArrayReader({ + id: 0 // The subscript within row Array that provides an ID for the Record (optional) +}, RecordDef); +</code></pre> + * <p> + * This would consume an Array like this: + * <pre><code> +[ [1, 'Bill', 'Gardener'], [2, 'Ben', 'Horticulturalist'] ] + </code></pre> + * @cfg {String} id (optional) The subscript within row Array that provides an ID for the Record + * @constructor + * Create a new JsonReader + * @param {Object} meta Metadata configuration options. + * @param {Object} recordType Either an Array of field definition objects + * @cfg {Array} fields Array of field definition objects + * @cfg {String} id Name of the property within a row object that contains a record identifier value. + * as specified to {@link Roo.data.Record#create}, + * or an {@link Roo.data.Record} object + * created using {@link Roo.data.Record#create}. + */ +Roo.data.ArrayReader = function(meta, recordType){ + + + Roo.data.ArrayReader.superclass.constructor.call(this, meta, recordType||meta.fields); +}; + +Roo.extend(Roo.data.ArrayReader, Roo.data.JsonReader, { + /** + * Create a data block containing Roo.data.Records from an XML document. + * @param {Object} o An Array of row objects which represents the dataset. + * @return {Object} data A data block which is used by an Roo.data.Store object as + * a cache of Roo.data.Records. + */ + readRecords : function(o){ + var sid = this.meta ? this.meta.id : null; + var recordType = this.recordType, fields = recordType.prototype.fields; + var records = []; + var root = o; + for(var i = 0; i < root.length; i++){ + var n = root[i]; + var values = {}; + var id = ((sid || sid === 0) && n[sid] !== undefined && n[sid] !== "" ? n[sid] : null); + for(var j = 0, jlen = fields.length; j < jlen; j++){ + var f = fields.items[j]; + var k = f.mapping !== undefined && f.mapping !== null ? f.mapping : j; + var v = n[k] !== undefined ? n[k] : f.defaultValue; + v = f.convert(v); + values[f.name] = v; + } + var record = new recordType(values, id); + record.json = n; + records[records.length] = record; + } + return { + records : records, + totalRecords : records.length + }; + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_data_Connection.js.html b/docs2/src/Roo_data_Connection.js.html new file mode 100644 index 0000000000..7f1b64daa3 --- /dev/null +++ b/docs2/src/Roo_data_Connection.js.html @@ -0,0 +1,376 @@ +/home/alan/gitlive/roojs1/Roo/data/Connection.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + + +/** + * @class Roo.data.Connection + * @extends Roo.util.Observable + * The class encapsulates a connection to the page's originating domain, allowing requests to be made + * either to a configured URL, or to a URL specified at request time.<br><br> + * <p> + * Requests made by this class are asynchronous, and will return immediately. No data from + * the server will be available to the statement immediately following the {@link #request} call. + * To process returned data, use a callback in the request options object, or an event listener.</p><br> + * <p> + * Note: If you are doing a file upload, you will not get a normal response object sent back to + * your callback or event handler. Since the upload is handled via in IFRAME, there is no XMLHttpRequest. + * The response object is created using the innerHTML of the IFRAME's document as the responseText + * property and, if present, the IFRAME's XML document as the responseXML property.</p><br> + * This means that a valid XML or HTML document must be returned. If JSON data is required, it is suggested + * that it be placed either inside a &lt;textarea> in an HTML document and retrieved from the responseText + * using a regex, or inside a CDATA section in an XML document and retrieved from the responseXML using + * standard DOM methods. + * @constructor + * @param {Object} config a configuration object. + */ +Roo.data.Connection = function(config){ + Roo.apply(this, config); + this.addEvents({ + /** + * @event beforerequest + * Fires before a network request is made to retrieve a data object. + * @param {Connection} conn This Connection object. + * @param {Object} options The options config object passed to the {@link #request} method. + */ + "beforerequest" : true, + /** + * @event requestcomplete + * Fires if the request was successfully completed. + * @param {Connection} conn This Connection object. + * @param {Object} response The XHR object containing the response data. + * See {@link http://www.w3.org/TR/XMLHttpRequest/} for details. + * @param {Object} options The options config object passed to the {@link #request} method. + */ + "requestcomplete" : true, + /** + * @event requestexception + * Fires if an error HTTP status was returned from the server. + * See {@link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html} for details of HTTP status codes. + * @param {Connection} conn This Connection object. + * @param {Object} response The XHR object containing the response data. + * See {@link http://www.w3.org/TR/XMLHttpRequest/} for details. + * @param {Object} options The options config object passed to the {@link #request} method. + */ + "requestexception" : true + }); + Roo.data.Connection.superclass.constructor.call(this); +}; + +Roo.extend(Roo.data.Connection, Roo.util.Observable, { + /** + * @cfg {String} url (Optional) The default URL to be used for requests to the server. (defaults to undefined) + */ + /** + * @cfg {Object} extraParams (Optional) An object containing properties which are used as + * extra parameters to each request made by this object. (defaults to undefined) + */ + /** + * @cfg {Object} defaultHeaders (Optional) An object containing request headers which are added + * to each request made by this object. (defaults to undefined) + */ + /** + * @cfg {String} method (Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET) + */ + /** + * @cfg {Number} timeout (Optional) The timeout in milliseconds to be used for requests. (defaults to 30000) + */ + timeout : 30000, + /** + * @cfg {Boolean} autoAbort (Optional) Whether this request should abort any pending requests. (defaults to false) + * @type Boolean + */ + autoAbort:false, + + /** + * @cfg {Boolean} disableCaching (Optional) True to add a unique cache-buster param to GET requests. (defaults to true) + * @type Boolean + */ + disableCaching: true, + + /** + * Sends an HTTP request to a remote server. + * @param {Object} options An object which may contain the following properties:<ul> + * <li><b>url</b> {String} (Optional) The URL to which to send the request. Defaults to configured URL</li> + * <li><b>params</b> {Object/String/Function} (Optional) An object containing properties which are used as parameters to the + * request, a url encoded string or a function to call to get either.</li> + * <li><b>method</b> {String} (Optional) The HTTP method to use for the request. Defaults to the configured method, or + * if no method was configured, "GET" if no parameters are being sent, and "POST" if parameters are being sent.</li> + * <li><b>callback</b> {Function} (Optional) The function to be called upon receipt of the HTTP response. + * The callback is called regardless of success or failure and is passed the following parameters:<ul> + * <li>options {Object} The parameter to the request call.</li> + * <li>success {Boolean} True if the request succeeded.</li> + * <li>response {Object} The XMLHttpRequest object containing the response data.</li> + * </ul></li> + * <li><b>success</b> {Function} (Optional) The function to be called upon success of the request. + * The callback is passed the following parameters:<ul> + * <li>response {Object} The XMLHttpRequest object containing the response data.</li> + * <li>options {Object} The parameter to the request call.</li> + * </ul></li> + * <li><b>failure</b> {Function} (Optional) The function to be called upon failure of the request. + * The callback is passed the following parameters:<ul> + * <li>response {Object} The XMLHttpRequest object containing the response data.</li> + * <li>options {Object} The parameter to the request call.</li> + * </ul></li> + * <li><b>scope</b> {Object} (Optional) The scope in which to execute the callbacks: The "this" object + * for the callback function. Defaults to the browser window.</li> + * <li><b>form</b> {Object/String} (Optional) A form object or id to pull parameters from.</li> + * <li><b>isUpload</b> {Boolean} (Optional) True if the form object is a file upload (will usually be automatically detected).</li> + * <li><b>headers</b> {Object} (Optional) Request headers to set for the request.</li> + * <li><b>xmlData</b> {Object} (Optional) XML document to use for the post. Note: This will be used instead of + * params for the post data. Any params will be appended to the URL.</li> + * <li><b>disableCaching</b> {Boolean} (Optional) True to add a unique cache-buster param to GET requests.</li> + * </ul> + * @return {Number} transactionId + */ + request : function(o){ + if(this.fireEvent("beforerequest", this, o) !== false){ + var p = o.params; + + if(typeof p == "function"){ + p = p.call(o.scope||window, o); + } + if(typeof p == "object"){ + p = Roo.urlEncode(o.params); + } + if(this.extraParams){ + var extras = Roo.urlEncode(this.extraParams); + p = p ? (p + '&' + extras) : extras; + } + + var url = o.url || this.url; + if(typeof url == 'function'){ + url = url.call(o.scope||window, o); + } + + if(o.form){ + var form = Roo.getDom(o.form); + url = url || form.action; + + var enctype = form.getAttribute("enctype"); + + if (o.formData) { + return this.doFormDataUpload(o,p,url); + } + + if(o.isUpload || (enctype && enctype.toLowerCase() == 'multipart/form-data')){ + return this.doFormUpload(o, p, url); + } + var f = Roo.lib.Ajax.serializeForm(form); + p = p ? (p + '&' + f) : f; + } + + var hs = o.headers; + if(this.defaultHeaders){ + hs = Roo.apply(hs || {}, this.defaultHeaders); + if(!o.headers){ + o.headers = hs; + } + } + + var cb = { + success: this.handleResponse, + failure: this.handleFailure, + scope: this, + argument: {options: o}, + timeout : o.timeout || this.timeout + }; + + var method = o.method||this.method||(p ? "POST" : "GET"); + + if(method == 'GET' && (this.disableCaching && o.disableCaching !== false) || o.disableCaching === true){ + url += (url.indexOf('?') != -1 ? '&' : '?') + '_dc=' + (new Date().getTime()); + } + + if(typeof o.autoAbort == 'boolean'){ // options gets top priority + if(o.autoAbort){ + this.abort(); + } + }else if(this.autoAbort !== false){ + this.abort(); + } + + if((method == 'GET' && p) || o.xmlData){ + url += (url.indexOf('?') != -1 ? '&' : '?') + p; + p = ''; + } + this.transId = Roo.lib.Ajax.request(method, url, cb, p, o); + return this.transId; + }else{ + Roo.callback(o.callback, o.scope, [o, null, null]); + return null; + } + }, + + /** + * Determine whether this object has a request outstanding. + * @param {Number} transactionId (Optional) defaults to the last transaction + * @return {Boolean} True if there is an outstanding request. + */ + isLoading : function(transId){ + if(transId){ + return Roo.lib.Ajax.isCallInProgress(transId); + }else{ + return this.transId ? true : false; + } + }, + + /** + * Aborts any outstanding request. + * @param {Number} transactionId (Optional) defaults to the last transaction + */ + abort : function(transId){ + if(transId || this.isLoading()){ + Roo.lib.Ajax.abort(transId || this.transId); + } + }, + + // private + handleResponse : function(response){ + this.transId = false; + var options = response.argument.options; + response.argument = options ? options.argument : null; + this.fireEvent("requestcomplete", this, response, options); + Roo.callback(options.success, options.scope, [response, options]); + Roo.callback(options.callback, options.scope, [options, true, response]); + }, + + // private + handleFailure : function(response, e){ + this.transId = false; + var options = response.argument.options; + response.argument = options ? options.argument : null; + this.fireEvent("requestexception", this, response, options, e); + Roo.callback(options.failure, options.scope, [response, options]); + Roo.callback(options.callback, options.scope, [options, false, response]); + }, + + // private + doFormUpload : function(o, ps, url){ + var id = Roo.id(); + var frame = document.createElement('iframe'); + frame.id = id; + frame.name = id; + frame.className = 'x-hidden'; + if(Roo.isIE){ + frame.src = Roo.SSL_SECURE_URL; + } + document.body.appendChild(frame); + + if(Roo.isIE){ + document.frames[id].name = id; + } + + var form = Roo.getDom(o.form); + form.target = id; + form.method = 'POST'; + form.enctype = form.encoding = 'multipart/form-data'; + if(url){ + form.action = url; + } + + var hiddens, hd; + if(ps){ // add dynamic params + hiddens = []; + ps = Roo.urlDecode(ps, false); + for(var k in ps){ + if(ps.hasOwnProperty(k)){ + hd = document.createElement('input'); + hd.type = 'hidden'; + hd.name = k; + hd.value = ps[k]; + form.appendChild(hd); + hiddens.push(hd); + } + } + } + + function cb(){ + var r = { // bogus response object + responseText : '', + responseXML : null + }; + + r.argument = o ? o.argument : null; + + try { // + var doc; + if(Roo.isIE){ + doc = frame.contentWindow.document; + }else { + doc = (frame.contentDocument || window.frames[id].document); + } + if(doc && doc.body){ + r.responseText = doc.body.innerHTML; + } + if(doc && doc.XMLDocument){ + r.responseXML = doc.XMLDocument; + }else { + r.responseXML = doc; + } + } + catch(e) { + // ignore + } + + Roo.EventManager.removeListener(frame, 'load', cb, this); + + this.fireEvent("requestcomplete", this, r, o); + Roo.callback(o.success, o.scope, [r, o]); + Roo.callback(o.callback, o.scope, [o, true, r]); + + setTimeout(function(){document.body.removeChild(frame);}, 100); + } + + Roo.EventManager.on(frame, 'load', cb, this); + form.submit(); + + if(hiddens){ // remove dynamic params + for(var i = 0, len = hiddens.length; i < len; i++){ + form.removeChild(hiddens[i]); + } + } + }, + // this is a 'formdata version???' + + + doFormDataUpload : function(o, ps, url) + { + var form = Roo.getDom(o.form); + form.enctype = form.encoding = 'multipart/form-data'; + var formData = o.formData === true ? new FormData(form) : o.formData; + + var cb = { + success: this.handleResponse, + failure: this.handleFailure, + scope: this, + argument: {options: o}, + timeout : o.timeout || this.timeout + }; + + if(typeof o.autoAbort == 'boolean'){ // options gets top priority + if(o.autoAbort){ + this.abort(); + } + }else if(this.autoAbort !== false){ + this.abort(); + } + + //Roo.lib.Ajax.defaultPostHeader = null; + Roo.lib.Ajax.useDefaultHeader = false; + this.transId = Roo.lib.Ajax.request( "POST", url, cb, o.formData, o); + Roo.lib.Ajax.useDefaultHeader = true; + + + } + +}); + \ No newline at end of file diff --git a/docs2/src/Roo_data_DataProxy.js.html b/docs2/src/Roo_data_DataProxy.js.html new file mode 100644 index 0000000000..5e66391669 --- /dev/null +++ b/docs2/src/Roo_data_DataProxy.js.html @@ -0,0 +1,60 @@ +/home/alan/gitlive/roojs1/Roo/data/DataProxy.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.data.DataProxy + * @extends Roo.data.Observable + * This class is an abstract base class for implementations which provide retrieval of + * unformatted data objects.<br> + * <p> + * DataProxy implementations are usually used in conjunction with an implementation of Roo.data.DataReader + * (of the appropriate type which knows how to parse the data object) to provide a block of + * {@link Roo.data.Records} to an {@link Roo.data.Store}.<br> + * <p> + * Custom implementations must implement the load method as described in + * {@link Roo.data.HttpProxy#load}. + */ +Roo.data.DataProxy = function(){ + this.addEvents({ + /** + * @event beforeload + * Fires before a network request is made to retrieve a data object. + * @param {Object} This DataProxy object. + * @param {Object} params The params parameter to the load function. + */ + beforeload : true, + /** + * @event load + * Fires before the load method's callback is called. + * @param {Object} This DataProxy object. + * @param {Object} o The data object. + * @param {Object} arg The callback argument object passed to the load function. + */ + load : true, + /** + * @event loadexception + * Fires if an Exception occurs during data retrieval. + * @param {Object} This DataProxy object. + * @param {Object} o The data object. + * @param {Object} arg The callback argument object passed to the load function. + * @param {Object} e The Exception. + */ + loadexception : true + }); + Roo.data.DataProxy.superclass.constructor.call(this); +}; + +Roo.extend(Roo.data.DataProxy, Roo.util.Observable); + + /** + * @cfg {void} listeners (Not available) Constructor blocks listeners from being set + */ + \ No newline at end of file diff --git a/docs2/src/Roo_data_DataReader.js.html b/docs2/src/Roo_data_DataReader.js.html new file mode 100644 index 0000000000..410b0f46f9 --- /dev/null +++ b/docs2/src/Roo_data_DataReader.js.html @@ -0,0 +1,50 @@ +/home/alan/gitlive/roojs1/Roo/data/DataReader.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +// Base class for reading structured data from a data source. This class is intended to be +// extended (see ArrayReader, JsonReader and XmlReader) and should not be created directly. + +/** + * @class Roo.data.DataReader + * Base class for reading structured data from a data source. This class is intended to be + * extended (see {Roo.data.ArrayReader}, {Roo.data.JsonReader} and {Roo.data.XmlReader}) and should not be created directly. + */ + +Roo.data.DataReader = function(meta, recordType){ + + this.meta = meta; + + this.recordType = recordType instanceof Array ? + Roo.data.Record.create(recordType) : recordType; +}; + +Roo.data.DataReader.prototype = { + /** + * Create an empty record + * @param {Object} data (optional) - overlay some values + * @return {Roo.data.Record} record created. + */ + newRow : function(d) { + var da = {}; + this.recordType.prototype.fields.each(function(c) { + switch( c.type) { + case 'int' : da[c.name] = 0; break; + case 'date' : da[c.name] = new Date(); break; + case 'float' : da[c.name] = 0.0; break; + case 'boolean' : da[c.name] = false; break; + default : da[c.name] = ""; break; + } + + }); + return new this.recordType(Roo.apply(da, d)); + } + +}; \ No newline at end of file diff --git a/docs2/src/Roo_data_Field.js.html b/docs2/src/Roo_data_Field.js.html new file mode 100644 index 0000000000..81fe294001 --- /dev/null +++ b/docs2/src/Roo_data_Field.js.html @@ -0,0 +1,105 @@ +/home/alan/gitlive/roojs1/Roo/data/Field.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +Roo.data.Field = function(config){ + if(typeof config == "string"){ + config = {name: config}; + } + Roo.apply(this, config); + + if(!this.type){ + this.type = "auto"; + } + + var st = Roo.data.SortTypes; + // named sortTypes are supported, here we look them up + if(typeof this.sortType == "string"){ + this.sortType = st[this.sortType]; + } + + // set default sortType for strings and dates + if(!this.sortType){ + switch(this.type){ + case "string": + this.sortType = st.asUCString; + break; + case "date": + this.sortType = st.asDate; + break; + default: + this.sortType = st.none; + } + } + + // define once + var stripRe = /[\$,%]/g; + + // prebuilt conversion function for this field, instead of + // switching every time we're reading a value + if(!this.convert){ + var cv, dateFormat = this.dateFormat; + switch(this.type){ + case "": + case "auto": + case undefined: + cv = function(v){ return v; }; + break; + case "string": + cv = function(v){ return (v === undefined || v === null) ? '' : String(v); }; + break; + case "int": + cv = function(v){ + return v !== undefined && v !== null && v !== '' ? + parseInt(String(v).replace(stripRe, ""), 10) : ''; + }; + break; + case "float": + cv = function(v){ + return v !== undefined && v !== null && v !== '' ? + parseFloat(String(v).replace(stripRe, ""), 10) : ''; + }; + break; + case "bool": + case "boolean": + cv = function(v){ return v === true || v === "true" || v == 1; }; + break; + case "date": + cv = function(v){ + if(!v){ + return ''; + } + if(v instanceof Date){ + return v; + } + if(dateFormat){ + if(dateFormat == "timestamp"){ + return new Date(v*1000); + } + return Date.parseDate(v, dateFormat); + } + var parsed = Date.parse(v); + return parsed ? new Date(parsed) : null; + }; + break; + + } + this.convert = cv; + } +}; + +Roo.data.Field.prototype = { + dateFormat: null, + defaultValue: "", + mapping: null, + sortType : null, + sortDir : "ASC" +}; \ No newline at end of file diff --git a/docs2/src/Roo_data_HttpProxy.js.html b/docs2/src/Roo_data_HttpProxy.js.html new file mode 100644 index 0000000000..5c1588bbed --- /dev/null +++ b/docs2/src/Roo_data_HttpProxy.js.html @@ -0,0 +1,150 @@ +/home/alan/gitlive/roojs1/Roo/data/HttpProxy.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.data.HttpProxy + * @extends Roo.data.DataProxy + * An implementation of {@link Roo.data.DataProxy} that reads a data object from an {@link Roo.data.Connection} object + * configured to reference a certain URL.<br><br> + * <p> + * <em>Note that this class cannot be used to retrieve data from a domain other than the domain + * from which the running page was served.<br><br> + * <p> + * For cross-domain access to remote data, use an {@link Roo.data.ScriptTagProxy}.</em><br><br> + * <p> + * Be aware that to enable the browser to parse an XML document, the server must set + * the Content-Type header in the HTTP response to "text/xml". + * @constructor + * @param {Object} conn Connection config options to add to each request (e.g. {url: 'foo.php'} or + * an {@link Roo.data.Connection} object. If a Connection config is passed, the singleton {@link Roo.Ajax} object + * will be used to make the request. + */ +Roo.data.HttpProxy = function(conn){ + Roo.data.HttpProxy.superclass.constructor.call(this); + // is conn a conn config or a real conn? + this.conn = conn; + this.useAjax = !conn || !conn.events; + +}; + +Roo.extend(Roo.data.HttpProxy, Roo.data.DataProxy, { + // thse are take from connection... + + /** + * @cfg {String} url (Optional) The default URL to be used for requests to the server. (defaults to undefined) + */ + /** + * @cfg {Object} extraParams (Optional) An object containing properties which are used as + * extra parameters to each request made by this object. (defaults to undefined) + */ + /** + * @cfg {Object} defaultHeaders (Optional) An object containing request headers which are added + * to each request made by this object. (defaults to undefined) + */ + /** + * @cfg {String} method (Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET) + */ + /** + * @cfg {Number} timeout (Optional) The timeout in milliseconds to be used for requests. (defaults to 30000) + */ + /** + * @cfg {Boolean} autoAbort (Optional) Whether this request should abort any pending requests. (defaults to false) + * @type Boolean + */ + + + /** + * @cfg {Boolean} disableCaching (Optional) True to add a unique cache-buster param to GET requests. (defaults to true) + * @type Boolean + */ + /** + * Return the {@link Roo.data.Connection} object being used by this Proxy. + * @return {Connection} The Connection object. This object may be used to subscribe to events on + * a finer-grained basis than the DataProxy events. + */ + getConnection : function(){ + return this.useAjax ? Roo.Ajax : this.conn; + }, + + /** + * Load data from the configured {@link Roo.data.Connection}, read the data object into + * a block of Roo.data.Records using the passed {@link Roo.data.DataReader} implementation, and + * process that block using the passed callback. + * @param {Object} params An object containing properties which are to be used as HTTP parameters + * for the request to the remote server. + * @param {Roo.data.DataReader} reader The Reader object which converts the data + * object into a block of Roo.data.Records. + * @param {Function} callback The function into which to pass the block of Roo.data.Records. + * The function must be passed <ul> + * <li>The Record block object</li> + * <li>The "arg" argument from the load function</li> + * <li>A boolean success indicator</li> + * </ul> + * @param {Object} scope The scope in which to call the callback + * @param {Object} arg An optional argument which is passed to the callback as its second parameter. + */ + load : function(params, reader, callback, scope, arg){ + if(this.fireEvent("beforeload", this, params) !== false){ + var o = { + params : params || {}, + request: { + callback : callback, + scope : scope, + arg : arg + }, + reader: reader, + callback : this.loadResponse, + scope: this + }; + if(this.useAjax){ + Roo.applyIf(o, this.conn); + if(this.activeRequest){ + Roo.Ajax.abort(this.activeRequest); + } + this.activeRequest = Roo.Ajax.request(o); + }else{ + this.conn.request(o); + } + }else{ + callback.call(scope||this, null, arg, false); + } + }, + + // private + loadResponse : function(o, success, response){ + delete this.activeRequest; + if(!success){ + this.fireEvent("loadexception", this, o, response); + o.request.callback.call(o.request.scope, null, o.request.arg, false); + return; + } + var result; + try { + result = o.reader.read(response); + }catch(e){ + this.fireEvent("loadexception", this, o, response, e); + o.request.callback.call(o.request.scope, null, o.request.arg, false); + return; + } + + this.fireEvent("load", this, o, o.request.arg); + o.request.callback.call(o.request.scope, result, o.request.arg, true); + }, + + // private + update : function(dataSet){ + + }, + + // private + updateResponse : function(dataSet){ + + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_data_JsonReader.js.html b/docs2/src/Roo_data_JsonReader.js.html new file mode 100644 index 0000000000..1cf091ec78 --- /dev/null +++ b/docs2/src/Roo_data_JsonReader.js.html @@ -0,0 +1,212 @@ +/home/alan/gitlive/roojs1/Roo/data/JsonReader.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.data.JsonReader + * @extends Roo.data.DataReader + * Data reader class to create an Array of Roo.data.Record objects from a JSON response + * based on mappings in a provided Roo.data.Record constructor. + * + * The default behaviour of a store is to send ?_requestMeta=1, unless the class has recieved 'metaData' property + * in the reply previously. + * + * <p> + * Example code: + * <pre><code> +var RecordDef = Roo.data.Record.create([ + {name: 'name', mapping: 'name'}, // "mapping" property not needed if it's the same as "name" + {name: 'occupation'} // This field will use "occupation" as the mapping. +]); +var myReader = new Roo.data.JsonReader({ + totalProperty: "results", // The property which contains the total dataset size (optional) + root: "rows", // The property which contains an Array of row objects + id: "id" // The property within each row object that provides an ID for the record (optional) +}, RecordDef); +</code></pre> + * <p> + * This would consume a JSON file like this: + * <pre><code> +{ 'results': 2, 'rows': [ + { 'id': 1, 'name': 'Bill', occupation: 'Gardener' }, + { 'id': 2, 'name': 'Ben', occupation: 'Horticulturalist' } ] +} +</code></pre> + * @cfg {String} totalProperty Name of the property from which to retrieve the total number of records + * in the dataset. This is only needed if the whole dataset is not passed in one go, but is being + * paged from the remote server. + * @cfg {String} successProperty Name of the property from which to retrieve the success attribute used by forms. + * @cfg {String} root name of the property which contains the Array of row objects. + * @cfg {String} id Name of the property within a row object that contains a record identifier value. + * @cfg {Array} fields Array of field definition objects + * @constructor + * Create a new JsonReader + * @param {Object} meta Metadata configuration options + * @param {Object} recordType Either an Array of field definition objects, + * or an {@link Roo.data.Record} object created using {@link Roo.data.Record#create}. + */ +Roo.data.JsonReader = function(meta, recordType){ + + meta = meta || {}; + // set some defaults: + Roo.applyIf(meta, { + totalProperty: 'total', + successProperty : 'success', + root : 'data', + id : 'id' + }); + + Roo.data.JsonReader.superclass.constructor.call(this, meta, recordType||meta.fields); +}; +Roo.extend(Roo.data.JsonReader, Roo.data.DataReader, { + + /** + * @prop {Boolean} metaFromRemote - if the meta data was loaded from the remote source. + * Used by Store query builder to append _requestMeta to params. + * + */ + metaFromRemote : false, + /** + * This method is only used by a DataProxy which has retrieved data from a remote server. + * @param {Object} response The XHR object which contains the JSON data in its responseText. + * @return {Object} data A data block which is used by an Roo.data.Store object as + * a cache of Roo.data.Records. + */ + read : function(response){ + var json = response.responseText; + + var o = /* eval:var:o */ eval("("+json+")"); + if(!o) { + throw {message: "JsonReader.read: Json object not found"}; + } + + if(o.metaData){ + + delete this.ef; + this.metaFromRemote = true; + this.meta = o.metaData; + this.recordType = Roo.data.Record.create(o.metaData.fields); + this.onMetaChange(this.meta, this.recordType, o); + } + return this.readRecords(o); + }, + + // private function a store will implement + onMetaChange : function(meta, recordType, o){ + + }, + + /** + * @ignore + */ + simpleAccess: function(obj, subsc) { + return obj[subsc]; + }, + + /** + * @ignore + */ + getJsonAccessor: function(){ + var re = /[\[\.]/; + return function(expr) { + try { + return(re.test(expr)) + ? new Function("obj", "return obj." + expr) + : function(obj){ + return obj[expr]; + }; + } catch(e){} + return Roo.emptyFn; + }; + }(), + + /** + * Create a data block containing Roo.data.Records from an XML document. + * @param {Object} o An object which contains an Array of row objects in the property specified + * in the config as 'root, and optionally a property, specified in the config as 'totalProperty' + * which contains the total size of the dataset. + * @return {Object} data A data block which is used by an Roo.data.Store object as + * a cache of Roo.data.Records. + */ + readRecords : function(o){ + /** + * After any data loads, the raw JSON data is available for further custom processing. + * @type Object + */ + this.o = o; + var s = this.meta, Record = this.recordType, + f = Record ? Record.prototype.fields : null, fi = f ? f.items : [], fl = f ? f.length : 0; + +// Generate extraction functions for the totalProperty, the root, the id, and for each field + if (!this.ef) { + if(s.totalProperty) { + this.getTotal = this.getJsonAccessor(s.totalProperty); + } + if(s.successProperty) { + this.getSuccess = this.getJsonAccessor(s.successProperty); + } + this.getRoot = s.root ? this.getJsonAccessor(s.root) : function(p){return p;}; + if (s.id) { + var g = this.getJsonAccessor(s.id); + this.getId = function(rec) { + var r = g(rec); + return (r === undefined || r === "") ? null : r; + }; + } else { + this.getId = function(){return null;}; + } + this.ef = []; + for(var jj = 0; jj < fl; jj++){ + f = fi[jj]; + var map = (f.mapping !== undefined && f.mapping !== null) ? f.mapping : f.name; + this.ef[jj] = this.getJsonAccessor(map); + } + } + + var root = this.getRoot(o), c = root.length, totalRecords = c, success = true; + if(s.totalProperty){ + var vt = parseInt(this.getTotal(o), 10); + if(!isNaN(vt)){ + totalRecords = vt; + } + } + if(s.successProperty){ + var vs = this.getSuccess(o); + if(vs === false || vs === 'false'){ + success = false; + } + } + var records = []; + for(var i = 0; i < c; i++){ + var n = root[i]; + var values = {}; + var id = this.getId(n); + for(var j = 0; j < fl; j++){ + f = fi[j]; + var v = this.ef[j](n); + if (!f.convert) { + Roo.log('missing convert for ' + f.name); + Roo.log(f); + continue; + } + values[f.name] = f.convert((v !== undefined) ? v : f.defaultValue); + } + var record = new Record(values, id); + record.json = n; + records[i] = record; + } + return { + raw : o, + success : success, + records : records, + totalRecords : totalRecords + }; + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_data_JsonStore.js.html b/docs2/src/Roo_data_JsonStore.js.html new file mode 100644 index 0000000000..1efce4e71b --- /dev/null +++ b/docs2/src/Roo_data_JsonStore.js.html @@ -0,0 +1,36 @@ +/home/alan/gitlive/roojs1/Roo/data/JsonStore.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** +/** + * @extends Roo.data.Store + * @class Roo.data.JsonStore + * Small helper class to make creating Stores for JSON data easier. <br/> +<pre><code> +var store = new Roo.data.JsonStore({ + url: 'get-images.php', + root: 'images', + fields: ['name', 'url', {name:'size', type: 'float'}, {name:'lastmod', type:'date'}] +}); +</code></pre> + * <b>Note: Although they are not listed, this class inherits all of the config options of Store, + * JsonReader and HttpProxy (unless inline data is provided).</b> + * @cfg {Array} fields An array of field definition objects, or field name strings. + * @constructor + * @param {Object} config + */ +Roo.data.JsonStore = function(c){ + Roo.data.JsonStore.superclass.constructor.call(this, Roo.apply(c, { + proxy: !c.data ? new Roo.data.HttpProxy({url: c.url}) : undefined, + reader: new Roo.data.JsonReader(c, c.fields) + })); +}; +Roo.extend(Roo.data.JsonStore, Roo.data.Store); \ No newline at end of file diff --git a/docs2/src/Roo_data_MemoryProxy.js.html b/docs2/src/Roo_data_MemoryProxy.js.html new file mode 100644 index 0000000000..fe7a5ea20f --- /dev/null +++ b/docs2/src/Roo_data_MemoryProxy.js.html @@ -0,0 +1,62 @@ +/home/alan/gitlive/roojs1/Roo/data/MemoryProxy.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.data.MemoryProxy + * An implementation of Roo.data.DataProxy that simply passes the data specified in its constructor + * to the Reader when its load method is called. + * @constructor + * @param {Object} data The data object which the Reader uses to construct a block of Roo.data.Records. + */ +Roo.data.MemoryProxy = function(data){ + if (data.data) { + data = data.data; + } + Roo.data.MemoryProxy.superclass.constructor.call(this); + this.data = data; +}; + +Roo.extend(Roo.data.MemoryProxy, Roo.data.DataProxy, { + + /** + * Load data from the requested source (in this case an in-memory + * data object passed to the constructor), read the data object into + * a block of Roo.data.Records using the passed Roo.data.DataReader implementation, and + * process that block using the passed callback. + * @param {Object} params This parameter is not used by the MemoryProxy class. + * @param {Roo.data.DataReader} reader The Reader object which converts the data + * object into a block of Roo.data.Records. + * @param {Function} callback The function into which to pass the block of Roo.data.records. + * The function must be passed <ul> + * <li>The Record block object</li> + * <li>The "arg" argument from the load function</li> + * <li>A boolean success indicator</li> + * </ul> + * @param {Object} scope The scope in which to call the callback + * @param {Object} arg An optional argument which is passed to the callback as its second parameter. + */ + load : function(params, reader, callback, scope, arg){ + params = params || {}; + var result; + try { + result = reader.readRecords(params.data ? params.data :this.data); + }catch(e){ + this.fireEvent("loadexception", this, arg, null, e); + callback.call(scope, null, arg, false); + return; + } + callback.call(scope, result, arg, true); + }, + + // private + update : function(params, records){ + + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_data_Record.js.html b/docs2/src/Roo_data_Record.js.html new file mode 100644 index 0000000000..945ef8959d --- /dev/null +++ b/docs2/src/Roo_data_Record.js.html @@ -0,0 +1,234 @@ +/home/alan/gitlive/roojs1/Roo/data/Record.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** +* @class Roo.data.Record + * Instances of this class encapsulate both record <em>definition</em> information, and record + * <em>value</em> information for use in {@link Roo.data.Store} objects, or any code which needs + * to access Records cached in an {@link Roo.data.Store} object.<br> + * <p> + * Constructors for this class are generated by passing an Array of field definition objects to {@link #create}. + * Instances are usually only created by {@link Roo.data.Reader} implementations when processing unformatted data + * objects.<br> + * <p> + * Record objects generated by this constructor inherit all the methods of Roo.data.Record listed below. + * @constructor + * This constructor should not be used to create Record objects. Instead, use the constructor generated by + * {@link #create}. The parameters are the same. + * @param {Array} data An associative Array of data values keyed by the field name. + * @param {Object} id (Optional) The id of the record. This id should be unique, and is used by the + * {@link Roo.data.Store} object which owns the Record to index its collection of Records. If + * not specified an integer id is generated. + */ +Roo.data.Record = function(data, id){ + this.id = (id || id === 0) ? id : ++Roo.data.Record.AUTO_ID; + this.data = data; +}; + +/** + * Generate a constructor for a specific record layout. + * @param {Array} o An Array of field definition objects which specify field names, and optionally, + * data types, and a mapping for an {@link Roo.data.Reader} to extract the field's value from a data object. + * Each field definition object may contain the following properties: <ul> + * <li><b>name</b> : String<p style="margin-left:1em">The name by which the field is referenced within the Record. This is referenced by, + * for example the <em>dataIndex</em> property in column definition objects passed to {@link Roo.grid.ColumnModel}</p></li> + * <li><b>mapping</b> : String<p style="margin-left:1em">(Optional) A path specification for use by the {@link Roo.data.Reader} implementation + * that is creating the Record to access the data value from the data object. If an {@link Roo.data.JsonReader} + * is being used, then this is a string containing the javascript expression to reference the data relative to + * the record item's root. If an {@link Roo.data.XmlReader} is being used, this is an {@link Roo.DomQuery} path + * to the data item relative to the record element. If the mapping expression is the same as the field name, + * this may be omitted.</p></li> + * <li><b>type</b> : String<p style="margin-left:1em">(Optional) The data type for conversion to displayable value. Possible values are + * <ul><li>auto (Default, implies no conversion)</li> + * <li>string</li> + * <li>int</li> + * <li>float</li> + * <li>boolean</li> + * <li>date</li></ul></p></li> + * <li><b>sortType</b> : Mixed<p style="margin-left:1em">(Optional) A member of {@link Roo.data.SortTypes}.</p></li> + * <li><b>sortDir</b> : String<p style="margin-left:1em">(Optional) Initial direction to sort. "ASC" or "DESC"</p></li> + * <li><b>convert</b> : Function<p style="margin-left:1em">(Optional) A function which converts the value provided + * by the Reader into an object that will be stored in the Record. It is passed the + * following parameters:<ul> + * <li><b>v</b> : Mixed<p style="margin-left:1em">The data value as read by the Reader.</p></li> + * </ul></p></li> + * <li><b>dateFormat</b> : String<p style="margin-left:1em">(Optional) A format String for the Date.parseDate function.</p></li> + * </ul> + * <br>usage:<br><pre><code> +var TopicRecord = Roo.data.Record.create( + {name: 'title', mapping: 'topic_title'}, + {name: 'author', mapping: 'username'}, + {name: 'totalPosts', mapping: 'topic_replies', type: 'int'}, + {name: 'lastPost', mapping: 'post_time', type: 'date'}, + {name: 'lastPoster', mapping: 'user2'}, + {name: 'excerpt', mapping: 'post_text'} +); + +var myNewRecord = new TopicRecord({ + title: 'Do my job please', + author: 'noobie', + totalPosts: 1, + lastPost: new Date(), + lastPoster: 'Animal', + excerpt: 'No way dude!' +}); +myStore.add(myNewRecord); +</code></pre> + * @method create + * @static + */ +Roo.data.Record.create = function(o){ + var f = function(){ + f.superclass.constructor.apply(this, arguments); + }; + Roo.extend(f, Roo.data.Record); + var p = f.prototype; + p.fields = new Roo.util.MixedCollection(false, function(field){ + return field.name; + }); + for(var i = 0, len = o.length; i < len; i++){ + p.fields.add(new Roo.data.Field(o[i])); + } + f.getField = function(name){ + return p.fields.get(name); + }; + return f; +}; + +Roo.data.Record.AUTO_ID = 1000; +Roo.data.Record.EDIT = 'edit'; +Roo.data.Record.REJECT = 'reject'; +Roo.data.Record.COMMIT = 'commit'; + +Roo.data.Record.prototype = { + /** + * Readonly flag - true if this record has been modified. + * @type Boolean + */ + dirty : false, + editing : false, + error: null, + modified: null, + + // private + join : function(store){ + this.store = store; + }, + + /** + * Set the named field to the specified value. + * @param {String} name The name of the field to set. + * @param {Object} value The value to set the field to. + */ + set : function(name, value){ + if(this.data[name] == value){ + return; + } + this.dirty = true; + if(!this.modified){ + this.modified = {}; + } + if(typeof this.modified[name] == 'undefined'){ + this.modified[name] = this.data[name]; + } + this.data[name] = value; + if(!this.editing && this.store){ + this.store.afterEdit(this); + } + }, + + /** + * Get the value of the named field. + * @param {String} name The name of the field to get the value of. + * @return {Object} The value of the field. + */ + get : function(name){ + return this.data[name]; + }, + + // private + beginEdit : function(){ + this.editing = true; + this.modified = {}; + }, + + // private + cancelEdit : function(){ + this.editing = false; + delete this.modified; + }, + + // private + endEdit : function(){ + this.editing = false; + if(this.dirty && this.store){ + this.store.afterEdit(this); + } + }, + + /** + * Usually called by the {@link Roo.data.Store} which owns the Record. + * Rejects all changes made to the Record since either creation, or the last commit operation. + * Modified fields are reverted to their original values. + * <p> + * Developers should subscribe to the {@link Roo.data.Store#update} event to have their code notified + * of reject operations. + */ + reject : function(){ + var m = this.modified; + for(var n in m){ + if(typeof m[n] != "function"){ + this.data[n] = m[n]; + } + } + this.dirty = false; + delete this.modified; + this.editing = false; + if(this.store){ + this.store.afterReject(this); + } + }, + + /** + * Usually called by the {@link Roo.data.Store} which owns the Record. + * Commits all changes made to the Record since either creation, or the last commit operation. + * <p> + * Developers should subscribe to the {@link Roo.data.Store#update} event to have their code notified + * of commit operations. + */ + commit : function(){ + this.dirty = false; + delete this.modified; + this.editing = false; + if(this.store){ + this.store.afterCommit(this); + } + }, + + // private + hasError : function(){ + return this.error != null; + }, + + // private + clearError : function(){ + this.error = null; + }, + + /** + * Creates a copy of this record. + * @param {String} id (optional) A new record id if you don't want to use this record's id + * @return {Record} + */ + copy : function(newId) { + return new this.constructor(Roo.apply({}, this.data), newId || this.id); + } +}; \ No newline at end of file diff --git a/docs2/src/Roo_data_ScriptTagProxy.js.html b/docs2/src/Roo_data_ScriptTagProxy.js.html new file mode 100644 index 0000000000..19ab290d52 --- /dev/null +++ b/docs2/src/Roo_data_ScriptTagProxy.js.html @@ -0,0 +1,201 @@ +/home/alan/gitlive/roojs1/Roo/data/ScriptTagProxy.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.data.ScriptTagProxy + * An implementation of Roo.data.DataProxy that reads a data object from a URL which may be in a domain + * other than the originating domain of the running page.<br><br> + * <p> + * <em>Note that if you are retrieving data from a page that is in a domain that is NOT the same as the originating domain + * of the running page, you must use this class, rather than DataProxy.</em><br><br> + * <p> + * The content passed back from a server resource requested by a ScriptTagProxy is executable JavaScript + * source code that is used as the source inside a &lt;script> tag.<br><br> + * <p> + * In order for the browser to process the returned data, the server must wrap the data object + * with a call to a callback function, the name of which is passed as a parameter by the ScriptTagProxy. + * Below is a Java example for a servlet which returns data for either a ScriptTagProxy, or an HttpProxy + * depending on whether the callback name was passed: + * <p> + * <pre><code> +boolean scriptTag = false; +String cb = request.getParameter("callback"); +if (cb != null) { + scriptTag = true; + response.setContentType("text/javascript"); +} else { + response.setContentType("application/x-json"); +} +Writer out = response.getWriter(); +if (scriptTag) { + out.write(cb + "("); +} +out.print(dataBlock.toJsonString()); +if (scriptTag) { + out.write(");"); +} +</pre></code> + * + * @constructor + * @param {Object} config A configuration object. + */ +Roo.data.ScriptTagProxy = function(config){ + Roo.data.ScriptTagProxy.superclass.constructor.call(this); + Roo.apply(this, config); + this.head = document.getElementsByTagName("head")[0]; +}; + +Roo.data.ScriptTagProxy.TRANS_ID = 1000; + +Roo.extend(Roo.data.ScriptTagProxy, Roo.data.DataProxy, { + /** + * @cfg {String} url The URL from which to request the data object. + */ + /** + * @cfg {Number} timeout (Optional) The number of milliseconds to wait for a response. Defaults to 30 seconds. + */ + timeout : 30000, + /** + * @cfg {String} callbackParam (Optional) The name of the parameter to pass to the server which tells + * the server the name of the callback function set up by the load call to process the returned data object. + * Defaults to "callback".<p>The server-side processing must read this parameter value, and generate + * javascript output which calls this named function passing the data object as its only parameter. + */ + callbackParam : "callback", + /** + * @cfg {Boolean} nocache (Optional) Defaults to true. Disable cacheing by adding a unique parameter + * name to the request. + */ + nocache : true, + + /** + * Load data from the configured URL, read the data object into + * a block of Roo.data.Records using the passed Roo.data.DataReader implementation, and + * process that block using the passed callback. + * @param {Object} params An object containing properties which are to be used as HTTP parameters + * for the request to the remote server. + * @param {Roo.data.DataReader} reader The Reader object which converts the data + * object into a block of Roo.data.Records. + * @param {Function} callback The function into which to pass the block of Roo.data.Records. + * The function must be passed <ul> + * <li>The Record block object</li> + * <li>The "arg" argument from the load function</li> + * <li>A boolean success indicator</li> + * </ul> + * @param {Object} scope The scope in which to call the callback + * @param {Object} arg An optional argument which is passed to the callback as its second parameter. + */ + load : function(params, reader, callback, scope, arg){ + if(this.fireEvent("beforeload", this, params) !== false){ + + var p = Roo.urlEncode(Roo.apply(params, this.extraParams)); + + var url = this.url; + url += (url.indexOf("?") != -1 ? "&" : "?") + p; + if(this.nocache){ + url += "&_dc=" + (new Date().getTime()); + } + var transId = ++Roo.data.ScriptTagProxy.TRANS_ID; + var trans = { + id : transId, + cb : "stcCallback"+transId, + scriptId : "stcScript"+transId, + params : params, + arg : arg, + url : url, + callback : callback, + scope : scope, + reader : reader + }; + var conn = this; + + window[trans.cb] = function(o){ + conn.handleResponse(o, trans); + }; + + url += String.format("&{0}={1}", this.callbackParam, trans.cb); + + if(this.autoAbort !== false){ + this.abort(); + } + + trans.timeoutId = this.handleFailure.defer(this.timeout, this, [trans]); + + var script = document.createElement("script"); + script.setAttribute("src", url); + script.setAttribute("type", "text/javascript"); + script.setAttribute("id", trans.scriptId); + this.head.appendChild(script); + + this.trans = trans; + }else{ + callback.call(scope||this, null, arg, false); + } + }, + + // private + isLoading : function(){ + return this.trans ? true : false; + }, + + /** + * Abort the current server request. + */ + abort : function(){ + if(this.isLoading()){ + this.destroyTrans(this.trans); + } + }, + + // private + destroyTrans : function(trans, isLoaded){ + this.head.removeChild(document.getElementById(trans.scriptId)); + clearTimeout(trans.timeoutId); + if(isLoaded){ + window[trans.cb] = undefined; + try{ + delete window[trans.cb]; + }catch(e){} + }else{ + // if hasn't been loaded, wait for load to remove it to prevent script error + window[trans.cb] = function(){ + window[trans.cb] = undefined; + try{ + delete window[trans.cb]; + }catch(e){} + }; + } + }, + + // private + handleResponse : function(o, trans){ + this.trans = false; + this.destroyTrans(trans, true); + var result; + try { + result = trans.reader.readRecords(o); + }catch(e){ + this.fireEvent("loadexception", this, o, trans.arg, e); + trans.callback.call(trans.scope||window, null, trans.arg, false); + return; + } + this.fireEvent("load", this, o, trans.arg); + trans.callback.call(trans.scope||window, result, trans.arg, true); + }, + + // private + handleFailure : function(trans){ + this.trans = false; + this.destroyTrans(trans, false); + this.fireEvent("loadexception", this, null, trans.arg); + trans.callback.call(trans.scope||window, null, trans.arg, false); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_data_SimpleStore.js.html b/docs2/src/Roo_data_SimpleStore.js.html new file mode 100644 index 0000000000..7b52118a84 --- /dev/null +++ b/docs2/src/Roo_data_SimpleStore.js.html @@ -0,0 +1,34 @@ +/home/alan/gitlive/roojs1/Roo/data/SimpleStore.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.data.SimpleStore + * @extends Roo.data.Store + * Small helper class to make creating Stores from Array data easier. + * @cfg {Number} id The array index of the record id. Leave blank to auto generate ids. + * @cfg {Array} fields An array of field definition objects, or field name strings. + * @cfg {Array} data The multi-dimensional array of data + * @constructor + * @param {Object} config + */ +Roo.data.SimpleStore = function(config){ + Roo.data.SimpleStore.superclass.constructor.call(this, { + isLocal : true, + reader: new Roo.data.ArrayReader({ + id: config.id + }, + Roo.data.Record.create(config.fields) + ), + proxy : new Roo.data.MemoryProxy(config.data) + }); + this.load(); +}; +Roo.extend(Roo.data.SimpleStore, Roo.data.Store); \ No newline at end of file diff --git a/docs2/src/Roo_data_SortTypes.js.html b/docs2/src/Roo_data_SortTypes.js.html new file mode 100644 index 0000000000..6e2113a64b --- /dev/null +++ b/docs2/src/Roo_data_SortTypes.js.html @@ -0,0 +1,102 @@ +/home/alan/gitlive/roojs1/Roo/data/SortTypes.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.data.SortTypes + * @singleton + * Defines the default sorting (casting?) comparison functions used when sorting data. + */ +Roo.data.SortTypes = { + /** + * Default sort that does nothing + * @param {Mixed} s The value being converted + * @return {Mixed} The comparison value + */ + none : function(s){ + return s; + }, + + /** + * The regular expression used to strip tags + * @type {RegExp} + * @property + */ + stripTagsRE : /<\/?[^>]+>/gi, + + /** + * Strips all HTML tags to sort on text only + * @param {Mixed} s The value being converted + * @return {String} The comparison value + */ + asText : function(s){ + return String(s).replace(this.stripTagsRE, ""); + }, + + /** + * Strips all HTML tags to sort on text only - Case insensitive + * @param {Mixed} s The value being converted + * @return {String} The comparison value + */ + asUCText : function(s){ + return String(s).toUpperCase().replace(this.stripTagsRE, ""); + }, + + /** + * Case insensitive string + * @param {Mixed} s The value being converted + * @return {String} The comparison value + */ + asUCString : function(s) { + return String(s).toUpperCase(); + }, + + /** + * Date sorting + * @param {Mixed} s The value being converted + * @return {Number} The comparison value + */ + asDate : function(s) { + if(!s){ + return 0; + } + if(s instanceof Date){ + return s.getTime(); + } + return Date.parse(String(s)); + }, + + /** + * Float sorting + * @param {Mixed} s The value being converted + * @return {Float} The comparison value + */ + asFloat : function(s) { + var val = parseFloat(String(s).replace(/,/g, "")); + if(isNaN(val)) { + val = 0; + } + return val; + }, + + /** + * Integer sorting + * @param {Mixed} s The value being converted + * @return {Number} The comparison value + */ + asInt : function(s) { + var val = parseInt(String(s).replace(/,/g, "")); + if(isNaN(val)) { + val = 0; + } + return val; + } +}; \ No newline at end of file diff --git a/docs2/src/Roo_data_Store.js.html b/docs2/src/Roo_data_Store.js.html new file mode 100644 index 0000000000..9532ff8191 --- /dev/null +++ b/docs2/src/Roo_data_Store.js.html @@ -0,0 +1,740 @@ +/home/alan/gitlive/roojs1/Roo/data/Store.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + + +/** + * @class Roo.data.Store + * @extends Roo.util.Observable + * The Store class encapsulates a client side cache of {@link Roo.data.Record} objects which provide input data + * for widgets such as the Roo.grid.Grid, or the Roo.form.ComboBox.<br> + * <p> + * A Store object uses an implementation of {@link Roo.data.DataProxy} to access a data object unless you call loadData() directly and pass in your data. The Store object + * has no knowledge of the format of the data returned by the Proxy.<br> + * <p> + * A Store object uses its configured implementation of {@link Roo.data.DataReader} to create {@link Roo.data.Record} + * instances from the data object. These records are cached and made available through accessor functions. + * @constructor + * Creates a new Store. + * @param {Object} config A config object containing the objects needed for the Store to access data, + * and read the data into Records. + */ +Roo.data.Store = function(config){ + this.data = new Roo.util.MixedCollection(false); + this.data.getKey = function(o){ + return o.id; + }; + this.baseParams = {}; + // private + this.paramNames = { + "start" : "start", + "limit" : "limit", + "sort" : "sort", + "dir" : "dir", + "multisort" : "_multisort" + }; + + if(config && config.data){ + this.inlineData = config.data; + delete config.data; + } + + Roo.apply(this, config); + + if(this.reader){ // reader passed + this.reader = Roo.factory(this.reader, Roo.data); + this.reader.xmodule = this.xmodule || false; + if(!this.recordType){ + this.recordType = this.reader.recordType; + } + if(this.reader.onMetaChange){ + this.reader.onMetaChange = this.onMetaChange.createDelegate(this); + } + } + + if(this.recordType){ + this.fields = this.recordType.prototype.fields; + } + this.modified = []; + + this.addEvents({ + /** + * @event datachanged + * Fires when the data cache has changed, and a widget which is using this Store + * as a Record cache should refresh its view. + * @param {Store} this + */ + datachanged : true, + /** + * @event metachange + * Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders. + * @param {Store} this + * @param {Object} meta The JSON metadata + */ + metachange : true, + /** + * @event add + * Fires when Records have been added to the Store + * @param {Store} this + * @param {Roo.data.Record[]} records The array of Records added + * @param {Number} index The index at which the record(s) were added + */ + add : true, + /** + * @event remove + * Fires when a Record has been removed from the Store + * @param {Store} this + * @param {Roo.data.Record} record The Record that was removed + * @param {Number} index The index at which the record was removed + */ + remove : true, + /** + * @event update + * Fires when a Record has been updated + * @param {Store} this + * @param {Roo.data.Record} record The Record that was updated + * @param {String} operation The update operation being performed. Value may be one of: + * <pre><code> + Roo.data.Record.EDIT + Roo.data.Record.REJECT + Roo.data.Record.COMMIT + * </code></pre> + */ + update : true, + /** + * @event clear + * Fires when the data cache has been cleared. + * @param {Store} this + */ + clear : true, + /** + * @event beforeload + * Fires before a request is made for a new data object. If the beforeload handler returns false + * the load action will be canceled. + * @param {Store} this + * @param {Object} options The loading options that were specified (see {@link #load} for details) + */ + beforeload : true, + /** + * @event beforeloadadd + * Fires after a new set of Records has been loaded. + * @param {Store} this + * @param {Roo.data.Record[]} records The Records that were loaded + * @param {Object} options The loading options that were specified (see {@link #load} for details) + */ + beforeloadadd : true, + /** + * @event load + * Fires after a new set of Records has been loaded, before they are added to the store. + * @param {Store} this + * @param {Roo.data.Record[]} records The Records that were loaded + * @param {Object} options The loading options that were specified (see {@link #load} for details) + * @params {Object} return from reader + */ + load : true, + /** + * @event loadexception + * Fires if an exception occurs in the Proxy during loading. + * Called with the signature of the Proxy's "loadexception" event. + * If you return Json { data: [] , success: false, .... } then this will be thrown with the following args + * + * @param {Proxy} + * @param {Object} return from JsonData.reader() - success, totalRecords, records + * @param {Object} load options + * @param {Object} jsonData from your request (normally this contains the Exception) + */ + loadexception : true + }); + + if(this.proxy){ + this.proxy = Roo.factory(this.proxy, Roo.data); + this.proxy.xmodule = this.xmodule || false; + this.relayEvents(this.proxy, ["loadexception"]); + } + this.sortToggle = {}; + this.sortOrder = []; // array of order of sorting - updated by grid if multisort is enabled. + + Roo.data.Store.superclass.constructor.call(this); + + if(this.inlineData){ + this.loadData(this.inlineData); + delete this.inlineData; + } +}; + +Roo.extend(Roo.data.Store, Roo.util.Observable, { + /** + * @cfg {boolean} isLocal flag if data is locally available (and can be always looked up + * without a remote query - used by combo/forms at present. + */ + + /** + * @cfg {Roo.data.DataProxy} proxy The Proxy object which provides access to a data object. + */ + /** + * @cfg {Array} data Inline data to be loaded when the store is initialized. + */ + /** + * @cfg {Roo.data.Reader} reader The Reader object which processes the data object and returns + * an Array of Roo.data.record objects which are cached keyed by their <em>id</em> property. + */ + /** + * @cfg {Object} baseParams An object containing properties which are to be sent as parameters + * on any HTTP request + */ + /** + * @cfg {Object} sortInfo A config object in the format: {field: "fieldName", direction: "ASC|DESC"} + */ + /** + * @cfg {Boolean} multiSort enable multi column sorting (sort is based on the order of columns, remote only at present) + */ + multiSort: false, + /** + * @cfg {boolean} remoteSort True if sorting is to be handled by requesting the Proxy to provide a refreshed + * version of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false). + */ + remoteSort : false, + + /** + * @cfg {boolean} pruneModifiedRecords True to clear all modified record information each time the store is + * loaded or when a record is removed. (defaults to false). + */ + pruneModifiedRecords : false, + + // private + lastOptions : null, + + /** + * Add Records to the Store and fires the add event. + * @param {Roo.data.Record[]} records An Array of Roo.data.Record objects to add to the cache. + */ + add : function(records){ + records = [].concat(records); + for(var i = 0, len = records.length; i < len; i++){ + records[i].join(this); + } + var index = this.data.length; + this.data.addAll(records); + this.fireEvent("add", this, records, index); + }, + + /** + * Remove a Record from the Store and fires the remove event. + * @param {Ext.data.Record} record The Roo.data.Record object to remove from the cache. + */ + remove : function(record){ + var index = this.data.indexOf(record); + this.data.removeAt(index); + + if(this.pruneModifiedRecords){ + this.modified.remove(record); + } + this.fireEvent("remove", this, record, index); + }, + + /** + * Remove all Records from the Store and fires the clear event. + */ + removeAll : function(){ + this.data.clear(); + if(this.pruneModifiedRecords){ + this.modified = []; + } + this.fireEvent("clear", this); + }, + + /** + * Inserts Records to the Store at the given index and fires the add event. + * @param {Number} index The start index at which to insert the passed Records. + * @param {Roo.data.Record[]} records An Array of Roo.data.Record objects to add to the cache. + */ + insert : function(index, records){ + records = [].concat(records); + for(var i = 0, len = records.length; i < len; i++){ + this.data.insert(index, records[i]); + records[i].join(this); + } + this.fireEvent("add", this, records, index); + }, + + /** + * Get the index within the cache of the passed Record. + * @param {Roo.data.Record} record The Roo.data.Record object to to find. + * @return {Number} The index of the passed Record. Returns -1 if not found. + */ + indexOf : function(record){ + return this.data.indexOf(record); + }, + + /** + * Get the index within the cache of the Record with the passed id. + * @param {String} id The id of the Record to find. + * @return {Number} The index of the Record. Returns -1 if not found. + */ + indexOfId : function(id){ + return this.data.indexOfKey(id); + }, + + /** + * Get the Record with the specified id. + * @param {String} id The id of the Record to find. + * @return {Roo.data.Record} The Record with the passed id. Returns undefined if not found. + */ + getById : function(id){ + return this.data.key(id); + }, + + /** + * Get the Record at the specified index. + * @param {Number} index The index of the Record to find. + * @return {Roo.data.Record} The Record at the passed index. Returns undefined if not found. + */ + getAt : function(index){ + return this.data.itemAt(index); + }, + + /** + * Returns a range of Records between specified indices. + * @param {Number} startIndex (optional) The starting index (defaults to 0) + * @param {Number} endIndex (optional) The ending index (defaults to the last Record in the Store) + * @return {Roo.data.Record[]} An array of Records + */ + getRange : function(start, end){ + return this.data.getRange(start, end); + }, + + // private + storeOptions : function(o){ + o = Roo.apply({}, o); + delete o.callback; + delete o.scope; + this.lastOptions = o; + }, + + /** + * Loads the Record cache from the configured Proxy using the configured Reader. + * <p> + * If using remote paging, then the first load call must specify the <em>start</em> + * and <em>limit</em> properties in the options.params property to establish the initial + * position within the dataset, and the number of Records to cache on each read from the Proxy. + * <p> + * <strong>It is important to note that for remote data sources, loading is asynchronous, + * and this call will return before the new data has been loaded. Perform any post-processing + * in a callback function, or in a "load" event handler.</strong> + * <p> + * @param {Object} options An object containing properties which control loading options:<ul> + * <li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li> + * <li>callback {Function} A function to be called after the Records have been loaded. The callback is + * passed the following arguments:<ul> + * <li>r : Roo.data.Record[]</li> + * <li>options: Options object from the load call</li> + * <li>success: Boolean success indicator</li></ul></li> + * <li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li> + * <li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li> + * </ul> + */ + load : function(options){ + options = options || {}; + if(this.fireEvent("beforeload", this, options) !== false){ + this.storeOptions(options); + var p = Roo.apply(options.params || {}, this.baseParams); + // if meta was not loaded from remote source.. try requesting it. + if (!this.reader.metaFromRemote) { + p._requestMeta = 1; + } + if(this.sortInfo && this.remoteSort){ + var pn = this.paramNames; + p[pn["sort"]] = this.sortInfo.field; + p[pn["dir"]] = this.sortInfo.direction; + } + if (this.multiSort) { + var pn = this.paramNames; + p[pn["multisort"]] = Roo.encode( { sort : this.sortToggle, order: this.sortOrder }); + } + + this.proxy.load(p, this.reader, this.loadRecords, this, options); + } + }, + + /** + * Reloads the Record cache from the configured Proxy using the configured Reader and + * the options from the last load operation performed. + * @param {Object} options (optional) An object containing properties which may override the options + * used in the last load operation. See {@link #load} for details (defaults to null, in which case + * the most recently used options are reused). + */ + reload : function(options){ + this.load(Roo.applyIf(options||{}, this.lastOptions)); + }, + + // private + // Called as a callback by the Reader during a load operation. + loadRecords : function(o, options, success){ + if(!o || success === false){ + if(success !== false){ + this.fireEvent("load", this, [], options, o); + } + if(options.callback){ + options.callback.call(options.scope || this, [], options, false); + } + return; + } + // if data returned failure - throw an exception. + if (o.success === false) { + // show a message if no listener is registered. + if (!this.hasListener('loadexception') && typeof(o.raw.errorMsg) != 'undefined') { + Roo.MessageBox.alert("Error loading",o.raw.errorMsg); + } + // loadmask wil be hooked into this.. + this.fireEvent("loadexception", this, o, options, o.raw.errorMsg); + return; + } + var r = o.records, t = o.totalRecords || r.length; + + this.fireEvent("beforeloadadd", this, r, options, o); + + if(!options || options.add !== true){ + if(this.pruneModifiedRecords){ + this.modified = []; + } + for(var i = 0, len = r.length; i < len; i++){ + r[i].join(this); + } + if(this.snapshot){ + this.data = this.snapshot; + delete this.snapshot; + } + this.data.clear(); + this.data.addAll(r); + this.totalLength = t; + this.applySort(); + this.fireEvent("datachanged", this); + }else{ + this.totalLength = Math.max(t, this.data.length+r.length); + this.add(r); + } + + if(this.parent && !Roo.isIOS && !this.useNativeIOS && this.parent.emptyTitle.length) { + + var e = new Roo.data.Record({}); + + e.set(this.parent.displayField, this.parent.emptyTitle); + e.set(this.parent.valueField, ''); + + this.insert(0, e); + } + + this.fireEvent("load", this, r, options, o); + if(options.callback){ + options.callback.call(options.scope || this, r, options, true); + } + }, + + + /** + * Loads data from a passed data block. A Reader which understands the format of the data + * must have been configured in the constructor. + * @param {Object} data The data block from which to read the Records. The format of the data expected + * is dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter. + * @param {Boolean} append (Optional) True to append the new Records rather than replace the existing cache. + */ + loadData : function(o, append){ + var r = this.reader.readRecords(o); + this.loadRecords(r, {add: append}, true); + }, + + /** + * Gets the number of cached records. + * <p> + * <em>If using paging, this may not be the total size of the dataset. If the data object + * used by the Reader contains the dataset size, then the getTotalCount() function returns + * the data set size</em> + */ + getCount : function(){ + return this.data.length || 0; + }, + + /** + * Gets the total number of records in the dataset as returned by the server. + * <p> + * <em>If using paging, for this to be accurate, the data object used by the Reader must contain + * the dataset size</em> + */ + getTotalCount : function(){ + return this.totalLength || 0; + }, + + /** + * Returns the sort state of the Store as an object with two properties: + * <pre><code> + field {String} The name of the field by which the Records are sorted + direction {String} The sort order, "ASC" or "DESC" + * </code></pre> + */ + getSortState : function(){ + return this.sortInfo; + }, + + // private + applySort : function(){ + if(this.sortInfo && !this.remoteSort){ + var s = this.sortInfo, f = s.field; + var st = this.fields.get(f).sortType; + var fn = function(r1, r2){ + var v1 = st(r1.data[f]), v2 = st(r2.data[f]); + return v1 > v2 ? 1 : (v1 < v2 ? -1 : 0); + }; + this.data.sort(s.direction, fn); + if(this.snapshot && this.snapshot != this.data){ + this.snapshot.sort(s.direction, fn); + } + } + }, + + /** + * Sets the default sort column and order to be used by the next load operation. + * @param {String} fieldName The name of the field to sort by. + * @param {String} dir (optional) The sort order, "ASC" or "DESC" (defaults to "ASC") + */ + setDefaultSort : function(field, dir){ + this.sortInfo = {field: field, direction: dir ? dir.toUpperCase() : "ASC"}; + }, + + /** + * Sort the Records. + * If remote sorting is used, the sort is performed on the server, and the cache is + * reloaded. If local sorting is used, the cache is sorted internally. + * @param {String} fieldName The name of the field to sort by. + * @param {String} dir (optional) The sort order, "ASC" or "DESC" (defaults to "ASC") + */ + sort : function(fieldName, dir){ + var f = this.fields.get(fieldName); + if(!dir){ + this.sortToggle[f.name] = this.sortToggle[f.name] || f.sortDir; + + if(this.multiSort || (this.sortInfo && this.sortInfo.field == f.name) ){ // toggle sort dir + dir = (this.sortToggle[f.name] || "ASC").toggle("ASC", "DESC"); + }else{ + dir = f.sortDir; + } + } + this.sortToggle[f.name] = dir; + this.sortInfo = {field: f.name, direction: dir}; + if(!this.remoteSort){ + this.applySort(); + this.fireEvent("datachanged", this); + }else{ + this.load(this.lastOptions); + } + }, + + /** + * Calls the specified function for each of the Records in the cache. + * @param {Function} fn The function to call. The Record is passed as the first parameter. + * Returning <em>false</em> aborts and exits the iteration. + * @param {Object} scope (optional) The scope in which to call the function (defaults to the Record). + */ + each : function(fn, scope){ + this.data.each(fn, scope); + }, + + /** + * Gets all records modified since the last commit. Modified records are persisted across load operations + * (e.g., during paging). + * @return {Roo.data.Record[]} An array of Records containing outstanding modifications. + */ + getModifiedRecords : function(){ + return this.modified; + }, + + // private + createFilterFn : function(property, value, anyMatch){ + if(!value.exec){ // not a regex + value = String(value); + if(value.length == 0){ + return false; + } + value = new RegExp((anyMatch === true ? '' : '^') + Roo.escapeRe(value), "i"); + } + return function(r){ + return value.test(r.data[property]); + }; + }, + + /** + * Sums the value of <i>property</i> for each record between start and end and returns the result. + * @param {String} property A field on your records + * @param {Number} start The record index to start at (defaults to 0) + * @param {Number} end The last record index to include (defaults to length - 1) + * @return {Number} The sum + */ + sum : function(property, start, end){ + var rs = this.data.items, v = 0; + start = start || 0; + end = (end || end === 0) ? end : rs.length-1; + + for(var i = start; i <= end; i++){ + v += (rs[i].data[property] || 0); + } + return v; + }, + + /** + * Filter the records by a specified property. + * @param {String} field A field on your records + * @param {String/RegExp} value Either a string that the field + * should start with or a RegExp to test against the field + * @param {Boolean} anyMatch True to match any part not just the beginning + */ + filter : function(property, value, anyMatch){ + var fn = this.createFilterFn(property, value, anyMatch); + return fn ? this.filterBy(fn) : this.clearFilter(); + }, + + /** + * Filter by a function. The specified function will be called with each + * record in this data source. If the function returns true the record is included, + * otherwise it is filtered. + * @param {Function} fn The function to be called, it will receive 2 args (record, id) + * @param {Object} scope (optional) The scope of the function (defaults to this) + */ + filterBy : function(fn, scope){ + this.snapshot = this.snapshot || this.data; + this.data = this.queryBy(fn, scope||this); + this.fireEvent("datachanged", this); + }, + + /** + * Query the records by a specified property. + * @param {String} field A field on your records + * @param {String/RegExp} value Either a string that the field + * should start with or a RegExp to test against the field + * @param {Boolean} anyMatch True to match any part not just the beginning + * @return {MixedCollection} Returns an Roo.util.MixedCollection of the matched records + */ + query : function(property, value, anyMatch){ + var fn = this.createFilterFn(property, value, anyMatch); + return fn ? this.queryBy(fn) : this.data.clone(); + }, + + /** + * Query by a function. The specified function will be called with each + * record in this data source. If the function returns true the record is included + * in the results. + * @param {Function} fn The function to be called, it will receive 2 args (record, id) + * @param {Object} scope (optional) The scope of the function (defaults to this) + @return {MixedCollection} Returns an Roo.util.MixedCollection of the matched records + **/ + queryBy : function(fn, scope){ + var data = this.snapshot || this.data; + return data.filterBy(fn, scope||this); + }, + + /** + * Collects unique values for a particular dataIndex from this store. + * @param {String} dataIndex The property to collect + * @param {Boolean} allowNull (optional) Pass true to allow null, undefined or empty string values + * @param {Boolean} bypassFilter (optional) Pass true to collect from all records, even ones which are filtered + * @return {Array} An array of the unique values + **/ + collect : function(dataIndex, allowNull, bypassFilter){ + var d = (bypassFilter === true && this.snapshot) ? + this.snapshot.items : this.data.items; + var v, sv, r = [], l = {}; + for(var i = 0, len = d.length; i < len; i++){ + v = d[i].data[dataIndex]; + sv = String(v); + if((allowNull || !Roo.isEmpty(v)) && !l[sv]){ + l[sv] = true; + r[r.length] = v; + } + } + return r; + }, + + /** + * Revert to a view of the Record cache with no filtering applied. + * @param {Boolean} suppressEvent If true the filter is cleared silently without notifying listeners + */ + clearFilter : function(suppressEvent){ + if(this.snapshot && this.snapshot != this.data){ + this.data = this.snapshot; + delete this.snapshot; + if(suppressEvent !== true){ + this.fireEvent("datachanged", this); + } + } + }, + + // private + afterEdit : function(record){ + if(this.modified.indexOf(record) == -1){ + this.modified.push(record); + } + this.fireEvent("update", this, record, Roo.data.Record.EDIT); + }, + + // private + afterReject : function(record){ + this.modified.remove(record); + this.fireEvent("update", this, record, Roo.data.Record.REJECT); + }, + + // private + afterCommit : function(record){ + this.modified.remove(record); + this.fireEvent("update", this, record, Roo.data.Record.COMMIT); + }, + + /** + * Commit all Records with outstanding changes. To handle updates for changes, subscribe to the + * Store's "update" event, and perform updating when the third parameter is Roo.data.Record.COMMIT. + */ + commitChanges : function(){ + var m = this.modified.slice(0); + this.modified = []; + for(var i = 0, len = m.length; i < len; i++){ + m[i].commit(); + } + }, + + /** + * Cancel outstanding changes on all changed records. + */ + rejectChanges : function(){ + var m = this.modified.slice(0); + this.modified = []; + for(var i = 0, len = m.length; i < len; i++){ + m[i].reject(); + } + }, + + onMetaChange : function(meta, rtype, o){ + this.recordType = rtype; + this.fields = rtype.prototype.fields; + delete this.snapshot; + this.sortInfo = meta.sortInfo || this.sortInfo; + this.modified = []; + this.fireEvent('metachange', this, this.reader.meta); + }, + + moveIndex : function(data, type) + { + var index = this.indexOf(data); + + var newIndex = index + type; + + this.remove(data); + + this.insert(newIndex, data); + + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_data_Tree.js.html b/docs2/src/Roo_data_Tree.js.html new file mode 100644 index 0000000000..826480ec7d --- /dev/null +++ b/docs2/src/Roo_data_Tree.js.html @@ -0,0 +1,741 @@ +/home/alan/gitlive/roojs1/Roo/data/Tree.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.data.Tree + * @extends Roo.util.Observable + * Represents a tree data structure and bubbles all the events for its nodes. The nodes + * in the tree have most standard DOM functionality. + * @constructor + * @param {Node} root (optional) The root node + */ +Roo.data.Tree = function(root){ + this.nodeHash = {}; + /** + * The root node for this tree + * @type Node + */ + this.root = null; + if(root){ + this.setRootNode(root); + } + this.addEvents({ + /** + * @event append + * Fires when a new child node is appended to a node in this tree. + * @param {Tree} tree The owner tree + * @param {Node} parent The parent node + * @param {Node} node The newly appended node + * @param {Number} index The index of the newly appended node + */ + "append" : true, + /** + * @event remove + * Fires when a child node is removed from a node in this tree. + * @param {Tree} tree The owner tree + * @param {Node} parent The parent node + * @param {Node} node The child node removed + */ + "remove" : true, + /** + * @event move + * Fires when a node is moved to a new location in the tree + * @param {Tree} tree The owner tree + * @param {Node} node The node moved + * @param {Node} oldParent The old parent of this node + * @param {Node} newParent The new parent of this node + * @param {Number} index The index it was moved to + */ + "move" : true, + /** + * @event insert + * Fires when a new child node is inserted in a node in this tree. + * @param {Tree} tree The owner tree + * @param {Node} parent The parent node + * @param {Node} node The child node inserted + * @param {Node} refNode The child node the node was inserted before + */ + "insert" : true, + /** + * @event beforeappend + * Fires before a new child is appended to a node in this tree, return false to cancel the append. + * @param {Tree} tree The owner tree + * @param {Node} parent The parent node + * @param {Node} node The child node to be appended + */ + "beforeappend" : true, + /** + * @event beforeremove + * Fires before a child is removed from a node in this tree, return false to cancel the remove. + * @param {Tree} tree The owner tree + * @param {Node} parent The parent node + * @param {Node} node The child node to be removed + */ + "beforeremove" : true, + /** + * @event beforemove + * Fires before a node is moved to a new location in the tree. Return false to cancel the move. + * @param {Tree} tree The owner tree + * @param {Node} node The node being moved + * @param {Node} oldParent The parent of the node + * @param {Node} newParent The new parent the node is moving to + * @param {Number} index The index it is being moved to + */ + "beforemove" : true, + /** + * @event beforeinsert + * Fires before a new child is inserted in a node in this tree, return false to cancel the insert. + * @param {Tree} tree The owner tree + * @param {Node} parent The parent node + * @param {Node} node The child node to be inserted + * @param {Node} refNode The child node the node is being inserted before + */ + "beforeinsert" : true + }); + + Roo.data.Tree.superclass.constructor.call(this); +}; + +Roo.extend(Roo.data.Tree, Roo.util.Observable, { + pathSeparator: "/", + + proxyNodeEvent : function(){ + return this.fireEvent.apply(this, arguments); + }, + + /** + * Returns the root node for this tree. + * @return {Node} + */ + getRootNode : function(){ + return this.root; + }, + + /** + * Sets the root node for this tree. + * @param {Node} node + * @return {Node} + */ + setRootNode : function(node){ + this.root = node; + node.ownerTree = this; + node.isRoot = true; + this.registerNode(node); + return node; + }, + + /** + * Gets a node in this tree by its id. + * @param {String} id + * @return {Node} + */ + getNodeById : function(id){ + return this.nodeHash[id]; + }, + + registerNode : function(node){ + this.nodeHash[node.id] = node; + }, + + unregisterNode : function(node){ + delete this.nodeHash[node.id]; + }, + + toString : function(){ + return "[Tree"+(this.id?" "+this.id:"")+"]"; + } +}); + +/** + * @class Roo.data.Node + * @extends Roo.util.Observable + * @cfg {Boolean} leaf true if this node is a leaf and does not have children + * @cfg {String} id The id for this node. If one is not specified, one is generated. + * @constructor + * @param {Object} attributes The attributes/config for the node + */ +Roo.data.Node = function(attributes){ + /** + * The attributes supplied for the node. You can use this property to access any custom attributes you supplied. + * @type {Object} + */ + this.attributes = attributes || {}; + this.leaf = this.attributes.leaf; + /** + * The node id. @type String + */ + this.id = this.attributes.id; + if(!this.id){ + this.id = Roo.id(null, "ynode-"); + this.attributes.id = this.id; + } + + + /** + * All child nodes of this node. @type Array + */ + this.childNodes = []; + if(!this.childNodes.indexOf){ // indexOf is a must + this.childNodes.indexOf = function(o){ + for(var i = 0, len = this.length; i < len; i++){ + if(this[i] == o) { + return i; + } + } + return -1; + }; + } + /** + * The parent node for this node. @type Node + */ + this.parentNode = null; + /** + * The first direct child node of this node, or null if this node has no child nodes. @type Node + */ + this.firstChild = null; + /** + * The last direct child node of this node, or null if this node has no child nodes. @type Node + */ + this.lastChild = null; + /** + * The node immediately preceding this node in the tree, or null if there is no sibling node. @type Node + */ + this.previousSibling = null; + /** + * The node immediately following this node in the tree, or null if there is no sibling node. @type Node + */ + this.nextSibling = null; + + this.addEvents({ + /** + * @event append + * Fires when a new child node is appended + * @param {Tree} tree The owner tree + * @param {Node} this This node + * @param {Node} node The newly appended node + * @param {Number} index The index of the newly appended node + */ + "append" : true, + /** + * @event remove + * Fires when a child node is removed + * @param {Tree} tree The owner tree + * @param {Node} this This node + * @param {Node} node The removed node + */ + "remove" : true, + /** + * @event move + * Fires when this node is moved to a new location in the tree + * @param {Tree} tree The owner tree + * @param {Node} this This node + * @param {Node} oldParent The old parent of this node + * @param {Node} newParent The new parent of this node + * @param {Number} index The index it was moved to + */ + "move" : true, + /** + * @event insert + * Fires when a new child node is inserted. + * @param {Tree} tree The owner tree + * @param {Node} this This node + * @param {Node} node The child node inserted + * @param {Node} refNode The child node the node was inserted before + */ + "insert" : true, + /** + * @event beforeappend + * Fires before a new child is appended, return false to cancel the append. + * @param {Tree} tree The owner tree + * @param {Node} this This node + * @param {Node} node The child node to be appended + */ + "beforeappend" : true, + /** + * @event beforeremove + * Fires before a child is removed, return false to cancel the remove. + * @param {Tree} tree The owner tree + * @param {Node} this This node + * @param {Node} node The child node to be removed + */ + "beforeremove" : true, + /** + * @event beforemove + * Fires before this node is moved to a new location in the tree. Return false to cancel the move. + * @param {Tree} tree The owner tree + * @param {Node} this This node + * @param {Node} oldParent The parent of this node + * @param {Node} newParent The new parent this node is moving to + * @param {Number} index The index it is being moved to + */ + "beforemove" : true, + /** + * @event beforeinsert + * Fires before a new child is inserted, return false to cancel the insert. + * @param {Tree} tree The owner tree + * @param {Node} this This node + * @param {Node} node The child node to be inserted + * @param {Node} refNode The child node the node is being inserted before + */ + "beforeinsert" : true + }); + this.listeners = this.attributes.listeners; + Roo.data.Node.superclass.constructor.call(this); +}; + +Roo.extend(Roo.data.Node, Roo.util.Observable, { + fireEvent : function(evtName){ + // first do standard event for this node + if(Roo.data.Node.superclass.fireEvent.apply(this, arguments) === false){ + return false; + } + // then bubble it up to the tree if the event wasn't cancelled + var ot = this.getOwnerTree(); + if(ot){ + if(ot.proxyNodeEvent.apply(ot, arguments) === false){ + return false; + } + } + return true; + }, + + /** + * Returns true if this node is a leaf + * @return {Boolean} + */ + isLeaf : function(){ + return this.leaf === true; + }, + + // private + setFirstChild : function(node){ + this.firstChild = node; + }, + + //private + setLastChild : function(node){ + this.lastChild = node; + }, + + + /** + * Returns true if this node is the last child of its parent + * @return {Boolean} + */ + isLast : function(){ + return (!this.parentNode ? true : this.parentNode.lastChild == this); + }, + + /** + * Returns true if this node is the first child of its parent + * @return {Boolean} + */ + isFirst : function(){ + return (!this.parentNode ? true : this.parentNode.firstChild == this); + }, + + hasChildNodes : function(){ + return !this.isLeaf() && this.childNodes.length > 0; + }, + + /** + * Insert node(s) as the last child node of this node. + * @param {Node/Array} node The node or Array of nodes to append + * @return {Node} The appended node if single append, or null if an array was passed + */ + appendChild : function(node){ + var multi = false; + if(node instanceof Array){ + multi = node; + }else if(arguments.length > 1){ + multi = arguments; + } + // if passed an array or multiple args do them one by one + if(multi){ + for(var i = 0, len = multi.length; i < len; i++) { + this.appendChild(multi[i]); + } + }else{ + if(this.fireEvent("beforeappend", this.ownerTree, this, node) === false){ + return false; + } + var index = this.childNodes.length; + var oldParent = node.parentNode; + // it's a move, make sure we move it cleanly + if(oldParent){ + if(node.fireEvent("beforemove", node.getOwnerTree(), node, oldParent, this, index) === false){ + return false; + } + oldParent.removeChild(node); + } + index = this.childNodes.length; + if(index == 0){ + this.setFirstChild(node); + } + this.childNodes.push(node); + node.parentNode = this; + var ps = this.childNodes[index-1]; + if(ps){ + node.previousSibling = ps; + ps.nextSibling = node; + }else{ + node.previousSibling = null; + } + node.nextSibling = null; + this.setLastChild(node); + node.setOwnerTree(this.getOwnerTree()); + this.fireEvent("append", this.ownerTree, this, node, index); + if(oldParent){ + node.fireEvent("move", this.ownerTree, node, oldParent, this, index); + } + return node; + } + }, + + /** + * Removes a child node from this node. + * @param {Node} node The node to remove + * @return {Node} The removed node + */ + removeChild : function(node){ + var index = this.childNodes.indexOf(node); + if(index == -1){ + return false; + } + if(this.fireEvent("beforeremove", this.ownerTree, this, node) === false){ + return false; + } + + // remove it from childNodes collection + this.childNodes.splice(index, 1); + + // update siblings + if(node.previousSibling){ + node.previousSibling.nextSibling = node.nextSibling; + } + if(node.nextSibling){ + node.nextSibling.previousSibling = node.previousSibling; + } + + // update child refs + if(this.firstChild == node){ + this.setFirstChild(node.nextSibling); + } + if(this.lastChild == node){ + this.setLastChild(node.previousSibling); + } + + node.setOwnerTree(null); + // clear any references from the node + node.parentNode = null; + node.previousSibling = null; + node.nextSibling = null; + this.fireEvent("remove", this.ownerTree, this, node); + return node; + }, + + /** + * Inserts the first node before the second node in this nodes childNodes collection. + * @param {Node} node The node to insert + * @param {Node} refNode The node to insert before (if null the node is appended) + * @return {Node} The inserted node + */ + insertBefore : function(node, refNode){ + if(!refNode){ // like standard Dom, refNode can be null for append + return this.appendChild(node); + } + // nothing to do + if(node == refNode){ + return false; + } + + if(this.fireEvent("beforeinsert", this.ownerTree, this, node, refNode) === false){ + return false; + } + var index = this.childNodes.indexOf(refNode); + var oldParent = node.parentNode; + var refIndex = index; + + // when moving internally, indexes will change after remove + if(oldParent == this && this.childNodes.indexOf(node) < index){ + refIndex--; + } + + // it's a move, make sure we move it cleanly + if(oldParent){ + if(node.fireEvent("beforemove", node.getOwnerTree(), node, oldParent, this, index, refNode) === false){ + return false; + } + oldParent.removeChild(node); + } + if(refIndex == 0){ + this.setFirstChild(node); + } + this.childNodes.splice(refIndex, 0, node); + node.parentNode = this; + var ps = this.childNodes[refIndex-1]; + if(ps){ + node.previousSibling = ps; + ps.nextSibling = node; + }else{ + node.previousSibling = null; + } + node.nextSibling = refNode; + refNode.previousSibling = node; + node.setOwnerTree(this.getOwnerTree()); + this.fireEvent("insert", this.ownerTree, this, node, refNode); + if(oldParent){ + node.fireEvent("move", this.ownerTree, node, oldParent, this, refIndex, refNode); + } + return node; + }, + + /** + * Returns the child node at the specified index. + * @param {Number} index + * @return {Node} + */ + item : function(index){ + return this.childNodes[index]; + }, + + /** + * Replaces one child node in this node with another. + * @param {Node} newChild The replacement node + * @param {Node} oldChild The node to replace + * @return {Node} The replaced node + */ + replaceChild : function(newChild, oldChild){ + this.insertBefore(newChild, oldChild); + this.removeChild(oldChild); + return oldChild; + }, + + /** + * Returns the index of a child node + * @param {Node} node + * @return {Number} The index of the node or -1 if it was not found + */ + indexOf : function(child){ + return this.childNodes.indexOf(child); + }, + + /** + * Returns the tree this node is in. + * @return {Tree} + */ + getOwnerTree : function(){ + // if it doesn't have one, look for one + if(!this.ownerTree){ + var p = this; + while(p){ + if(p.ownerTree){ + this.ownerTree = p.ownerTree; + break; + } + p = p.parentNode; + } + } + return this.ownerTree; + }, + + /** + * Returns depth of this node (the root node has a depth of 0) + * @return {Number} + */ + getDepth : function(){ + var depth = 0; + var p = this; + while(p.parentNode){ + ++depth; + p = p.parentNode; + } + return depth; + }, + + // private + setOwnerTree : function(tree){ + // if it's move, we need to update everyone + if(tree != this.ownerTree){ + if(this.ownerTree){ + this.ownerTree.unregisterNode(this); + } + this.ownerTree = tree; + var cs = this.childNodes; + for(var i = 0, len = cs.length; i < len; i++) { + cs[i].setOwnerTree(tree); + } + if(tree){ + tree.registerNode(this); + } + } + }, + + /** + * Returns the path for this node. The path can be used to expand or select this node programmatically. + * @param {String} attr (optional) The attr to use for the path (defaults to the node's id) + * @return {String} The path + */ + getPath : function(attr){ + attr = attr || "id"; + var p = this.parentNode; + var b = [this.attributes[attr]]; + while(p){ + b.unshift(p.attributes[attr]); + p = p.parentNode; + } + var sep = this.getOwnerTree().pathSeparator; + return sep + b.join(sep); + }, + + /** + * Bubbles up the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of + * function call will be the scope provided or the current node. The arguments to the function + * will be the args provided or the current node. If the function returns false at any point, + * the bubble is stopped. + * @param {Function} fn The function to call + * @param {Object} scope (optional) The scope of the function (defaults to current node) + * @param {Array} args (optional) The args to call the function with (default to passing the current node) + */ + bubble : function(fn, scope, args){ + var p = this; + while(p){ + if(fn.call(scope || p, args || p) === false){ + break; + } + p = p.parentNode; + } + }, + + /** + * Cascades down the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of + * function call will be the scope provided or the current node. The arguments to the function + * will be the args provided or the current node. If the function returns false at any point, + * the cascade is stopped on that branch. + * @param {Function} fn The function to call + * @param {Object} scope (optional) The scope of the function (defaults to current node) + * @param {Array} args (optional) The args to call the function with (default to passing the current node) + */ + cascade : function(fn, scope, args){ + if(fn.call(scope || this, args || this) !== false){ + var cs = this.childNodes; + for(var i = 0, len = cs.length; i < len; i++) { + cs[i].cascade(fn, scope, args); + } + } + }, + + /** + * Interates the child nodes of this node, calling the specified function with each node. The scope (<i>this</i>) of + * function call will be the scope provided or the current node. The arguments to the function + * will be the args provided or the current node. If the function returns false at any point, + * the iteration stops. + * @param {Function} fn The function to call + * @param {Object} scope (optional) The scope of the function (defaults to current node) + * @param {Array} args (optional) The args to call the function with (default to passing the current node) + */ + eachChild : function(fn, scope, args){ + var cs = this.childNodes; + for(var i = 0, len = cs.length; i < len; i++) { + if(fn.call(scope || this, args || cs[i]) === false){ + break; + } + } + }, + + /** + * Finds the first child that has the attribute with the specified value. + * @param {String} attribute The attribute name + * @param {Mixed} value The value to search for + * @return {Node} The found child or null if none was found + */ + findChild : function(attribute, value){ + var cs = this.childNodes; + for(var i = 0, len = cs.length; i < len; i++) { + if(cs[i].attributes[attribute] == value){ + return cs[i]; + } + } + return null; + }, + + /** + * Finds the first child by a custom function. The child matches if the function passed + * returns true. + * @param {Function} fn + * @param {Object} scope (optional) + * @return {Node} The found child or null if none was found + */ + findChildBy : function(fn, scope){ + var cs = this.childNodes; + for(var i = 0, len = cs.length; i < len; i++) { + if(fn.call(scope||cs[i], cs[i]) === true){ + return cs[i]; + } + } + return null; + }, + + /** + * Sorts this nodes children using the supplied sort function + * @param {Function} fn + * @param {Object} scope (optional) + */ + sort : function(fn, scope){ + var cs = this.childNodes; + var len = cs.length; + if(len > 0){ + var sortFn = scope ? function(){fn.apply(scope, arguments);} : fn; + cs.sort(sortFn); + for(var i = 0; i < len; i++){ + var n = cs[i]; + n.previousSibling = cs[i-1]; + n.nextSibling = cs[i+1]; + if(i == 0){ + this.setFirstChild(n); + } + if(i == len-1){ + this.setLastChild(n); + } + } + } + }, + + /** + * Returns true if this node is an ancestor (at any point) of the passed node. + * @param {Node} node + * @return {Boolean} + */ + contains : function(node){ + return node.isAncestor(this); + }, + + /** + * Returns true if the passed node is an ancestor (at any point) of this node. + * @param {Node} node + * @return {Boolean} + */ + isAncestor : function(node){ + var p = this.parentNode; + while(p){ + if(p == node){ + return true; + } + p = p.parentNode; + } + return false; + }, + + toString : function(){ + return "[Node"+(this.id?" "+this.id:"")+"]"; + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_data_XmlReader.js.html b/docs2/src/Roo_data_XmlReader.js.html new file mode 100644 index 0000000000..8483b00cfa --- /dev/null +++ b/docs2/src/Roo_data_XmlReader.js.html @@ -0,0 +1,133 @@ +/home/alan/gitlive/roojs1/Roo/data/XmlReader.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.data.XmlReader + * @extends Roo.data.DataReader + * Data reader class to create an Array of {@link Roo.data.Record} objects from an XML document + * based on mappings in a provided Roo.data.Record constructor.<br><br> + * <p> + * <em>Note that in order for the browser to parse a returned XML document, the Content-Type + * header in the HTTP response must be set to "text/xml".</em> + * <p> + * Example code: + * <pre><code> +var RecordDef = Roo.data.Record.create([ + {name: 'name', mapping: 'name'}, // "mapping" property not needed if it's the same as "name" + {name: 'occupation'} // This field will use "occupation" as the mapping. +]); +var myReader = new Roo.data.XmlReader({ + totalRecords: "results", // The element which contains the total dataset size (optional) + record: "row", // The repeated element which contains row information + id: "id" // The element within the row that provides an ID for the record (optional) +}, RecordDef); +</code></pre> + * <p> + * This would consume an XML file like this: + * <pre><code> +&lt;?xml?> +&lt;dataset> + &lt;results>2&lt;/results> + &lt;row> + &lt;id>1&lt;/id> + &lt;name>Bill&lt;/name> + &lt;occupation>Gardener&lt;/occupation> + &lt;/row> + &lt;row> + &lt;id>2&lt;/id> + &lt;name>Ben&lt;/name> + &lt;occupation>Horticulturalist&lt;/occupation> + &lt;/row> +&lt;/dataset> +</code></pre> + * @cfg {String} totalRecords The DomQuery path from which to retrieve the total number of records + * in the dataset. This is only needed if the whole dataset is not passed in one go, but is being + * paged from the remote server. + * @cfg {String} record The DomQuery path to the repeated element which contains record information. + * @cfg {String} success The DomQuery path to the success attribute used by forms. + * @cfg {String} id The DomQuery path relative from the record element to the element that contains + * a record identifier value. + * @constructor + * Create a new XmlReader + * @param {Object} meta Metadata configuration options + * @param {Mixed} recordType The definition of the data record type to produce. This can be either a valid + * Record subclass created with {@link Roo.data.Record#create}, or an array of objects with which to call + * Roo.data.Record.create. See the {@link Roo.data.Record} class for more details. + */ +Roo.data.XmlReader = function(meta, recordType){ + meta = meta || {}; + Roo.data.XmlReader.superclass.constructor.call(this, meta, recordType||meta.fields); +}; +Roo.extend(Roo.data.XmlReader, Roo.data.DataReader, { + /** + * This method is only used by a DataProxy which has retrieved data from a remote server. + * @param {Object} response The XHR object which contains the parsed XML document. The response is expected + * to contain a method called 'responseXML' that returns an XML document object. + * @return {Object} records A data block which is used by an {@link Roo.data.Store} as + * a cache of Roo.data.Records. + */ + read : function(response){ + var doc = response.responseXML; + if(!doc) { + throw {message: "XmlReader.read: XML Document not available"}; + } + return this.readRecords(doc); + }, + + /** + * Create a data block containing Roo.data.Records from an XML document. + * @param {Object} doc A parsed XML document. + * @return {Object} records A data block which is used by an {@link Roo.data.Store} as + * a cache of Roo.data.Records. + */ + readRecords : function(doc){ + /** + * After any data loads/reads, the raw XML Document is available for further custom processing. + * @type XMLDocument + */ + this.xmlData = doc; + var root = doc.documentElement || doc; + var q = Roo.DomQuery; + var recordType = this.recordType, fields = recordType.prototype.fields; + var sid = this.meta.id; + var totalRecords = 0, success = true; + if(this.meta.totalRecords){ + totalRecords = q.selectNumber(this.meta.totalRecords, root, 0); + } + + if(this.meta.success){ + var sv = q.selectValue(this.meta.success, root, true); + success = sv !== false && sv !== 'false'; + } + var records = []; + var ns = q.select(this.meta.record, root); + for(var i = 0, len = ns.length; i < len; i++) { + var n = ns[i]; + var values = {}; + var id = sid ? q.selectValue(sid, n) : undefined; + for(var j = 0, jlen = fields.length; j < jlen; j++){ + var f = fields.items[j]; + var v = q.selectValue(f.mapping || f.name, n, f.defaultValue); + v = f.convert(v); + values[f.name] = v; + } + var record = new recordType(values, id); + record.node = n; + records[records.length] = record; + } + + return { + success : success, + records : records, + totalRecords : totalRecords || records.length + }; + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_dd_DD.js.html b/docs2/src/Roo_dd_DD.js.html new file mode 100644 index 0000000000..35de4fb118 --- /dev/null +++ b/docs2/src/Roo_dd_DD.js.html @@ -0,0 +1,300 @@ +/home/alan/gitlive/roojs1/Roo/dd/DD.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.dd.DD + * A DragDrop implementation where the linked element follows the + * mouse cursor during a drag. + * @extends Roo.dd.DragDrop + * @constructor + * @param {String} id the id of the linked element + * @param {String} sGroup the group of related DragDrop items + * @param {object} config an object containing configurable attributes + * Valid properties for DD: + * scroll + */ +Roo.dd.DD = function(id, sGroup, config) { + if (id) { + this.init(id, sGroup, config); + } +}; + +Roo.extend(Roo.dd.DD, Roo.dd.DragDrop, { + + /** + * When set to true, the utility automatically tries to scroll the browser + * window wehn a drag and drop element is dragged near the viewport boundary. + * Defaults to true. + * @property scroll + * @type boolean + */ + scroll: true, + + /** + * Sets the pointer offset to the distance between the linked element's top + * left corner and the location the element was clicked + * @method autoOffset + * @param {int} iPageX the X coordinate of the click + * @param {int} iPageY the Y coordinate of the click + */ + autoOffset: function(iPageX, iPageY) { + var x = iPageX - this.startPageX; + var y = iPageY - this.startPageY; + this.setDelta(x, y); + }, + + /** + * Sets the pointer offset. You can call this directly to force the + * offset to be in a particular location (e.g., pass in 0,0 to set it + * to the center of the object) + * @method setDelta + * @param {int} iDeltaX the distance from the left + * @param {int} iDeltaY the distance from the top + */ + setDelta: function(iDeltaX, iDeltaY) { + this.deltaX = iDeltaX; + this.deltaY = iDeltaY; + }, + + /** + * Sets the drag element to the location of the mousedown or click event, + * maintaining the cursor location relative to the location on the element + * that was clicked. Override this if you want to place the element in a + * location other than where the cursor is. + * @method setDragElPos + * @param {int} iPageX the X coordinate of the mousedown or drag event + * @param {int} iPageY the Y coordinate of the mousedown or drag event + */ + setDragElPos: function(iPageX, iPageY) { + // the first time we do this, we are going to check to make sure + // the element has css positioning + + var el = this.getDragEl(); + this.alignElWithMouse(el, iPageX, iPageY); + }, + + /** + * Sets the element to the location of the mousedown or click event, + * maintaining the cursor location relative to the location on the element + * that was clicked. Override this if you want to place the element in a + * location other than where the cursor is. + * @method alignElWithMouse + * @param {HTMLElement} el the element to move + * @param {int} iPageX the X coordinate of the mousedown or drag event + * @param {int} iPageY the Y coordinate of the mousedown or drag event + */ + alignElWithMouse: function(el, iPageX, iPageY) { + var oCoord = this.getTargetCoord(iPageX, iPageY); + var fly = el.dom ? el : Roo.fly(el); + if (!this.deltaSetXY) { + var aCoord = [oCoord.x, oCoord.y]; + fly.setXY(aCoord); + var newLeft = fly.getLeft(true); + var newTop = fly.getTop(true); + this.deltaSetXY = [ newLeft - oCoord.x, newTop - oCoord.y ]; + } else { + fly.setLeftTop(oCoord.x + this.deltaSetXY[0], oCoord.y + this.deltaSetXY[1]); + } + + this.cachePosition(oCoord.x, oCoord.y); + this.autoScroll(oCoord.x, oCoord.y, el.offsetHeight, el.offsetWidth); + return oCoord; + }, + + /** + * Saves the most recent position so that we can reset the constraints and + * tick marks on-demand. We need to know this so that we can calculate the + * number of pixels the element is offset from its original position. + * @method cachePosition + * @param iPageX the current x position (optional, this just makes it so we + * don't have to look it up again) + * @param iPageY the current y position (optional, this just makes it so we + * don't have to look it up again) + */ + cachePosition: function(iPageX, iPageY) { + if (iPageX) { + this.lastPageX = iPageX; + this.lastPageY = iPageY; + } else { + var aCoord = Roo.lib.Dom.getXY(this.getEl()); + this.lastPageX = aCoord[0]; + this.lastPageY = aCoord[1]; + } + }, + + /** + * Auto-scroll the window if the dragged object has been moved beyond the + * visible window boundary. + * @method autoScroll + * @param {int} x the drag element's x position + * @param {int} y the drag element's y position + * @param {int} h the height of the drag element + * @param {int} w the width of the drag element + * @private + */ + autoScroll: function(x, y, h, w) { + + if (this.scroll) { + // The client height + var clientH = Roo.lib.Dom.getViewWidth(); + + // The client width + var clientW = Roo.lib.Dom.getViewHeight(); + + // The amt scrolled down + var st = this.DDM.getScrollTop(); + + // The amt scrolled right + var sl = this.DDM.getScrollLeft(); + + // Location of the bottom of the element + var bot = h + y; + + // Location of the right of the element + var right = w + x; + + // The distance from the cursor to the bottom of the visible area, + // adjusted so that we don't scroll if the cursor is beyond the + // element drag constraints + var toBot = (clientH + st - y - this.deltaY); + + // The distance from the cursor to the right of the visible area + var toRight = (clientW + sl - x - this.deltaX); + + + // How close to the edge the cursor must be before we scroll + // var thresh = (document.all) ? 100 : 40; + var thresh = 40; + + // How many pixels to scroll per autoscroll op. This helps to reduce + // clunky scrolling. IE is more sensitive about this ... it needs this + // value to be higher. + var scrAmt = (document.all) ? 80 : 30; + + // Scroll down if we are near the bottom of the visible page and the + // obj extends below the crease + if ( bot > clientH && toBot < thresh ) { + window.scrollTo(sl, st + scrAmt); + } + + // Scroll up if the window is scrolled down and the top of the object + // goes above the top border + if ( y < st && st > 0 && y - st < thresh ) { + window.scrollTo(sl, st - scrAmt); + } + + // Scroll right if the obj is beyond the right border and the cursor is + // near the border. + if ( right > clientW && toRight < thresh ) { + window.scrollTo(sl + scrAmt, st); + } + + // Scroll left if the window has been scrolled to the right and the obj + // extends past the left border + if ( x < sl && sl > 0 && x - sl < thresh ) { + window.scrollTo(sl - scrAmt, st); + } + } + }, + + /** + * Finds the location the element should be placed if we want to move + * it to where the mouse location less the click offset would place us. + * @method getTargetCoord + * @param {int} iPageX the X coordinate of the click + * @param {int} iPageY the Y coordinate of the click + * @return an object that contains the coordinates (Object.x and Object.y) + * @private + */ + getTargetCoord: function(iPageX, iPageY) { + + + var x = iPageX - this.deltaX; + var y = iPageY - this.deltaY; + + if (this.constrainX) { + if (x < this.minX) { x = this.minX; } + if (x > this.maxX) { x = this.maxX; } + } + + if (this.constrainY) { + if (y < this.minY) { y = this.minY; } + if (y > this.maxY) { y = this.maxY; } + } + + x = this.getTick(x, this.xTicks); + y = this.getTick(y, this.yTicks); + + + return {x:x, y:y}; + }, + + /* + * Sets up config options specific to this class. Overrides + * Roo.dd.DragDrop, but all versions of this method through the + * inheritance chain are called + */ + applyConfig: function() { + Roo.dd.DD.superclass.applyConfig.call(this); + this.scroll = (this.config.scroll !== false); + }, + + /* + * Event that fires prior to the onMouseDown event. Overrides + * Roo.dd.DragDrop. + */ + b4MouseDown: function(e) { + // this.resetConstraints(); + this.autoOffset(e.getPageX(), + e.getPageY()); + }, + + /* + * Event that fires prior to the onDrag event. Overrides + * Roo.dd.DragDrop. + */ + b4Drag: function(e) { + this.setDragElPos(e.getPageX(), + e.getPageY()); + }, + + toString: function() { + return ("DD " + this.id); + } + + ////////////////////////////////////////////////////////////////////////// + // Debugging ygDragDrop events that can be overridden + ////////////////////////////////////////////////////////////////////////// + /* + startDrag: function(x, y) { + }, + + onDrag: function(e) { + }, + + onDragEnter: function(e, id) { + }, + + onDragOver: function(e, id) { + }, + + onDragOut: function(e, id) { + }, + + onDragDrop: function(e, id) { + }, + + endDrag: function(e) { + } + + */ + +}); \ No newline at end of file diff --git a/docs2/src/Roo_dd_DDProxy.js.html b/docs2/src/Roo_dd_DDProxy.js.html new file mode 100644 index 0000000000..9e53433242 --- /dev/null +++ b/docs2/src/Roo_dd_DDProxy.js.html @@ -0,0 +1,209 @@ +/home/alan/gitlive/roojs1/Roo/dd/DDProxy.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.dd.DDProxy + * A DragDrop implementation that inserts an empty, bordered div into + * the document that follows the cursor during drag operations. At the time of + * the click, the frame div is resized to the dimensions of the linked html + * element, and moved to the exact location of the linked element. + * + * References to the "frame" element refer to the single proxy element that + * was created to be dragged in place of all DDProxy elements on the + * page. + * + * @extends Roo.dd.DD + * @constructor + * @param {String} id the id of the linked html element + * @param {String} sGroup the group of related DragDrop objects + * @param {object} config an object containing configurable attributes + * Valid properties for DDProxy in addition to those in DragDrop: + * resizeFrame, centerFrame, dragElId + */ +Roo.dd.DDProxy = function(id, sGroup, config) { + if (id) { + this.init(id, sGroup, config); + this.initFrame(); + } +}; + +/** + * The default drag frame div id + * @property Roo.dd.DDProxy.dragElId + * @type String + * @static + */ +Roo.dd.DDProxy.dragElId = "ygddfdiv"; + +Roo.extend(Roo.dd.DDProxy, Roo.dd.DD, { + + /** + * By default we resize the drag frame to be the same size as the element + * we want to drag (this is to get the frame effect). We can turn it off + * if we want a different behavior. + * @property resizeFrame + * @type boolean + */ + resizeFrame: true, + + /** + * By default the frame is positioned exactly where the drag element is, so + * we use the cursor offset provided by Roo.dd.DD. Another option that works only if + * you do not have constraints on the obj is to have the drag frame centered + * around the cursor. Set centerFrame to true for this effect. + * @property centerFrame + * @type boolean + */ + centerFrame: false, + + /** + * Creates the proxy element if it does not yet exist + * @method createFrame + */ + createFrame: function() { + var self = this; + var body = document.body; + + if (!body || !body.firstChild) { + setTimeout( function() { self.createFrame(); }, 50 ); + return; + } + + var div = this.getDragEl(); + + if (!div) { + div = document.createElement("div"); + div.id = this.dragElId; + var s = div.style; + + s.position = "absolute"; + s.visibility = "hidden"; + s.cursor = "move"; + s.border = "2px solid #aaa"; + s.zIndex = 999; + + // appendChild can blow up IE if invoked prior to the window load event + // while rendering a table. It is possible there are other scenarios + // that would cause this to happen as well. + body.insertBefore(div, body.firstChild); + } + }, + + /** + * Initialization for the drag frame element. Must be called in the + * constructor of all subclasses + * @method initFrame + */ + initFrame: function() { + this.createFrame(); + }, + + applyConfig: function() { + Roo.dd.DDProxy.superclass.applyConfig.call(this); + + this.resizeFrame = (this.config.resizeFrame !== false); + this.centerFrame = (this.config.centerFrame); + this.setDragElId(this.config.dragElId || Roo.dd.DDProxy.dragElId); + }, + + /** + * Resizes the drag frame to the dimensions of the clicked object, positions + * it over the object, and finally displays it + * @method showFrame + * @param {int} iPageX X click position + * @param {int} iPageY Y click position + * @private + */ + showFrame: function(iPageX, iPageY) { + var el = this.getEl(); + var dragEl = this.getDragEl(); + var s = dragEl.style; + + this._resizeProxy(); + + if (this.centerFrame) { + this.setDelta( Math.round(parseInt(s.width, 10)/2), + Math.round(parseInt(s.height, 10)/2) ); + } + + this.setDragElPos(iPageX, iPageY); + + Roo.fly(dragEl).show(); + }, + + /** + * The proxy is automatically resized to the dimensions of the linked + * element when a drag is initiated, unless resizeFrame is set to false + * @method _resizeProxy + * @private + */ + _resizeProxy: function() { + if (this.resizeFrame) { + var el = this.getEl(); + Roo.fly(this.getDragEl()).setSize(el.offsetWidth, el.offsetHeight); + } + }, + + // overrides Roo.dd.DragDrop + b4MouseDown: function(e) { + var x = e.getPageX(); + var y = e.getPageY(); + this.autoOffset(x, y); + this.setDragElPos(x, y); + }, + + // overrides Roo.dd.DragDrop + b4StartDrag: function(x, y) { + // show the drag frame + this.showFrame(x, y); + }, + + // overrides Roo.dd.DragDrop + b4EndDrag: function(e) { + Roo.fly(this.getDragEl()).hide(); + }, + + // overrides Roo.dd.DragDrop + // By default we try to move the element to the last location of the frame. + // This is so that the default behavior mirrors that of Roo.dd.DD. + endDrag: function(e) { + + var lel = this.getEl(); + var del = this.getDragEl(); + + // Show the drag frame briefly so we can get its position + del.style.visibility = ""; + + this.beforeMove(); + // Hide the linked element before the move to get around a Safari + // rendering bug. + lel.style.visibility = "hidden"; + Roo.dd.DDM.moveToEl(lel, del); + del.style.visibility = "hidden"; + lel.style.visibility = ""; + + this.afterDrag(); + }, + + beforeMove : function(){ + + }, + + afterDrag : function(){ + + }, + + toString: function() { + return ("DDProxy " + this.id); + } + +}); + \ No newline at end of file diff --git a/docs2/src/Roo_dd_DDTarget.js.html b/docs2/src/Roo_dd_DDTarget.js.html new file mode 100644 index 0000000000..37875bdba7 --- /dev/null +++ b/docs2/src/Roo_dd_DDTarget.js.html @@ -0,0 +1,45 @@ +/home/alan/gitlive/roojs1/Roo/dd/DDTarget.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + /** + * @class Roo.dd.DDTarget + * A DragDrop implementation that does not move, but can be a drop + * target. You would get the same result by simply omitting implementation + * for the event callbacks, but this way we reduce the processing cost of the + * event listener and the callbacks. + * @extends Roo.dd.DragDrop + * @constructor + * @param {String} id the id of the element that is a drop target + * @param {String} sGroup the group of related DragDrop objects + * @param {object} config an object containing configurable attributes + * Valid properties for DDTarget in addition to those in + * DragDrop: + * none + */ +Roo.dd.DDTarget = function(id, sGroup, config) { + if (id) { + this.initTarget(id, sGroup, config); + } + if (config.listeners || config.events) { + Roo.dd.DragDrop.superclass.constructor.call(this, { + listeners : config.listeners || {}, + events : config.events || {} + }); + } +}; + +// Roo.dd.DDTarget.prototype = new Roo.dd.DragDrop(); +Roo.extend(Roo.dd.DDTarget, Roo.dd.DragDrop, { + toString: function() { + return ("DDTarget " + this.id); + } +}); + \ No newline at end of file diff --git a/docs2/src/Roo_dd_DragDrop.js.html b/docs2/src/Roo_dd_DragDrop.js.html new file mode 100644 index 0000000000..5ada5e0e46 --- /dev/null +++ b/docs2/src/Roo_dd_DragDrop.js.html @@ -0,0 +1,1180 @@ +/home/alan/gitlive/roojs1/Roo/dd/DragDrop.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + + +/* + * These classes are derivatives of the similarly named classes in the YUI Library. + * The original license: + * Copyright (c) 2006, Yahoo! Inc. All rights reserved. + * Code licensed under the BSD License: + * http://developer.yahoo.net/yui/license.txt + */ + +(function() { + +var Event=Roo.EventManager; +var Dom=Roo.lib.Dom; + +/** + * @class Roo.dd.DragDrop + * @extends Roo.util.Observable + * Defines the interface and base operation of items that that can be + * dragged or can be drop targets. It was designed to be extended, overriding + * the event handlers for startDrag, onDrag, onDragOver and onDragOut. + * Up to three html elements can be associated with a DragDrop instance: + * <ul> + * <li>linked element: the element that is passed into the constructor. + * This is the element which defines the boundaries for interaction with + * other DragDrop objects.</li> + * <li>handle element(s): The drag operation only occurs if the element that + * was clicked matches a handle element. By default this is the linked + * element, but there are times that you will want only a portion of the + * linked element to initiate the drag operation, and the setHandleElId() + * method provides a way to define this.</li> + * <li>drag element: this represents the element that would be moved along + * with the cursor during a drag operation. By default, this is the linked + * element itself as in {@link Roo.dd.DD}. setDragElId() lets you define + * a separate element that would be moved, as in {@link Roo.dd.DDProxy}. + * </li> + * </ul> + * This class should not be instantiated until the onload event to ensure that + * the associated elements are available. + * The following would define a DragDrop obj that would interact with any + * other DragDrop obj in the "group1" group: + * <pre> + * dd = new Roo.dd.DragDrop("div1", "group1"); + * </pre> + * Since none of the event handlers have been implemented, nothing would + * actually happen if you were to run the code above. Normally you would + * override this class or one of the default implementations, but you can + * also override the methods you want on an instance of the class... + * <pre> + * dd.onDragDrop = function(e, id) { + * &nbsp;&nbsp;alert("dd was dropped on " + id); + * } + * </pre> + * @constructor + * @param {String} id of the element that is linked to this instance + * @param {String} sGroup the group of related DragDrop objects + * @param {object} config an object containing configurable attributes + * Valid properties for DragDrop: + * padding, isTarget, maintainOffset, primaryButtonOnly + */ +Roo.dd.DragDrop = function(id, sGroup, config) { + if (id) { + this.init(id, sGroup, config); + } + +}; + +Roo.extend(Roo.dd.DragDrop, Roo.util.Observable , { + + /** + * The id of the element associated with this object. This is what we + * refer to as the "linked element" because the size and position of + * this element is used to determine when the drag and drop objects have + * interacted. + * @property id + * @type String + */ + id: null, + + /** + * Configuration attributes passed into the constructor + * @property config + * @type object + */ + config: null, + + /** + * The id of the element that will be dragged. By default this is same + * as the linked element , but could be changed to another element. Ex: + * Roo.dd.DDProxy + * @property dragElId + * @type String + * @private + */ + dragElId: null, + + /** + * the id of the element that initiates the drag operation. By default + * this is the linked element, but could be changed to be a child of this + * element. This lets us do things like only starting the drag when the + * header element within the linked html element is clicked. + * @property handleElId + * @type String + * @private + */ + handleElId: null, + + /** + * An associative array of HTML tags that will be ignored if clicked. + * @property invalidHandleTypes + * @type {string: string} + */ + invalidHandleTypes: null, + + /** + * An associative array of ids for elements that will be ignored if clicked + * @property invalidHandleIds + * @type {string: string} + */ + invalidHandleIds: null, + + /** + * An indexted array of css class names for elements that will be ignored + * if clicked. + * @property invalidHandleClasses + * @type string[] + */ + invalidHandleClasses: null, + + /** + * The linked element's absolute X position at the time the drag was + * started + * @property startPageX + * @type int + * @private + */ + startPageX: 0, + + /** + * The linked element's absolute X position at the time the drag was + * started + * @property startPageY + * @type int + * @private + */ + startPageY: 0, + + /** + * The group defines a logical collection of DragDrop objects that are + * related. Instances only get events when interacting with other + * DragDrop object in the same group. This lets us define multiple + * groups using a single DragDrop subclass if we want. + * @property groups + * @type {string: string} + */ + groups: null, + + /** + * Individual drag/drop instances can be locked. This will prevent + * onmousedown start drag. + * @property locked + * @type boolean + * @private + */ + locked: false, + + /** + * Lock this instance + * @method lock + */ + lock: function() { this.locked = true; }, + + /** + * Unlock this instace + * @method unlock + */ + unlock: function() { this.locked = false; }, + + /** + * By default, all insances can be a drop target. This can be disabled by + * setting isTarget to false. + * @method isTarget + * @type boolean + */ + isTarget: true, + + /** + * The padding configured for this drag and drop object for calculating + * the drop zone intersection with this object. + * @method padding + * @type int[] + */ + padding: null, + + /** + * Cached reference to the linked element + * @property _domRef + * @private + */ + _domRef: null, + + /** + * Internal typeof flag + * @property __ygDragDrop + * @private + */ + __ygDragDrop: true, + + /** + * Set to true when horizontal contraints are applied + * @property constrainX + * @type boolean + * @private + */ + constrainX: false, + + /** + * Set to true when vertical contraints are applied + * @property constrainY + * @type boolean + * @private + */ + constrainY: false, + + /** + * The left constraint + * @property minX + * @type int + * @private + */ + minX: 0, + + /** + * The right constraint + * @property maxX + * @type int + * @private + */ + maxX: 0, + + /** + * The up constraint + * @property minY + * @type int + * @type int + * @private + */ + minY: 0, + + /** + * The down constraint + * @property maxY + * @type int + * @private + */ + maxY: 0, + + /** + * Maintain offsets when we resetconstraints. Set to true when you want + * the position of the element relative to its parent to stay the same + * when the page changes + * + * @property maintainOffset + * @type boolean + */ + maintainOffset: false, + + /** + * Array of pixel locations the element will snap to if we specified a + * horizontal graduation/interval. This array is generated automatically + * when you define a tick interval. + * @property xTicks + * @type int[] + */ + xTicks: null, + + /** + * Array of pixel locations the element will snap to if we specified a + * vertical graduation/interval. This array is generated automatically + * when you define a tick interval. + * @property yTicks + * @type int[] + */ + yTicks: null, + + /** + * By default the drag and drop instance will only respond to the primary + * button click (left button for a right-handed mouse). Set to true to + * allow drag and drop to start with any mouse click that is propogated + * by the browser + * @property primaryButtonOnly + * @type boolean + */ + primaryButtonOnly: true, + + /** + * The availabe property is false until the linked dom element is accessible. + * @property available + * @type boolean + */ + available: false, + + /** + * By default, drags can only be initiated if the mousedown occurs in the + * region the linked element is. This is done in part to work around a + * bug in some browsers that mis-report the mousedown if the previous + * mouseup happened outside of the window. This property is set to true + * if outer handles are defined. + * + * @property hasOuterHandles + * @type boolean + * @default false + */ + hasOuterHandles: false, + + /** + * Code that executes immediately before the startDrag event + * @method b4StartDrag + * @private + */ + b4StartDrag: function(x, y) { }, + + /** + * Abstract method called after a drag/drop object is clicked + * and the drag or mousedown time thresholds have beeen met. + * @method startDrag + * @param {int} X click location + * @param {int} Y click location + */ + startDrag: function(x, y) { /* override this */ }, + + /** + * Code that executes immediately before the onDrag event + * @method b4Drag + * @private + */ + b4Drag: function(e) { }, + + /** + * Abstract method called during the onMouseMove event while dragging an + * object. + * @method onDrag + * @param {Event} e the mousemove event + */ + onDrag: function(e) { /* override this */ }, + + /** + * Abstract method called when this element fist begins hovering over + * another DragDrop obj + * @method onDragEnter + * @param {Event} e the mousemove event + * @param {String|DragDrop[]} id In POINT mode, the element + * id this is hovering over. In INTERSECT mode, an array of one or more + * dragdrop items being hovered over. + */ + onDragEnter: function(e, id) { /* override this */ }, + + /** + * Code that executes immediately before the onDragOver event + * @method b4DragOver + * @private + */ + b4DragOver: function(e) { }, + + /** + * Abstract method called when this element is hovering over another + * DragDrop obj + * @method onDragOver + * @param {Event} e the mousemove event + * @param {String|DragDrop[]} id In POINT mode, the element + * id this is hovering over. In INTERSECT mode, an array of dd items + * being hovered over. + */ + onDragOver: function(e, id) { /* override this */ }, + + /** + * Code that executes immediately before the onDragOut event + * @method b4DragOut + * @private + */ + b4DragOut: function(e) { }, + + /** + * Abstract method called when we are no longer hovering over an element + * @method onDragOut + * @param {Event} e the mousemove event + * @param {String|DragDrop[]} id In POINT mode, the element + * id this was hovering over. In INTERSECT mode, an array of dd items + * that the mouse is no longer over. + */ + onDragOut: function(e, id) { /* override this */ }, + + /** + * Code that executes immediately before the onDragDrop event + * @method b4DragDrop + * @private + */ + b4DragDrop: function(e) { }, + + /** + * Abstract method called when this item is dropped on another DragDrop + * obj + * @method onDragDrop + * @param {Event} e the mouseup event + * @param {String|DragDrop[]} id In POINT mode, the element + * id this was dropped on. In INTERSECT mode, an array of dd items this + * was dropped on. + */ + onDragDrop: function(e, id) { /* override this */ }, + + /** + * Abstract method called when this item is dropped on an area with no + * drop target + * @method onInvalidDrop + * @param {Event} e the mouseup event + */ + onInvalidDrop: function(e) { /* override this */ }, + + /** + * Code that executes immediately before the endDrag event + * @method b4EndDrag + * @private + */ + b4EndDrag: function(e) { }, + + /** + * Fired when we are done dragging the object + * @method endDrag + * @param {Event} e the mouseup event + */ + endDrag: function(e) { /* override this */ }, + + /** + * Code executed immediately before the onMouseDown event + * @method b4MouseDown + * @param {Event} e the mousedown event + * @private + */ + b4MouseDown: function(e) { }, + + /** + * Event handler that fires when a drag/drop obj gets a mousedown + * @method onMouseDown + * @param {Event} e the mousedown event + */ + onMouseDown: function(e) { /* override this */ }, + + /** + * Event handler that fires when a drag/drop obj gets a mouseup + * @method onMouseUp + * @param {Event} e the mouseup event + */ + onMouseUp: function(e) { /* override this */ }, + + /** + * Override the onAvailable method to do what is needed after the initial + * position was determined. + * @method onAvailable + */ + onAvailable: function () { + }, + + /* + * Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}). + * @type Object + */ + defaultPadding : {left:0, right:0, top:0, bottom:0}, + + /* + * Initializes the drag drop object's constraints to restrict movement to a certain element. + * + * Usage: + <pre><code> + var dd = new Roo.dd.DDProxy("dragDiv1", "proxytest", + { dragElId: "existingProxyDiv" }); + dd.startDrag = function(){ + this.constrainTo("parent-id"); + }; + </code></pre> + * Or you can initalize it using the {@link Roo.Element} object: + <pre><code> + Roo.get("dragDiv1").initDDProxy("proxytest", {dragElId: "existingProxyDiv"}, { + startDrag : function(){ + this.constrainTo("parent-id"); + } + }); + </code></pre> + * @param {String/HTMLElement/Element} constrainTo The element to constrain to. + * @param {Object/Number} pad (optional) Pad provides a way to specify "padding" of the constraints, + * and can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or + * an object containing the sides to pad. For example: {right:10, bottom:10} + * @param {Boolean} inContent (optional) Constrain the draggable in the content box of the element (inside padding and borders) + */ + constrainTo : function(constrainTo, pad, inContent){ + if(typeof pad == "number"){ + pad = {left: pad, right:pad, top:pad, bottom:pad}; + } + pad = pad || this.defaultPadding; + var b = Roo.get(this.getEl()).getBox(); + var ce = Roo.get(constrainTo); + var s = ce.getScroll(); + var c, cd = ce.dom; + if(cd == document.body){ + c = { x: s.left, y: s.top, width: Roo.lib.Dom.getViewWidth(), height: Roo.lib.Dom.getViewHeight()}; + }else{ + xy = ce.getXY(); + c = {x : xy[0]+s.left, y: xy[1]+s.top, width: cd.clientWidth, height: cd.clientHeight}; + } + + + var topSpace = b.y - c.y; + var leftSpace = b.x - c.x; + + this.resetConstraints(); + this.setXConstraint(leftSpace - (pad.left||0), // left + c.width - leftSpace - b.width - (pad.right||0) //right + ); + this.setYConstraint(topSpace - (pad.top||0), //top + c.height - topSpace - b.height - (pad.bottom||0) //bottom + ); + }, + + /** + * Returns a reference to the linked element + * @method getEl + * @return {HTMLElement} the html element + */ + getEl: function() { + if (!this._domRef) { + this._domRef = Roo.getDom(this.id); + } + + return this._domRef; + }, + + /** + * Returns a reference to the actual element to drag. By default this is + * the same as the html element, but it can be assigned to another + * element. An example of this can be found in Roo.dd.DDProxy + * @method getDragEl + * @return {HTMLElement} the html element + */ + getDragEl: function() { + return Roo.getDom(this.dragElId); + }, + + /** + * Sets up the DragDrop object. Must be called in the constructor of any + * Roo.dd.DragDrop subclass + * @method init + * @param id the id of the linked element + * @param {String} sGroup the group of related items + * @param {object} config configuration attributes + */ + init: function(id, sGroup, config) { + this.initTarget(id, sGroup, config); + if (!Roo.isTouch) { + Event.on(this.id, "mousedown", this.handleMouseDown, this); + } + Event.on(this.id, "touchstart", this.handleMouseDown, this); + // Event.on(this.id, "selectstart", Event.preventDefault); + }, + + /** + * Initializes Targeting functionality only... the object does not + * get a mousedown handler. + * @method initTarget + * @param id the id of the linked element + * @param {String} sGroup the group of related items + * @param {object} config configuration attributes + */ + initTarget: function(id, sGroup, config) { + + // configuration attributes + this.config = config || {}; + + // create a local reference to the drag and drop manager + this.DDM = Roo.dd.DDM; + // initialize the groups array + this.groups = {}; + + // assume that we have an element reference instead of an id if the + // parameter is not a string + if (typeof id !== "string") { + id = Roo.id(id); + } + + // set the id + this.id = id; + + // add to an interaction group + this.addToGroup((sGroup) ? sGroup : "default"); + + // We don't want to register this as the handle with the manager + // so we just set the id rather than calling the setter. + this.handleElId = id; + + // the linked element is the element that gets dragged by default + this.setDragElId(id); + + // by default, clicked anchors will not start drag operations. + this.invalidHandleTypes = { A: "A" }; + this.invalidHandleIds = {}; + this.invalidHandleClasses = []; + + this.applyConfig(); + + this.handleOnAvailable(); + }, + + /** + * Applies the configuration parameters that were passed into the constructor. + * This is supposed to happen at each level through the inheritance chain. So + * a DDProxy implentation will execute apply config on DDProxy, DD, and + * DragDrop in order to get all of the parameters that are available in + * each object. + * @method applyConfig + */ + applyConfig: function() { + + // configurable properties: + // padding, isTarget, maintainOffset, primaryButtonOnly + this.padding = this.config.padding || [0, 0, 0, 0]; + this.isTarget = (this.config.isTarget !== false); + this.maintainOffset = (this.config.maintainOffset); + this.primaryButtonOnly = (this.config.primaryButtonOnly !== false); + + }, + + /** + * Executed when the linked element is available + * @method handleOnAvailable + * @private + */ + handleOnAvailable: function() { + this.available = true; + this.resetConstraints(); + this.onAvailable(); + }, + + /** + * Configures the padding for the target zone in px. Effectively expands + * (or reduces) the virtual object size for targeting calculations. + * Supports css-style shorthand; if only one parameter is passed, all sides + * will have that padding, and if only two are passed, the top and bottom + * will have the first param, the left and right the second. + * @method setPadding + * @param {int} iTop Top pad + * @param {int} iRight Right pad + * @param {int} iBot Bot pad + * @param {int} iLeft Left pad + */ + setPadding: function(iTop, iRight, iBot, iLeft) { + // this.padding = [iLeft, iRight, iTop, iBot]; + if (!iRight && 0 !== iRight) { + this.padding = [iTop, iTop, iTop, iTop]; + } else if (!iBot && 0 !== iBot) { + this.padding = [iTop, iRight, iTop, iRight]; + } else { + this.padding = [iTop, iRight, iBot, iLeft]; + } + }, + + /** + * Stores the initial placement of the linked element. + * @method setInitialPosition + * @param {int} diffX the X offset, default 0 + * @param {int} diffY the Y offset, default 0 + */ + setInitPosition: function(diffX, diffY) { + var el = this.getEl(); + + if (!this.DDM.verifyEl(el)) { + return; + } + + var dx = diffX || 0; + var dy = diffY || 0; + + var p = Dom.getXY( el ); + + this.initPageX = p[0] - dx; + this.initPageY = p[1] - dy; + + this.lastPageX = p[0]; + this.lastPageY = p[1]; + + + this.setStartPosition(p); + }, + + /** + * Sets the start position of the element. This is set when the obj + * is initialized, the reset when a drag is started. + * @method setStartPosition + * @param pos current position (from previous lookup) + * @private + */ + setStartPosition: function(pos) { + var p = pos || Dom.getXY( this.getEl() ); + this.deltaSetXY = null; + + this.startPageX = p[0]; + this.startPageY = p[1]; + }, + + /** + * Add this instance to a group of related drag/drop objects. All + * instances belong to at least one group, and can belong to as many + * groups as needed. + * @method addToGroup + * @param sGroup {string} the name of the group + */ + addToGroup: function(sGroup) { + this.groups[sGroup] = true; + this.DDM.regDragDrop(this, sGroup); + }, + + /** + * Remove's this instance from the supplied interaction group + * @method removeFromGroup + * @param {string} sGroup The group to drop + */ + removeFromGroup: function(sGroup) { + if (this.groups[sGroup]) { + delete this.groups[sGroup]; + } + + this.DDM.removeDDFromGroup(this, sGroup); + }, + + /** + * Allows you to specify that an element other than the linked element + * will be moved with the cursor during a drag + * @method setDragElId + * @param id {string} the id of the element that will be used to initiate the drag + */ + setDragElId: function(id) { + this.dragElId = id; + }, + + /** + * Allows you to specify a child of the linked element that should be + * used to initiate the drag operation. An example of this would be if + * you have a content div with text and links. Clicking anywhere in the + * content area would normally start the drag operation. Use this method + * to specify that an element inside of the content div is the element + * that starts the drag operation. + * @method setHandleElId + * @param id {string} the id of the element that will be used to + * initiate the drag. + */ + setHandleElId: function(id) { + if (typeof id !== "string") { + id = Roo.id(id); + } + this.handleElId = id; + this.DDM.regHandle(this.id, id); + }, + + /** + * Allows you to set an element outside of the linked element as a drag + * handle + * @method setOuterHandleElId + * @param id the id of the element that will be used to initiate the drag + */ + setOuterHandleElId: function(id) { + if (typeof id !== "string") { + id = Roo.id(id); + } + Event.on(id, "mousedown", + this.handleMouseDown, this); + this.setHandleElId(id); + + this.hasOuterHandles = true; + }, + + /** + * Remove all drag and drop hooks for this element + * @method unreg + */ + unreg: function() { + Event.un(this.id, "mousedown", + this.handleMouseDown); + Event.un(this.id, "touchstart", + this.handleMouseDown); + this._domRef = null; + this.DDM._remove(this); + }, + + destroy : function(){ + this.unreg(); + }, + + /** + * Returns true if this instance is locked, or the drag drop mgr is locked + * (meaning that all drag/drop is disabled on the page.) + * @method isLocked + * @return {boolean} true if this obj or all drag/drop is locked, else + * false + */ + isLocked: function() { + return (this.DDM.isLocked() || this.locked); + }, + + /** + * Fired when this object is clicked + * @method handleMouseDown + * @param {Event} e + * @param {Roo.dd.DragDrop} oDD the clicked dd object (this dd obj) + * @private + */ + handleMouseDown: function(e, oDD){ + + if (!Roo.isTouch && this.primaryButtonOnly && e.button != 0) { + //Roo.log('not touch/ button !=0'); + return; + } + if (e.browserEvent.touches && e.browserEvent.touches.length != 1) { + return; // double touch.. + } + + + if (this.isLocked()) { + //Roo.log('locked'); + return; + } + + this.DDM.refreshCache(this.groups); +// Roo.log([Roo.lib.Event.getPageX(e), Roo.lib.Event.getPageY(e)]); + var pt = new Roo.lib.Point(Roo.lib.Event.getPageX(e), Roo.lib.Event.getPageY(e)); + if (!this.hasOuterHandles && !this.DDM.isOverTarget(pt, this) ) { + //Roo.log('no outer handes or not over target'); + // do nothing. + } else { +// Roo.log('check validator'); + if (this.clickValidator(e)) { +// Roo.log('validate success'); + // set the initial element position + this.setStartPosition(); + + + this.b4MouseDown(e); + this.onMouseDown(e); + + this.DDM.handleMouseDown(e, this); + + this.DDM.stopEvent(e); + } else { + + + } + } + }, + + clickValidator: function(e) { + var target = e.getTarget(); + return ( this.isValidHandleChild(target) && + (this.id == this.handleElId || + this.DDM.handleWasClicked(target, this.id)) ); + }, + + /** + * Allows you to specify a tag name that should not start a drag operation + * when clicked. This is designed to facilitate embedding links within a + * drag handle that do something other than start the drag. + * @method addInvalidHandleType + * @param {string} tagName the type of element to exclude + */ + addInvalidHandleType: function(tagName) { + var type = tagName.toUpperCase(); + this.invalidHandleTypes[type] = type; + }, + + /** + * Lets you to specify an element id for a child of a drag handle + * that should not initiate a drag + * @method addInvalidHandleId + * @param {string} id the element id of the element you wish to ignore + */ + addInvalidHandleId: function(id) { + if (typeof id !== "string") { + id = Roo.id(id); + } + this.invalidHandleIds[id] = id; + }, + + /** + * Lets you specify a css class of elements that will not initiate a drag + * @method addInvalidHandleClass + * @param {string} cssClass the class of the elements you wish to ignore + */ + addInvalidHandleClass: function(cssClass) { + this.invalidHandleClasses.push(cssClass); + }, + + /** + * Unsets an excluded tag name set by addInvalidHandleType + * @method removeInvalidHandleType + * @param {string} tagName the type of element to unexclude + */ + removeInvalidHandleType: function(tagName) { + var type = tagName.toUpperCase(); + // this.invalidHandleTypes[type] = null; + delete this.invalidHandleTypes[type]; + }, + + /** + * Unsets an invalid handle id + * @method removeInvalidHandleId + * @param {string} id the id of the element to re-enable + */ + removeInvalidHandleId: function(id) { + if (typeof id !== "string") { + id = Roo.id(id); + } + delete this.invalidHandleIds[id]; + }, + + /** + * Unsets an invalid css class + * @method removeInvalidHandleClass + * @param {string} cssClass the class of the element(s) you wish to + * re-enable + */ + removeInvalidHandleClass: function(cssClass) { + for (var i=0, len=this.invalidHandleClasses.length; i<len; ++i) { + if (this.invalidHandleClasses[i] == cssClass) { + delete this.invalidHandleClasses[i]; + } + } + }, + + /** + * Checks the tag exclusion list to see if this click should be ignored + * @method isValidHandleChild + * @param {HTMLElement} node the HTMLElement to evaluate + * @return {boolean} true if this is a valid tag type, false if not + */ + isValidHandleChild: function(node) { + + var valid = true; + // var n = (node.nodeName == "#text") ? node.parentNode : node; + var nodeName; + try { + nodeName = node.nodeName.toUpperCase(); + } catch(e) { + nodeName = node.nodeName; + } + valid = valid && !this.invalidHandleTypes[nodeName]; + valid = valid && !this.invalidHandleIds[node.id]; + + for (var i=0, len=this.invalidHandleClasses.length; valid && i<len; ++i) { + valid = !Dom.hasClass(node, this.invalidHandleClasses[i]); + } + + + return valid; + + }, + + /** + * Create the array of horizontal tick marks if an interval was specified + * in setXConstraint(). + * @method setXTicks + * @private + */ + setXTicks: function(iStartX, iTickSize) { + this.xTicks = []; + this.xTickSize = iTickSize; + + var tickMap = {}; + + for (var i = this.initPageX; i >= this.minX; i = i - iTickSize) { + if (!tickMap[i]) { + this.xTicks[this.xTicks.length] = i; + tickMap[i] = true; + } + } + + for (i = this.initPageX; i <= this.maxX; i = i + iTickSize) { + if (!tickMap[i]) { + this.xTicks[this.xTicks.length] = i; + tickMap[i] = true; + } + } + + this.xTicks.sort(this.DDM.numericSort) ; + }, + + /** + * Create the array of vertical tick marks if an interval was specified in + * setYConstraint(). + * @method setYTicks + * @private + */ + setYTicks: function(iStartY, iTickSize) { + this.yTicks = []; + this.yTickSize = iTickSize; + + var tickMap = {}; + + for (var i = this.initPageY; i >= this.minY; i = i - iTickSize) { + if (!tickMap[i]) { + this.yTicks[this.yTicks.length] = i; + tickMap[i] = true; + } + } + + for (i = this.initPageY; i <= this.maxY; i = i + iTickSize) { + if (!tickMap[i]) { + this.yTicks[this.yTicks.length] = i; + tickMap[i] = true; + } + } + + this.yTicks.sort(this.DDM.numericSort) ; + }, + + /** + * By default, the element can be dragged any place on the screen. Use + * this method to limit the horizontal travel of the element. Pass in + * 0,0 for the parameters if you want to lock the drag to the y axis. + * @method setXConstraint + * @param {int} iLeft the number of pixels the element can move to the left + * @param {int} iRight the number of pixels the element can move to the + * right + * @param {int} iTickSize optional parameter for specifying that the + * element + * should move iTickSize pixels at a time. + */ + setXConstraint: function(iLeft, iRight, iTickSize) { + this.leftConstraint = iLeft; + this.rightConstraint = iRight; + + this.minX = this.initPageX - iLeft; + this.maxX = this.initPageX + iRight; + if (iTickSize) { this.setXTicks(this.initPageX, iTickSize); } + + this.constrainX = true; + }, + + /** + * Clears any constraints applied to this instance. Also clears ticks + * since they can't exist independent of a constraint at this time. + * @method clearConstraints + */ + clearConstraints: function() { + this.constrainX = false; + this.constrainY = false; + this.clearTicks(); + }, + + /** + * Clears any tick interval defined for this instance + * @method clearTicks + */ + clearTicks: function() { + this.xTicks = null; + this.yTicks = null; + this.xTickSize = 0; + this.yTickSize = 0; + }, + + /** + * By default, the element can be dragged any place on the screen. Set + * this to limit the vertical travel of the element. Pass in 0,0 for the + * parameters if you want to lock the drag to the x axis. + * @method setYConstraint + * @param {int} iUp the number of pixels the element can move up + * @param {int} iDown the number of pixels the element can move down + * @param {int} iTickSize optional parameter for specifying that the + * element should move iTickSize pixels at a time. + */ + setYConstraint: function(iUp, iDown, iTickSize) { + this.topConstraint = iUp; + this.bottomConstraint = iDown; + + this.minY = this.initPageY - iUp; + this.maxY = this.initPageY + iDown; + if (iTickSize) { this.setYTicks(this.initPageY, iTickSize); } + + this.constrainY = true; + + }, + + /** + * resetConstraints must be called if you manually reposition a dd element. + * @method resetConstraints + * @param {boolean} maintainOffset + */ + resetConstraints: function() { + + + // Maintain offsets if necessary + if (this.initPageX || this.initPageX === 0) { + // figure out how much this thing has moved + var dx = (this.maintainOffset) ? this.lastPageX - this.initPageX : 0; + var dy = (this.maintainOffset) ? this.lastPageY - this.initPageY : 0; + + this.setInitPosition(dx, dy); + + // This is the first time we have detected the element's position + } else { + this.setInitPosition(); + } + + if (this.constrainX) { + this.setXConstraint( this.leftConstraint, + this.rightConstraint, + this.xTickSize ); + } + + if (this.constrainY) { + this.setYConstraint( this.topConstraint, + this.bottomConstraint, + this.yTickSize ); + } + }, + + /** + * Normally the drag element is moved pixel by pixel, but we can specify + * that it move a number of pixels at a time. This method resolves the + * location when we have it set up like this. + * @method getTick + * @param {int} val where we want to place the object + * @param {int[]} tickArray sorted array of valid points + * @return {int} the closest tick + * @private + */ + getTick: function(val, tickArray) { + + if (!tickArray) { + // If tick interval is not defined, it is effectively 1 pixel, + // so we return the value passed to us. + return val; + } else if (tickArray[0] >= val) { + // The value is lower than the first tick, so we return the first + // tick. + return tickArray[0]; + } else { + for (var i=0, len=tickArray.length; i<len; ++i) { + var next = i + 1; + if (tickArray[next] && tickArray[next] >= val) { + var diff1 = val - tickArray[i]; + var diff2 = tickArray[next] - val; + return (diff2 > diff1) ? tickArray[i] : tickArray[next]; + } + } + + // The value is larger than the last tick, so we return the last + // tick. + return tickArray[tickArray.length - 1]; + } + }, + + /** + * toString method + * @method toString + * @return {string} string representation of the dd obj + */ + toString: function() { + return ("DragDrop " + this.id); + } + +}); + +})(); + \ No newline at end of file diff --git a/docs2/src/Roo_dd_DragDropMgr.js.html b/docs2/src/Roo_dd_DragDropMgr.js.html new file mode 100644 index 0000000000..9292062be6 --- /dev/null +++ b/docs2/src/Roo_dd_DragDropMgr.js.html @@ -0,0 +1,1308 @@ +/home/alan/gitlive/roojs1/Roo/dd/DragDropMgr.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * The drag and drop utility provides a framework for building drag and drop + * applications. In addition to enabling drag and drop for specific elements, + * the drag and drop elements are tracked by the manager class, and the + * interactions between the various elements are tracked during the drag and + * the implementing code is notified about these important moments. + */ + +// Only load the library once. Rewriting the manager class would orphan +// existing drag and drop instances. +if (!Roo.dd.DragDropMgr) { + +/** + * @class Roo.dd.DragDropMgr + * DragDropMgr is a singleton that tracks the element interaction for + * all DragDrop items in the window. Generally, you will not call + * this class directly, but it does have helper methods that could + * be useful in your DragDrop implementations. + * @singleton + */ +Roo.dd.DragDropMgr = function() { + + var Event = Roo.EventManager; + + return { + + /** + * Two dimensional Array of registered DragDrop objects. The first + * dimension is the DragDrop item group, the second the DragDrop + * object. + * @property ids + * @type {string: string} + * @private + * @static + */ + ids: {}, + + /** + * Array of element ids defined as drag handles. Used to determine + * if the element that generated the mousedown event is actually the + * handle and not the html element itself. + * @property handleIds + * @type {string: string} + * @private + * @static + */ + handleIds: {}, + + /** + * the DragDrop object that is currently being dragged + * @property dragCurrent + * @type DragDrop + * @private + * @static + **/ + dragCurrent: null, + + /** + * the DragDrop object(s) that are being hovered over + * @property dragOvers + * @type Array + * @private + * @static + */ + dragOvers: {}, + + /** + * the X distance between the cursor and the object being dragged + * @property deltaX + * @type int + * @private + * @static + */ + deltaX: 0, + + /** + * the Y distance between the cursor and the object being dragged + * @property deltaY + * @type int + * @private + * @static + */ + deltaY: 0, + + /** + * Flag to determine if we should prevent the default behavior of the + * events we define. By default this is true, but this can be set to + * false if you need the default behavior (not recommended) + * @property preventDefault + * @type boolean + * @static + */ + preventDefault: true, + + /** + * Flag to determine if we should stop the propagation of the events + * we generate. This is true by default but you may want to set it to + * false if the html element contains other features that require the + * mouse click. + * @property stopPropagation + * @type boolean + * @static + */ + stopPropagation: true, + + /** + * Internal flag that is set to true when drag and drop has been + * intialized + * @property initialized + * @private + * @static + */ + initalized: false, + + /** + * All drag and drop can be disabled. + * @property locked + * @private + * @static + */ + locked: false, + + /** + * Called the first time an element is registered. + * @method init + * @private + * @static + */ + init: function() { + this.initialized = true; + }, + + /** + * In point mode, drag and drop interaction is defined by the + * location of the cursor during the drag/drop + * @property POINT + * @type int + * @static + */ + POINT: 0, + + /** + * In intersect mode, drag and drop interactio nis defined by the + * overlap of two or more drag and drop objects. + * @property INTERSECT + * @type int + * @static + */ + INTERSECT: 1, + + /** + * The current drag and drop mode. Default: POINT + * @property mode + * @type int + * @static + */ + mode: 0, + + /** + * Runs method on all drag and drop objects + * @method _execOnAll + * @private + * @static + */ + _execOnAll: function(sMethod, args) { + for (var i in this.ids) { + for (var j in this.ids[i]) { + var oDD = this.ids[i][j]; + if (! this.isTypeOfDD(oDD)) { + continue; + } + oDD[sMethod].apply(oDD, args); + } + } + }, + + /** + * Drag and drop initialization. Sets up the global event handlers + * @method _onLoad + * @private + * @static + */ + _onLoad: function() { + + this.init(); + + if (!Roo.isTouch) { + Event.on(document, "mouseup", this.handleMouseUp, this, true); + Event.on(document, "mousemove", this.handleMouseMove, this, true); + } + Event.on(document, "touchend", this.handleMouseUp, this, true); + Event.on(document, "touchmove", this.handleMouseMove, this, true); + + Event.on(window, "unload", this._onUnload, this, true); + Event.on(window, "resize", this._onResize, this, true); + // Event.on(window, "mouseout", this._test); + + }, + + /** + * Reset constraints on all drag and drop objs + * @method _onResize + * @private + * @static + */ + _onResize: function(e) { + this._execOnAll("resetConstraints", []); + }, + + /** + * Lock all drag and drop functionality + * @method lock + * @static + */ + lock: function() { this.locked = true; }, + + /** + * Unlock all drag and drop functionality + * @method unlock + * @static + */ + unlock: function() { this.locked = false; }, + + /** + * Is drag and drop locked? + * @method isLocked + * @return {boolean} True if drag and drop is locked, false otherwise. + * @static + */ + isLocked: function() { return this.locked; }, + + /** + * Location cache that is set for all drag drop objects when a drag is + * initiated, cleared when the drag is finished. + * @property locationCache + * @private + * @static + */ + locationCache: {}, + + /** + * Set useCache to false if you want to force object the lookup of each + * drag and drop linked element constantly during a drag. + * @property useCache + * @type boolean + * @static + */ + useCache: true, + + /** + * The number of pixels that the mouse needs to move after the + * mousedown before the drag is initiated. Default=3; + * @property clickPixelThresh + * @type int + * @static + */ + clickPixelThresh: 3, + + /** + * The number of milliseconds after the mousedown event to initiate the + * drag if we don't get a mouseup event. Default=1000 + * @property clickTimeThresh + * @type int + * @static + */ + clickTimeThresh: 350, + + /** + * Flag that indicates that either the drag pixel threshold or the + * mousdown time threshold has been met + * @property dragThreshMet + * @type boolean + * @private + * @static + */ + dragThreshMet: false, + + /** + * Timeout used for the click time threshold + * @property clickTimeout + * @type Object + * @private + * @static + */ + clickTimeout: null, + + /** + * The X position of the mousedown event stored for later use when a + * drag threshold is met. + * @property startX + * @type int + * @private + * @static + */ + startX: 0, + + /** + * The Y position of the mousedown event stored for later use when a + * drag threshold is met. + * @property startY + * @type int + * @private + * @static + */ + startY: 0, + + /** + * Each DragDrop instance must be registered with the DragDropMgr. + * This is executed in DragDrop.init() + * @method regDragDrop + * @param {DragDrop} oDD the DragDrop object to register + * @param {String} sGroup the name of the group this element belongs to + * @static + */ + regDragDrop: function(oDD, sGroup) { + if (!this.initialized) { this.init(); } + + if (!this.ids[sGroup]) { + this.ids[sGroup] = {}; + } + this.ids[sGroup][oDD.id] = oDD; + }, + + /** + * Removes the supplied dd instance from the supplied group. Executed + * by DragDrop.removeFromGroup, so don't call this function directly. + * @method removeDDFromGroup + * @private + * @static + */ + removeDDFromGroup: function(oDD, sGroup) { + if (!this.ids[sGroup]) { + this.ids[sGroup] = {}; + } + + var obj = this.ids[sGroup]; + if (obj && obj[oDD.id]) { + delete obj[oDD.id]; + } + }, + + /** + * Unregisters a drag and drop item. This is executed in + * DragDrop.unreg, use that method instead of calling this directly. + * @method _remove + * @private + * @static + */ + _remove: function(oDD) { + for (var g in oDD.groups) { + if (g && this.ids[g][oDD.id]) { + delete this.ids[g][oDD.id]; + } + } + delete this.handleIds[oDD.id]; + }, + + /** + * Each DragDrop handle element must be registered. This is done + * automatically when executing DragDrop.setHandleElId() + * @method regHandle + * @param {String} sDDId the DragDrop id this element is a handle for + * @param {String} sHandleId the id of the element that is the drag + * handle + * @static + */ + regHandle: function(sDDId, sHandleId) { + if (!this.handleIds[sDDId]) { + this.handleIds[sDDId] = {}; + } + this.handleIds[sDDId][sHandleId] = sHandleId; + }, + + /** + * Utility function to determine if a given element has been + * registered as a drag drop item. + * @method isDragDrop + * @param {String} id the element id to check + * @return {boolean} true if this element is a DragDrop item, + * false otherwise + * @static + */ + isDragDrop: function(id) { + return ( this.getDDById(id) ) ? true : false; + }, + + /** + * Returns the drag and drop instances that are in all groups the + * passed in instance belongs to. + * @method getRelated + * @param {DragDrop} p_oDD the obj to get related data for + * @param {boolean} bTargetsOnly if true, only return targetable objs + * @return {DragDrop[]} the related instances + * @static + */ + getRelated: function(p_oDD, bTargetsOnly) { + var oDDs = []; + for (var i in p_oDD.groups) { + for (j in this.ids[i]) { + var dd = this.ids[i][j]; + if (! this.isTypeOfDD(dd)) { + continue; + } + if (!bTargetsOnly || dd.isTarget) { + oDDs[oDDs.length] = dd; + } + } + } + + return oDDs; + }, + + /** + * Returns true if the specified dd target is a legal target for + * the specifice drag obj + * @method isLegalTarget + * @param {DragDrop} the drag obj + * @param {DragDrop} the target + * @return {boolean} true if the target is a legal target for the + * dd obj + * @static + */ + isLegalTarget: function (oDD, oTargetDD) { + var targets = this.getRelated(oDD, true); + for (var i=0, len=targets.length;i<len;++i) { + if (targets[i].id == oTargetDD.id) { + return true; + } + } + + return false; + }, + + /** + * My goal is to be able to transparently determine if an object is + * typeof DragDrop, and the exact subclass of DragDrop. typeof + * returns "object", oDD.constructor.toString() always returns + * "DragDrop" and not the name of the subclass. So for now it just + * evaluates a well-known variable in DragDrop. + * @method isTypeOfDD + * @param {Object} the object to evaluate + * @return {boolean} true if typeof oDD = DragDrop + * @static + */ + isTypeOfDD: function (oDD) { + return (oDD && oDD.__ygDragDrop); + }, + + /** + * Utility function to determine if a given element has been + * registered as a drag drop handle for the given Drag Drop object. + * @method isHandle + * @param {String} id the element id to check + * @return {boolean} true if this element is a DragDrop handle, false + * otherwise + * @static + */ + isHandle: function(sDDId, sHandleId) { + return ( this.handleIds[sDDId] && + this.handleIds[sDDId][sHandleId] ); + }, + + /** + * Returns the DragDrop instance for a given id + * @method getDDById + * @param {String} id the id of the DragDrop object + * @return {DragDrop} the drag drop object, null if it is not found + * @static + */ + getDDById: function(id) { + for (var i in this.ids) { + if (this.ids[i][id]) { + return this.ids[i][id]; + } + } + return null; + }, + + /** + * Fired after a registered DragDrop object gets the mousedown event. + * Sets up the events required to track the object being dragged + * @method handleMouseDown + * @param {Event} e the event + * @param oDD the DragDrop object being dragged + * @private + * @static + */ + handleMouseDown: function(e, oDD) { + if(Roo.QuickTips){ + Roo.QuickTips.disable(); + } + this.currentTarget = e.getTarget(); + + this.dragCurrent = oDD; + + var el = oDD.getEl(); + + // track start position + this.startX = e.getPageX(); + this.startY = e.getPageY(); + + this.deltaX = this.startX - el.offsetLeft; + this.deltaY = this.startY - el.offsetTop; + + this.dragThreshMet = false; + + this.clickTimeout = setTimeout( + function() { + var DDM = Roo.dd.DDM; + DDM.startDrag(DDM.startX, DDM.startY); + }, + this.clickTimeThresh ); + }, + + /** + * Fired when either the drag pixel threshol or the mousedown hold + * time threshold has been met. + * @method startDrag + * @param x {int} the X position of the original mousedown + * @param y {int} the Y position of the original mousedown + * @static + */ + startDrag: function(x, y) { + clearTimeout(this.clickTimeout); + if (this.dragCurrent) { + this.dragCurrent.b4StartDrag(x, y); + this.dragCurrent.startDrag(x, y); + } + this.dragThreshMet = true; + }, + + /** + * Internal function to handle the mouseup event. Will be invoked + * from the context of the document. + * @method handleMouseUp + * @param {Event} e the event + * @private + * @static + */ + handleMouseUp: function(e) { + + if(Roo.QuickTips){ + Roo.QuickTips.enable(); + } + if (! this.dragCurrent) { + return; + } + + clearTimeout(this.clickTimeout); + + if (this.dragThreshMet) { + this.fireEvents(e, true); + } else { + } + + this.stopDrag(e); + + this.stopEvent(e); + }, + + /** + * Utility to stop event propagation and event default, if these + * features are turned on. + * @method stopEvent + * @param {Event} e the event as returned by this.getEvent() + * @static + */ + stopEvent: function(e){ + if(this.stopPropagation) { + e.stopPropagation(); + } + + if (this.preventDefault) { + e.preventDefault(); + } + }, + + /** + * Internal function to clean up event handlers after the drag + * operation is complete + * @method stopDrag + * @param {Event} e the event + * @private + * @static + */ + stopDrag: function(e) { + // Fire the drag end event for the item that was dragged + if (this.dragCurrent) { + if (this.dragThreshMet) { + this.dragCurrent.b4EndDrag(e); + this.dragCurrent.endDrag(e); + } + + this.dragCurrent.onMouseUp(e); + } + + this.dragCurrent = null; + this.dragOvers = {}; + }, + + /** + * Internal function to handle the mousemove event. Will be invoked + * from the context of the html element. + * + * @TODO figure out what we can do about mouse events lost when the + * user drags objects beyond the window boundary. Currently we can + * detect this in internet explorer by verifying that the mouse is + * down during the mousemove event. Firefox doesn't give us the + * button state on the mousemove event. + * @method handleMouseMove + * @param {Event} e the event + * @private + * @static + */ + handleMouseMove: function(e) { + if (! this.dragCurrent) { + return true; + } + + // var button = e.which || e.button; + + // check for IE mouseup outside of page boundary + if (Roo.isIE && (e.button !== 0 && e.button !== 1 && e.button !== 2)) { + this.stopEvent(e); + return this.handleMouseUp(e); + } + + if (!this.dragThreshMet) { + var diffX = Math.abs(this.startX - e.getPageX()); + var diffY = Math.abs(this.startY - e.getPageY()); + if (diffX > this.clickPixelThresh || + diffY > this.clickPixelThresh) { + this.startDrag(this.startX, this.startY); + } + } + + if (this.dragThreshMet) { + this.dragCurrent.b4Drag(e); + this.dragCurrent.onDrag(e); + if(!this.dragCurrent.moveOnly){ + this.fireEvents(e, false); + } + } + + this.stopEvent(e); + + return true; + }, + + /** + * Iterates over all of the DragDrop elements to find ones we are + * hovering over or dropping on + * @method fireEvents + * @param {Event} e the event + * @param {boolean} isDrop is this a drop op or a mouseover op? + * @private + * @static + */ + fireEvents: function(e, isDrop) { + var dc = this.dragCurrent; + + // If the user did the mouse up outside of the window, we could + // get here even though we have ended the drag. + if (!dc || dc.isLocked()) { + return; + } + + var pt = e.getPoint(); + + // cache the previous dragOver array + var oldOvers = []; + + var outEvts = []; + var overEvts = []; + var dropEvts = []; + var enterEvts = []; + + // Check to see if the object(s) we were hovering over is no longer + // being hovered over so we can fire the onDragOut event + for (var i in this.dragOvers) { + + var ddo = this.dragOvers[i]; + + if (! this.isTypeOfDD(ddo)) { + continue; + } + + if (! this.isOverTarget(pt, ddo, this.mode)) { + outEvts.push( ddo ); + } + + oldOvers[i] = true; + delete this.dragOvers[i]; + } + + for (var sGroup in dc.groups) { + + if ("string" != typeof sGroup) { + continue; + } + + for (i in this.ids[sGroup]) { + var oDD = this.ids[sGroup][i]; + if (! this.isTypeOfDD(oDD)) { + continue; + } + + if (oDD.isTarget && !oDD.isLocked() && oDD != dc) { + if (this.isOverTarget(pt, oDD, this.mode)) { + // look for drop interactions + if (isDrop) { + dropEvts.push( oDD ); + // look for drag enter and drag over interactions + } else { + + // initial drag over: dragEnter fires + if (!oldOvers[oDD.id]) { + enterEvts.push( oDD ); + // subsequent drag overs: dragOver fires + } else { + overEvts.push( oDD ); + } + + this.dragOvers[oDD.id] = oDD; + } + } + } + } + } + + if (this.mode) { + if (outEvts.length) { + dc.b4DragOut(e, outEvts); + dc.onDragOut(e, outEvts); + } + + if (enterEvts.length) { + dc.onDragEnter(e, enterEvts); + } + + if (overEvts.length) { + dc.b4DragOver(e, overEvts); + dc.onDragOver(e, overEvts); + } + + if (dropEvts.length) { + dc.b4DragDrop(e, dropEvts); + dc.onDragDrop(e, dropEvts); + } + + } else { + // fire dragout events + var len = 0; + for (i=0, len=outEvts.length; i<len; ++i) { + dc.b4DragOut(e, outEvts[i].id); + dc.onDragOut(e, outEvts[i].id); + } + + // fire enter events + for (i=0,len=enterEvts.length; i<len; ++i) { + // dc.b4DragEnter(e, oDD.id); + dc.onDragEnter(e, enterEvts[i].id); + } + + // fire over events + for (i=0,len=overEvts.length; i<len; ++i) { + dc.b4DragOver(e, overEvts[i].id); + dc.onDragOver(e, overEvts[i].id); + } + + // fire drop events + for (i=0, len=dropEvts.length; i<len; ++i) { + dc.b4DragDrop(e, dropEvts[i].id); + dc.onDragDrop(e, dropEvts[i].id); + } + + } + + // notify about a drop that did not find a target + if (isDrop && !dropEvts.length) { + dc.onInvalidDrop(e); + } + + }, + + /** + * Helper function for getting the best match from the list of drag + * and drop objects returned by the drag and drop events when we are + * in INTERSECT mode. It returns either the first object that the + * cursor is over, or the object that has the greatest overlap with + * the dragged element. + * @method getBestMatch + * @param {DragDrop[]} dds The array of drag and drop objects + * targeted + * @return {DragDrop} The best single match + * @static + */ + getBestMatch: function(dds) { + var winner = null; + // Return null if the input is not what we expect + //if (!dds || !dds.length || dds.length == 0) { + // winner = null; + // If there is only one item, it wins + //} else if (dds.length == 1) { + + var len = dds.length; + + if (len == 1) { + winner = dds[0]; + } else { + // Loop through the targeted items + for (var i=0; i<len; ++i) { + var dd = dds[i]; + // If the cursor is over the object, it wins. If the + // cursor is over multiple matches, the first one we come + // to wins. + if (dd.cursorIsOver) { + winner = dd; + break; + // Otherwise the object with the most overlap wins + } else { + if (!winner || + winner.overlap.getArea() < dd.overlap.getArea()) { + winner = dd; + } + } + } + } + + return winner; + }, + + /** + * Refreshes the cache of the top-left and bottom-right points of the + * drag and drop objects in the specified group(s). This is in the + * format that is stored in the drag and drop instance, so typical + * usage is: + * <code> + * Roo.dd.DragDropMgr.refreshCache(ddinstance.groups); + * </code> + * Alternatively: + * <code> + * Roo.dd.DragDropMgr.refreshCache({group1:true, group2:true}); + * </code> + * @TODO this really should be an indexed array. Alternatively this + * method could accept both. + * @method refreshCache + * @param {Object} groups an associative array of groups to refresh + * @static + */ + refreshCache: function(groups) { + for (var sGroup in groups) { + if ("string" != typeof sGroup) { + continue; + } + for (var i in this.ids[sGroup]) { + var oDD = this.ids[sGroup][i]; + + if (this.isTypeOfDD(oDD)) { + // if (this.isTypeOfDD(oDD) && oDD.isTarget) { + var loc = this.getLocation(oDD); + if (loc) { + this.locationCache[oDD.id] = loc; + } else { + delete this.locationCache[oDD.id]; + // this will unregister the drag and drop object if + // the element is not in a usable state + // oDD.unreg(); + } + } + } + } + }, + + /** + * This checks to make sure an element exists and is in the DOM. The + * main purpose is to handle cases where innerHTML is used to remove + * drag and drop objects from the DOM. IE provides an 'unspecified + * error' when trying to access the offsetParent of such an element + * @method verifyEl + * @param {HTMLElement} el the element to check + * @return {boolean} true if the element looks usable + * @static + */ + verifyEl: function(el) { + if (el) { + var parent; + if(Roo.isIE){ + try{ + parent = el.offsetParent; + }catch(e){} + }else{ + parent = el.offsetParent; + } + if (parent) { + return true; + } + } + + return false; + }, + + /** + * Returns a Region object containing the drag and drop element's position + * and size, including the padding configured for it + * @method getLocation + * @param {DragDrop} oDD the drag and drop object to get the + * location for + * @return {Roo.lib.Region} a Region object representing the total area + * the element occupies, including any padding + * the instance is configured for. + * @static + */ + getLocation: function(oDD) { + if (! this.isTypeOfDD(oDD)) { + return null; + } + + var el = oDD.getEl(), pos, x1, x2, y1, y2, t, r, b, l; + + try { + pos= Roo.lib.Dom.getXY(el); + } catch (e) { } + + if (!pos) { + return null; + } + + x1 = pos[0]; + x2 = x1 + el.offsetWidth; + y1 = pos[1]; + y2 = y1 + el.offsetHeight; + + t = y1 - oDD.padding[0]; + r = x2 + oDD.padding[1]; + b = y2 + oDD.padding[2]; + l = x1 - oDD.padding[3]; + + return new Roo.lib.Region( t, r, b, l ); + }, + + /** + * Checks the cursor location to see if it over the target + * @method isOverTarget + * @param {Roo.lib.Point} pt The point to evaluate + * @param {DragDrop} oTarget the DragDrop object we are inspecting + * @return {boolean} true if the mouse is over the target + * @private + * @static + */ + isOverTarget: function(pt, oTarget, intersect) { + // use cache if available + var loc = this.locationCache[oTarget.id]; + if (!loc || !this.useCache) { + loc = this.getLocation(oTarget); + this.locationCache[oTarget.id] = loc; + + } + + if (!loc) { + return false; + } + + oTarget.cursorIsOver = loc.contains( pt ); + + // DragDrop is using this as a sanity check for the initial mousedown + // in this case we are done. In POINT mode, if the drag obj has no + // contraints, we are also done. Otherwise we need to evaluate the + // location of the target as related to the actual location of the + // dragged element. + var dc = this.dragCurrent; + if (!dc || !dc.getTargetCoord || + (!intersect && !dc.constrainX && !dc.constrainY)) { + return oTarget.cursorIsOver; + } + + oTarget.overlap = null; + + // Get the current location of the drag element, this is the + // location of the mouse event less the delta that represents + // where the original mousedown happened on the element. We + // need to consider constraints and ticks as well. + var pos = dc.getTargetCoord(pt.x, pt.y); + + var el = dc.getDragEl(); + var curRegion = new Roo.lib.Region( pos.y, + pos.x + el.offsetWidth, + pos.y + el.offsetHeight, + pos.x ); + + var overlap = curRegion.intersect(loc); + + if (overlap) { + oTarget.overlap = overlap; + return (intersect) ? true : oTarget.cursorIsOver; + } else { + return false; + } + }, + + /** + * unload event handler + * @method _onUnload + * @private + * @static + */ + _onUnload: function(e, me) { + Roo.dd.DragDropMgr.unregAll(); + }, + + /** + * Cleans up the drag and drop events and objects. + * @method unregAll + * @private + * @static + */ + unregAll: function() { + + if (this.dragCurrent) { + this.stopDrag(); + this.dragCurrent = null; + } + + this._execOnAll("unreg", []); + + for (i in this.elementCache) { + delete this.elementCache[i]; + } + + this.elementCache = {}; + this.ids = {}; + }, + + /** + * A cache of DOM elements + * @property elementCache + * @private + * @static + */ + elementCache: {}, + + /** + * Get the wrapper for the DOM element specified + * @method getElWrapper + * @param {String} id the id of the element to get + * @return {Roo.dd.DDM.ElementWrapper} the wrapped element + * @private + * @deprecated This wrapper isn't that useful + * @static + */ + getElWrapper: function(id) { + var oWrapper = this.elementCache[id]; + if (!oWrapper || !oWrapper.el) { + oWrapper = this.elementCache[id] = + new this.ElementWrapper(Roo.getDom(id)); + } + return oWrapper; + }, + + /** + * Returns the actual DOM element + * @method getElement + * @param {String} id the id of the elment to get + * @return {Object} The element + * @deprecated use Roo.getDom instead + * @static + */ + getElement: function(id) { + return Roo.getDom(id); + }, + + /** + * Returns the style property for the DOM element (i.e., + * document.getElById(id).style) + * @method getCss + * @param {String} id the id of the elment to get + * @return {Object} The style property of the element + * @deprecated use Roo.getDom instead + * @static + */ + getCss: function(id) { + var el = Roo.getDom(id); + return (el) ? el.style : null; + }, + + /** + * Inner class for cached elements + * @class DragDropMgr.ElementWrapper + * @for DragDropMgr + * @private + * @deprecated + */ + ElementWrapper: function(el) { + /** + * The element + * @property el + */ + this.el = el || null; + /** + * The element id + * @property id + */ + this.id = this.el && el.id; + /** + * A reference to the style property + * @property css + */ + this.css = this.el && el.style; + }, + + /** + * Returns the X position of an html element + * @method getPosX + * @param el the element for which to get the position + * @return {int} the X coordinate + * @for DragDropMgr + * @deprecated use Roo.lib.Dom.getX instead + * @static + */ + getPosX: function(el) { + return Roo.lib.Dom.getX(el); + }, + + /** + * Returns the Y position of an html element + * @method getPosY + * @param el the element for which to get the position + * @return {int} the Y coordinate + * @deprecated use Roo.lib.Dom.getY instead + * @static + */ + getPosY: function(el) { + return Roo.lib.Dom.getY(el); + }, + + /** + * Swap two nodes. In IE, we use the native method, for others we + * emulate the IE behavior + * @method swapNode + * @param n1 the first node to swap + * @param n2 the other node to swap + * @static + */ + swapNode: function(n1, n2) { + if (n1.swapNode) { + n1.swapNode(n2); + } else { + var p = n2.parentNode; + var s = n2.nextSibling; + + if (s == n1) { + p.insertBefore(n1, n2); + } else if (n2 == n1.nextSibling) { + p.insertBefore(n2, n1); + } else { + n1.parentNode.replaceChild(n2, n1); + p.insertBefore(n1, s); + } + } + }, + + /** + * Returns the current scroll position + * @method getScroll + * @private + * @static + */ + getScroll: function () { + var t, l, dde=document.documentElement, db=document.body; + if (dde && (dde.scrollTop || dde.scrollLeft)) { + t = dde.scrollTop; + l = dde.scrollLeft; + } else if (db) { + t = db.scrollTop; + l = db.scrollLeft; + } else { + + } + return { top: t, left: l }; + }, + + /** + * Returns the specified element style property + * @method getStyle + * @param {HTMLElement} el the element + * @param {string} styleProp the style property + * @return {string} The value of the style property + * @deprecated use Roo.lib.Dom.getStyle + * @static + */ + getStyle: function(el, styleProp) { + return Roo.fly(el).getStyle(styleProp); + }, + + /** + * Gets the scrollTop + * @method getScrollTop + * @return {int} the document's scrollTop + * @static + */ + getScrollTop: function () { return this.getScroll().top; }, + + /** + * Gets the scrollLeft + * @method getScrollLeft + * @return {int} the document's scrollTop + * @static + */ + getScrollLeft: function () { return this.getScroll().left; }, + + /** + * Sets the x/y position of an element to the location of the + * target element. + * @method moveToEl + * @param {HTMLElement} moveEl The element to move + * @param {HTMLElement} targetEl The position reference element + * @static + */ + moveToEl: function (moveEl, targetEl) { + var aCoord = Roo.lib.Dom.getXY(targetEl); + Roo.lib.Dom.setXY(moveEl, aCoord); + }, + + /** + * Numeric array sort function + * @method numericSort + * @static + */ + numericSort: function(a, b) { return (a - b); }, + + /** + * Internal counter + * @property _timeoutCount + * @private + * @static + */ + _timeoutCount: 0, + + /** + * Trying to make the load order less important. Without this we get + * an error if this file is loaded before the Event Utility. + * @method _addListeners + * @private + * @static + */ + _addListeners: function() { + var DDM = Roo.dd.DDM; + if ( Roo.lib.Event && document ) { + DDM._onLoad(); + } else { + if (DDM._timeoutCount > 2000) { + } else { + setTimeout(DDM._addListeners, 10); + if (document && document.body) { + DDM._timeoutCount += 1; + } + } + } + }, + + /** + * Recursively searches the immediate parent and all child nodes for + * the handle element in order to determine wheter or not it was + * clicked. + * @method handleWasClicked + * @param node the html element to inspect + * @static + */ + handleWasClicked: function(node, id) { + if (this.isHandle(id, node.id)) { + return true; + } else { + // check to see if this is a text node child of the one we want + var p = node.parentNode; + + while (p) { + if (this.isHandle(id, p.id)) { + return true; + } else { + p = p.parentNode; + } + } + } + + return false; + } + + }; + +}(); + +// shorter alias, save a few bytes +Roo.dd.DDM = Roo.dd.DragDropMgr; +Roo.dd.DDM._addListeners(); + +} \ No newline at end of file diff --git a/docs2/src/Roo_dd_DragSource.js.html b/docs2/src/Roo_dd_DragSource.js.html new file mode 100644 index 0000000000..3f63c13688 --- /dev/null +++ b/docs2/src/Roo_dd_DragSource.js.html @@ -0,0 +1,364 @@ +/home/alan/gitlive/roojs1/Roo/dd/DragSource.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.dd.DragSource + * @extends Roo.dd.DDProxy + * A simple class that provides the basic implementation needed to make any element draggable. + * @constructor + * @param {String/HTMLElement/Element} el The container element + * @param {Object} config + */ +Roo.dd.DragSource = function(el, config){ + this.el = Roo.get(el); + this.dragData = {}; + + Roo.apply(this, config); + + if(!this.proxy){ + this.proxy = new Roo.dd.StatusProxy(); + } + + Roo.dd.DragSource.superclass.constructor.call(this, this.el.dom, this.ddGroup || this.group, + {dragElId : this.proxy.id, resizeFrame: false, isTarget: false, scroll: this.scroll === true}); + + this.dragging = false; +}; + +Roo.extend(Roo.dd.DragSource, Roo.dd.DDProxy, { + /** + * @cfg {String} dropAllowed + * The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok"). + */ + dropAllowed : "x-dd-drop-ok", + /** + * @cfg {String} dropNotAllowed + * The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop"). + */ + dropNotAllowed : "x-dd-drop-nodrop", + + /** + * Returns the data object associated with this drag source + * @return {Object} data An object containing arbitrary data + */ + getDragData : function(e){ + return this.dragData; + }, + + // private + onDragEnter : function(e, id){ + var target = Roo.dd.DragDropMgr.getDDById(id); + this.cachedTarget = target; + if(this.beforeDragEnter(target, e, id) !== false){ + if(target.isNotifyTarget){ + var status = target.notifyEnter(this, e, this.dragData); + this.proxy.setStatus(status); + }else{ + this.proxy.setStatus(this.dropAllowed); + } + + if(this.afterDragEnter){ + /** + * An empty function by default, but provided so that you can perform a custom action + * when the dragged item enters the drop target by providing an implementation. + * @param {Roo.dd.DragDrop} target The drop target + * @param {Event} e The event object + * @param {String} id The id of the dragged element + * @method afterDragEnter + */ + this.afterDragEnter(target, e, id); + } + } + }, + + /** + * An empty function by default, but provided so that you can perform a custom action + * before the dragged item enters the drop target and optionally cancel the onDragEnter. + * @param {Roo.dd.DragDrop} target The drop target + * @param {Event} e The event object + * @param {String} id The id of the dragged element + * @return {Boolean} isValid True if the drag event is valid, else false to cancel + */ + beforeDragEnter : function(target, e, id){ + return true; + }, + + // private + alignElWithMouse: function() { + Roo.dd.DragSource.superclass.alignElWithMouse.apply(this, arguments); + this.proxy.sync(); + }, + + // private + onDragOver : function(e, id){ + var target = this.cachedTarget || Roo.dd.DragDropMgr.getDDById(id); + if(this.beforeDragOver(target, e, id) !== false){ + if(target.isNotifyTarget){ + var status = target.notifyOver(this, e, this.dragData); + this.proxy.setStatus(status); + } + + if(this.afterDragOver){ + /** + * An empty function by default, but provided so that you can perform a custom action + * while the dragged item is over the drop target by providing an implementation. + * @param {Roo.dd.DragDrop} target The drop target + * @param {Event} e The event object + * @param {String} id The id of the dragged element + * @method afterDragOver + */ + this.afterDragOver(target, e, id); + } + } + }, + + /** + * An empty function by default, but provided so that you can perform a custom action + * while the dragged item is over the drop target and optionally cancel the onDragOver. + * @param {Roo.dd.DragDrop} target The drop target + * @param {Event} e The event object + * @param {String} id The id of the dragged element + * @return {Boolean} isValid True if the drag event is valid, else false to cancel + */ + beforeDragOver : function(target, e, id){ + return true; + }, + + // private + onDragOut : function(e, id){ + var target = this.cachedTarget || Roo.dd.DragDropMgr.getDDById(id); + if(this.beforeDragOut(target, e, id) !== false){ + if(target.isNotifyTarget){ + target.notifyOut(this, e, this.dragData); + } + this.proxy.reset(); + if(this.afterDragOut){ + /** + * An empty function by default, but provided so that you can perform a custom action + * after the dragged item is dragged out of the target without dropping. + * @param {Roo.dd.DragDrop} target The drop target + * @param {Event} e The event object + * @param {String} id The id of the dragged element + * @method afterDragOut + */ + this.afterDragOut(target, e, id); + } + } + this.cachedTarget = null; + }, + + /** + * An empty function by default, but provided so that you can perform a custom action before the dragged + * item is dragged out of the target without dropping, and optionally cancel the onDragOut. + * @param {Roo.dd.DragDrop} target The drop target + * @param {Event} e The event object + * @param {String} id The id of the dragged element + * @return {Boolean} isValid True if the drag event is valid, else false to cancel + */ + beforeDragOut : function(target, e, id){ + return true; + }, + + // private + onDragDrop : function(e, id){ + var target = this.cachedTarget || Roo.dd.DragDropMgr.getDDById(id); + if(this.beforeDragDrop(target, e, id) !== false){ + if(target.isNotifyTarget){ + if(target.notifyDrop(this, e, this.dragData)){ // valid drop? + this.onValidDrop(target, e, id); + }else{ + this.onInvalidDrop(target, e, id); + } + }else{ + this.onValidDrop(target, e, id); + } + + if(this.afterDragDrop){ + /** + * An empty function by default, but provided so that you can perform a custom action + * after a valid drag drop has occurred by providing an implementation. + * @param {Roo.dd.DragDrop} target The drop target + * @param {Event} e The event object + * @param {String} id The id of the dropped element + * @method afterDragDrop + */ + this.afterDragDrop(target, e, id); + } + } + delete this.cachedTarget; + }, + + /** + * An empty function by default, but provided so that you can perform a custom action before the dragged + * item is dropped onto the target and optionally cancel the onDragDrop. + * @param {Roo.dd.DragDrop} target The drop target + * @param {Event} e The event object + * @param {String} id The id of the dragged element + * @return {Boolean} isValid True if the drag drop event is valid, else false to cancel + */ + beforeDragDrop : function(target, e, id){ + return true; + }, + + // private + onValidDrop : function(target, e, id){ + this.hideProxy(); + if(this.afterValidDrop){ + /** + * An empty function by default, but provided so that you can perform a custom action + * after a valid drop has occurred by providing an implementation. + * @param {Object} target The target DD + * @param {Event} e The event object + * @param {String} id The id of the dropped element + * @method afterInvalidDrop + */ + this.afterValidDrop(target, e, id); + } + }, + + // private + getRepairXY : function(e, data){ + return this.el.getXY(); + }, + + // private + onInvalidDrop : function(target, e, id){ + this.beforeInvalidDrop(target, e, id); + if(this.cachedTarget){ + if(this.cachedTarget.isNotifyTarget){ + this.cachedTarget.notifyOut(this, e, this.dragData); + } + this.cacheTarget = null; + } + this.proxy.repair(this.getRepairXY(e, this.dragData), this.afterRepair, this); + + if(this.afterInvalidDrop){ + /** + * An empty function by default, but provided so that you can perform a custom action + * after an invalid drop has occurred by providing an implementation. + * @param {Event} e The event object + * @param {String} id The id of the dropped element + * @method afterInvalidDrop + */ + this.afterInvalidDrop(e, id); + } + }, + + // private + afterRepair : function(){ + if(Roo.enableFx){ + this.el.highlight(this.hlColor || "c3daf9"); + } + this.dragging = false; + }, + + /** + * An empty function by default, but provided so that you can perform a custom action after an invalid + * drop has occurred. + * @param {Roo.dd.DragDrop} target The drop target + * @param {Event} e The event object + * @param {String} id The id of the dragged element + * @return {Boolean} isValid True if the invalid drop should proceed, else false to cancel + */ + beforeInvalidDrop : function(target, e, id){ + return true; + }, + + // private + handleMouseDown : function(e){ + if(this.dragging) { + return; + } + var data = this.getDragData(e); + if(data && this.onBeforeDrag(data, e) !== false){ + this.dragData = data; + this.proxy.stop(); + Roo.dd.DragSource.superclass.handleMouseDown.apply(this, arguments); + } + }, + + /** + * An empty function by default, but provided so that you can perform a custom action before the initial + * drag event begins and optionally cancel it. + * @param {Object} data An object containing arbitrary data to be shared with drop targets + * @param {Event} e The event object + * @return {Boolean} isValid True if the drag event is valid, else false to cancel + */ + onBeforeDrag : function(data, e){ + return true; + }, + + /** + * An empty function by default, but provided so that you can perform a custom action once the initial + * drag event has begun. The drag cannot be canceled from this function. + * @param {Number} x The x position of the click on the dragged object + * @param {Number} y The y position of the click on the dragged object + */ + onStartDrag : Roo.emptyFn, + + // private - YUI override + startDrag : function(x, y){ + this.proxy.reset(); + this.dragging = true; + this.proxy.update(""); + this.onInitDrag(x, y); + this.proxy.show(); + }, + + // private + onInitDrag : function(x, y){ + var clone = this.el.dom.cloneNode(true); + clone.id = Roo.id(); // prevent duplicate ids + this.proxy.update(clone); + this.onStartDrag(x, y); + return true; + }, + + /** + * Returns the drag source's underlying {@link Roo.dd.StatusProxy} + * @return {Roo.dd.StatusProxy} proxy The StatusProxy + */ + getProxy : function(){ + return this.proxy; + }, + + /** + * Hides the drag source's {@link Roo.dd.StatusProxy} + */ + hideProxy : function(){ + this.proxy.hide(); + this.proxy.reset(true); + this.dragging = false; + }, + + // private + triggerCacheRefresh : function(){ + Roo.dd.DDM.refreshCache(this.groups); + }, + + // private - override to prevent hiding + b4EndDrag: function(e) { + }, + + // private - override to prevent moving + endDrag : function(e){ + this.onEndDrag(this.dragData, e); + }, + + // private + onEndDrag : function(data, e){ + }, + + // private - pin to cursor + autoOffset : function(x, y) { + this.setDelta(-12, -20); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_dd_DragZone.js.html b/docs2/src/Roo_dd_DragZone.js.html new file mode 100644 index 0000000000..9302aea38d --- /dev/null +++ b/docs2/src/Roo_dd_DragZone.js.html @@ -0,0 +1,83 @@ +/home/alan/gitlive/roojs1/Roo/dd/DragZone.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.dd.DragZone + * @extends Roo.dd.DragSource + * This class provides a container DD instance that proxies for multiple child node sources.<br /> + * By default, this class requires that draggable child nodes are registered with {@link Roo.dd.Registry}. + * @constructor + * @param {String/HTMLElement/Element} el The container element + * @param {Object} config + */ +Roo.dd.DragZone = function(el, config){ + Roo.dd.DragZone.superclass.constructor.call(this, el, config); + if(this.containerScroll){ + Roo.dd.ScrollManager.register(this.el); + } +}; + +Roo.extend(Roo.dd.DragZone, Roo.dd.DragSource, { + /** + * @cfg {Boolean} containerScroll True to register this container with the Scrollmanager + * for auto scrolling during drag operations. + */ + /** + * @cfg {String} hlColor The color to use when visually highlighting the drag source in the afterRepair + * method after a failed drop (defaults to "c3daf9" - light blue) + */ + + /** + * Called when a mousedown occurs in this container. Looks in {@link Roo.dd.Registry} + * for a valid target to drag based on the mouse down. Override this method + * to provide your own lookup logic (e.g. finding a child by class name). Make sure your returned + * object has a "ddel" attribute (with an HTML Element) for other functions to work. + * @param {EventObject} e The mouse down event + * @return {Object} The dragData + */ + getDragData : function(e){ + return Roo.dd.Registry.getHandleFromEvent(e); + }, + + /** + * Called once drag threshold has been reached to initialize the proxy element. By default, it clones the + * this.dragData.ddel + * @param {Number} x The x position of the click on the dragged object + * @param {Number} y The y position of the click on the dragged object + * @return {Boolean} true to continue the drag, false to cancel + */ + onInitDrag : function(x, y){ + this.proxy.update(this.dragData.ddel.cloneNode(true)); + this.onStartDrag(x, y); + return true; + }, + + /** + * Called after a repair of an invalid drop. By default, highlights this.dragData.ddel + */ + afterRepair : function(){ + if(Roo.enableFx){ + Roo.Element.fly(this.dragData.ddel).highlight(this.hlColor || "c3daf9"); + } + this.dragging = false; + }, + + /** + * Called before a repair of an invalid drop to get the XY to animate to. By default returns + * the XY of this.dragData.ddel + * @param {EventObject} e The mouse up event + * @return {Array} The xy location (e.g. [100, 200]) + */ + getRepairXY : function(e){ + return Roo.Element.fly(this.dragData.ddel).getXY(); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_dd_DropTarget.js.html b/docs2/src/Roo_dd_DropTarget.js.html new file mode 100644 index 0000000000..df785b9258 --- /dev/null +++ b/docs2/src/Roo_dd_DropTarget.js.html @@ -0,0 +1,193 @@ +/home/alan/gitlive/roojs1/Roo/dd/DropTarget.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.dd.DropTarget + * @extends Roo.dd.DDTarget + * A simple class that provides the basic implementation needed to make any element a drop target that can have + * draggable items dropped onto it. The drop has no effect until an implementation of notifyDrop is provided. + * @constructor + * @param {String/HTMLElement/Element} el The container element + * @param {Object} config + */ +Roo.dd.DropTarget = function(el, config){ + this.el = Roo.get(el); + + var listeners = false; ; + if (config && config.listeners) { + listeners= config.listeners; + delete config.listeners; + } + Roo.apply(this, config); + + if(this.containerScroll){ + Roo.dd.ScrollManager.register(this.el); + } + this.addEvents( { + /** + * @scope Roo.dd.DropTarget + */ + + /** + * @event enter + * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the + * target. This default implementation adds the CSS class specified by overClass (if any) to the drop element + * and returns the dropAllowed config value. This method should be overridden if drop validation is required. + * + * IMPORTANT : it should set this.overClass and this.dropAllowed + * + * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target + * @param {Event} e The event + * @param {Object} data An object containing arbitrary data supplied by the drag source + */ + "enter" : true, + + /** + * @event over + * The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target. + * This method will be called on every mouse movement while the drag source is over the drop target. + * This default implementation simply returns the dropAllowed config value. + * + * IMPORTANT : it should set this.dropAllowed + * + * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target + * @param {Event} e The event + * @param {Object} data An object containing arbitrary data supplied by the drag source + + */ + "over" : true, + /** + * @event out + * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged + * out of the target without dropping. This default implementation simply removes the CSS class specified by + * overClass (if any) from the drop element. + * + * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target + * @param {Event} e The event + * @param {Object} data An object containing arbitrary data supplied by the drag source + */ + "out" : true, + + /** + * @event drop + * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has + * been dropped on it. This method has no default implementation and returns false, so you must provide an + * implementation that does something to process the drop event and returns true so that the drag source's + * repair action does not run. + * + * IMPORTANT : it should set this.success + * + * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target + * @param {Event} e The event + * @param {Object} data An object containing arbitrary data supplied by the drag source + */ + "drop" : true + }); + + + Roo.dd.DropTarget.superclass.constructor.call( this, + this.el.dom, + this.ddGroup || this.group, + { + isTarget: true, + listeners : listeners || {} + + + } + ); + +}; + +Roo.extend(Roo.dd.DropTarget, Roo.dd.DDTarget, { + /** + * @cfg {String} overClass + * The CSS class applied to the drop target element while the drag source is over it (defaults to ""). + */ + /** + * @cfg {String} ddGroup + * The drag drop group to handle drop events for + */ + + /** + * @cfg {String} dropAllowed + * The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok"). + */ + dropAllowed : "x-dd-drop-ok", + /** + * @cfg {String} dropNotAllowed + * The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop"). + */ + dropNotAllowed : "x-dd-drop-nodrop", + /** + * @cfg {boolean} success + * set this after drop listener.. + */ + success : false, + /** + * @cfg {boolean|String} valid true/false or string (ok-add/ok-sub/ok/nodrop) + * if the drop point is valid for over/enter.. + */ + valid : false, + // private + isTarget : true, + + // private + isNotifyTarget : true, + + /** + * @hide + */ + notifyEnter : function(dd, e, data) + { + this.valid = true; + this.fireEvent('enter', dd, e, data); + if(this.overClass){ + this.el.addClass(this.overClass); + } + return typeof(this.valid) == 'string' ? 'x-dd-drop-' + this.valid : ( + this.valid ? this.dropAllowed : this.dropNotAllowed + ); + }, + + /** + * @hide + */ + notifyOver : function(dd, e, data) + { + this.valid = true; + this.fireEvent('over', dd, e, data); + return typeof(this.valid) == 'string' ? 'x-dd-drop-' + this.valid : ( + this.valid ? this.dropAllowed : this.dropNotAllowed + ); + }, + + /** + * @hide + */ + notifyOut : function(dd, e, data) + { + this.fireEvent('out', dd, e, data); + if(this.overClass){ + this.el.removeClass(this.overClass); + } + }, + + /** + * @hide + */ + notifyDrop : function(dd, e, data) + { + this.success = false; + this.fireEvent('drop', dd, e, data); + return this.success; + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_dd_DropZone.js.html b/docs2/src/Roo_dd_DropZone.js.html new file mode 100644 index 0000000000..4ead06eda4 --- /dev/null +++ b/docs2/src/Roo_dd_DropZone.js.html @@ -0,0 +1,210 @@ +/home/alan/gitlive/roojs1/Roo/dd/DropZone.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.dd.DropZone + * @extends Roo.dd.DropTarget + * This class provides a container DD instance that proxies for multiple child node targets.<br /> + * By default, this class requires that child nodes accepting drop are registered with {@link Roo.dd.Registry}. + * @constructor + * @param {String/HTMLElement/Element} el The container element + * @param {Object} config + */ +Roo.dd.DropZone = function(el, config){ + Roo.dd.DropZone.superclass.constructor.call(this, el, config); +}; + +Roo.extend(Roo.dd.DropZone, Roo.dd.DropTarget, { + /** + * Returns a custom data object associated with the DOM node that is the target of the event. By default + * this looks up the event target in the {@link Roo.dd.Registry}, although you can override this method to + * provide your own custom lookup. + * @param {Event} e The event + * @return {Object} data The custom data + */ + getTargetFromEvent : function(e){ + return Roo.dd.Registry.getTargetFromEvent(e); + }, + + /** + * Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has entered a drop node + * that it has registered. This method has no default implementation and should be overridden to provide + * node-specific processing if necessary. + * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from + * {@link #getTargetFromEvent} for this node) + * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone + * @param {Event} e The event + * @param {Object} data An object containing arbitrary data supplied by the drag source + */ + onNodeEnter : function(n, dd, e, data){ + + }, + + /** + * Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is over a drop node + * that it has registered. The default implementation returns this.dropNotAllowed, so it should be + * overridden to provide the proper feedback. + * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from + * {@link #getTargetFromEvent} for this node) + * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone + * @param {Event} e The event + * @param {Object} data An object containing arbitrary data supplied by the drag source + * @return {String} status The CSS class that communicates the drop status back to the source so that the + * underlying {@link Roo.dd.StatusProxy} can be updated + */ + onNodeOver : function(n, dd, e, data){ + return this.dropAllowed; + }, + + /** + * Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dragged out of + * the drop node without dropping. This method has no default implementation and should be overridden to provide + * node-specific processing if necessary. + * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from + * {@link #getTargetFromEvent} for this node) + * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone + * @param {Event} e The event + * @param {Object} data An object containing arbitrary data supplied by the drag source + */ + onNodeOut : function(n, dd, e, data){ + + }, + + /** + * Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped onto + * the drop node. The default implementation returns false, so it should be overridden to provide the + * appropriate processing of the drop event and return true so that the drag source's repair action does not run. + * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from + * {@link #getTargetFromEvent} for this node) + * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone + * @param {Event} e The event + * @param {Object} data An object containing arbitrary data supplied by the drag source + * @return {Boolean} True if the drop was valid, else false + */ + onNodeDrop : function(n, dd, e, data){ + return false; + }, + + /** + * Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is being dragged over it, + * but not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so + * it should be overridden to provide the proper feedback if necessary. + * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone + * @param {Event} e The event + * @param {Object} data An object containing arbitrary data supplied by the drag source + * @return {String} status The CSS class that communicates the drop status back to the source so that the + * underlying {@link Roo.dd.StatusProxy} can be updated + */ + onContainerOver : function(dd, e, data){ + return this.dropNotAllowed; + }, + + /** + * Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped on it, + * but not on any of its registered drop nodes. The default implementation returns false, so it should be + * overridden to provide the appropriate processing of the drop event if you need the drop zone itself to + * be able to accept drops. It should return true when valid so that the drag source's repair action does not run. + * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone + * @param {Event} e The event + * @param {Object} data An object containing arbitrary data supplied by the drag source + * @return {Boolean} True if the drop was valid, else false + */ + onContainerDrop : function(dd, e, data){ + return false; + }, + + /** + * The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source is now over + * the zone. The default implementation returns this.dropNotAllowed and expects that only registered drop + * nodes can process drag drop operations, so if you need the drop zone itself to be able to process drops + * you should override this method and provide a custom implementation. + * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone + * @param {Event} e The event + * @param {Object} data An object containing arbitrary data supplied by the drag source + * @return {String} status The CSS class that communicates the drop status back to the source so that the + * underlying {@link Roo.dd.StatusProxy} can be updated + */ + notifyEnter : function(dd, e, data){ + return this.dropNotAllowed; + }, + + /** + * The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the drop zone. + * This method will be called on every mouse movement while the drag source is over the drop zone. + * It will call {@link #onNodeOver} while the drag source is over a registered node, and will also automatically + * delegate to the appropriate node-specific methods as necessary when the drag source enters and exits + * registered nodes ({@link #onNodeEnter}, {@link #onNodeOut}). If the drag source is not currently over a + * registered node, it will call {@link #onContainerOver}. + * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone + * @param {Event} e The event + * @param {Object} data An object containing arbitrary data supplied by the drag source + * @return {String} status The CSS class that communicates the drop status back to the source so that the + * underlying {@link Roo.dd.StatusProxy} can be updated + */ + notifyOver : function(dd, e, data){ + var n = this.getTargetFromEvent(e); + if(!n){ // not over valid drop target + if(this.lastOverNode){ + this.onNodeOut(this.lastOverNode, dd, e, data); + this.lastOverNode = null; + } + return this.onContainerOver(dd, e, data); + } + if(this.lastOverNode != n){ + if(this.lastOverNode){ + this.onNodeOut(this.lastOverNode, dd, e, data); + } + this.onNodeEnter(n, dd, e, data); + this.lastOverNode = n; + } + return this.onNodeOver(n, dd, e, data); + }, + + /** + * The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source has been dragged + * out of the zone without dropping. If the drag source is currently over a registered node, the notification + * will be delegated to {@link #onNodeOut} for node-specific handling, otherwise it will be ignored. + * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target + * @param {Event} e The event + * @param {Object} data An object containing arbitrary data supplied by the drag zone + */ + notifyOut : function(dd, e, data){ + if(this.lastOverNode){ + this.onNodeOut(this.lastOverNode, dd, e, data); + this.lastOverNode = null; + } + }, + + /** + * The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the dragged item has + * been dropped on it. The drag zone will look up the target node based on the event passed in, and if there + * is a node registered for that event, it will delegate to {@link #onNodeDrop} for node-specific handling, + * otherwise it will call {@link #onContainerDrop}. + * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone + * @param {Event} e The event + * @param {Object} data An object containing arbitrary data supplied by the drag source + * @return {Boolean} True if the drop was valid, else false + */ + notifyDrop : function(dd, e, data){ + if(this.lastOverNode){ + this.onNodeOut(this.lastOverNode, dd, e, data); + this.lastOverNode = null; + } + var n = this.getTargetFromEvent(e); + return n ? + this.onNodeDrop(n, dd, e, data) : + this.onContainerDrop(dd, e, data); + }, + + // private + triggerCacheRefresh : function(){ + Roo.dd.DDM.refreshCache(this.groups); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_dd_Registry.js.html b/docs2/src/Roo_dd_Registry.js.html new file mode 100644 index 0000000000..f9a6221398 --- /dev/null +++ b/docs2/src/Roo_dd_Registry.js.html @@ -0,0 +1,133 @@ +/home/alan/gitlive/roojs1/Roo/dd/Registry.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.dd.Registry + * Provides easy access to all drag drop components that are registered on a page. Items can be retrieved either + * directly by DOM node id, or by passing in the drag drop event that occurred and looking up the event target. + * @singleton + */ +Roo.dd.Registry = function(){ + var elements = {}; + var handles = {}; + var autoIdSeed = 0; + + var getId = function(el, autogen){ + if(typeof el == "string"){ + return el; + } + var id = el.id; + if(!id && autogen !== false){ + id = "roodd-" + (++autoIdSeed); + el.id = id; + } + return id; + }; + + return { + /** + * Register a drag drop element + * @param {String|HTMLElement} element The id or DOM node to register + * @param {Object} data (optional) A custom data object that will be passed between the elements that are involved + * in drag drop operations. You can populate this object with any arbitrary properties that your own code + * knows how to interpret, plus there are some specific properties known to the Registry that should be + * populated in the data object (if applicable): + * <pre> +Value Description<br /> +--------- ------------------------------------------<br /> +handles Array of DOM nodes that trigger dragging<br /> + for the element being registered<br /> +isHandle True if the element passed in triggers<br /> + dragging itself, else false +</pre> + */ + register : function(el, data){ + data = data || {}; + if(typeof el == "string"){ + el = document.getElementById(el); + } + data.ddel = el; + elements[getId(el)] = data; + if(data.isHandle !== false){ + handles[data.ddel.id] = data; + } + if(data.handles){ + var hs = data.handles; + for(var i = 0, len = hs.length; i < len; i++){ + handles[getId(hs[i])] = data; + } + } + }, + + /** + * Unregister a drag drop element + * @param {String|HTMLElement} element The id or DOM node to unregister + */ + unregister : function(el){ + var id = getId(el, false); + var data = elements[id]; + if(data){ + delete elements[id]; + if(data.handles){ + var hs = data.handles; + for(var i = 0, len = hs.length; i < len; i++){ + delete handles[getId(hs[i], false)]; + } + } + } + }, + + /** + * Returns the handle registered for a DOM Node by id + * @param {String|HTMLElement} id The DOM node or id to look up + * @return {Object} handle The custom handle data + */ + getHandle : function(id){ + if(typeof id != "string"){ // must be element? + id = id.id; + } + return handles[id]; + }, + + /** + * Returns the handle that is registered for the DOM node that is the target of the event + * @param {Event} e The event + * @return {Object} handle The custom handle data + */ + getHandleFromEvent : function(e){ + var t = Roo.lib.Event.getTarget(e); + return t ? handles[t.id] : null; + }, + + /** + * Returns a custom data object that is registered for a DOM node by id + * @param {String|HTMLElement} id The DOM node or id to look up + * @return {Object} data The custom data + */ + getTarget : function(id){ + if(typeof id != "string"){ // must be element? + id = id.id; + } + return elements[id]; + }, + + /** + * Returns a custom data object that is registered for the DOM node that is the target of the event + * @param {Event} e The event + * @return {Object} data The custom data + */ + getTargetFromEvent : function(e){ + var t = Roo.lib.Event.getTarget(e); + return t ? elements[t.id] || handles[t.id] : null; + } + }; +}(); \ No newline at end of file diff --git a/docs2/src/Roo_dd_ScrollManager.js.html b/docs2/src/Roo_dd_ScrollManager.js.html new file mode 100644 index 0000000000..b6e064475d --- /dev/null +++ b/docs2/src/Roo_dd_ScrollManager.js.html @@ -0,0 +1,187 @@ +/home/alan/gitlive/roojs1/Roo/dd/ScrollManager.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.dd.ScrollManager + * Provides automatic scrolling of overflow regions in the page during drag operations.<br><br> + * <b>Note: This class uses "Point Mode" and is untested in "Intersect Mode".</b> + * @singleton + */ +Roo.dd.ScrollManager = function(){ + var ddm = Roo.dd.DragDropMgr; + var els = {}; + var dragEl = null; + var proc = {}; + + + + var onStop = function(e){ + dragEl = null; + clearProc(); + }; + + var triggerRefresh = function(){ + if(ddm.dragCurrent){ + ddm.refreshCache(ddm.dragCurrent.groups); + } + }; + + var doScroll = function(){ + if(ddm.dragCurrent){ + var dds = Roo.dd.ScrollManager; + if(!dds.animate){ + if(proc.el.scroll(proc.dir, dds.increment)){ + triggerRefresh(); + } + }else{ + proc.el.scroll(proc.dir, dds.increment, true, dds.animDuration, triggerRefresh); + } + } + }; + + var clearProc = function(){ + if(proc.id){ + clearInterval(proc.id); + } + proc.id = 0; + proc.el = null; + proc.dir = ""; + }; + + var startProc = function(el, dir){ + Roo.log('scroll startproc'); + clearProc(); + proc.el = el; + proc.dir = dir; + proc.id = setInterval(doScroll, Roo.dd.ScrollManager.frequency); + }; + + var onFire = function(e, isDrop){ + + if(isDrop || !ddm.dragCurrent){ return; } + var dds = Roo.dd.ScrollManager; + if(!dragEl || dragEl != ddm.dragCurrent){ + dragEl = ddm.dragCurrent; + // refresh regions on drag start + dds.refreshCache(); + } + + var xy = Roo.lib.Event.getXY(e); + var pt = new Roo.lib.Point(xy[0], xy[1]); + for(var id in els){ + var el = els[id], r = el._region; + if(r && r.contains(pt) && el.isScrollable()){ + if(r.bottom - pt.y <= dds.thresh){ + if(proc.el != el){ + startProc(el, "down"); + } + return; + }else if(r.right - pt.x <= dds.thresh){ + if(proc.el != el){ + startProc(el, "left"); + } + return; + }else if(pt.y - r.top <= dds.thresh){ + if(proc.el != el){ + startProc(el, "up"); + } + return; + }else if(pt.x - r.left <= dds.thresh){ + if(proc.el != el){ + startProc(el, "right"); + } + return; + } + } + } + clearProc(); + }; + + ddm.fireEvents = ddm.fireEvents.createSequence(onFire, ddm); + ddm.stopDrag = ddm.stopDrag.createSequence(onStop, ddm); + + return { + /** + * Registers new overflow element(s) to auto scroll + * @param {String/HTMLElement/Element/Array} el The id of or the element to be scrolled or an array of either + */ + register : function(el){ + if(el instanceof Array){ + for(var i = 0, len = el.length; i < len; i++) { + this.register(el[i]); + } + }else{ + el = Roo.get(el); + els[el.id] = el; + } + Roo.dd.ScrollManager.els = els; + }, + + /** + * Unregisters overflow element(s) so they are no longer scrolled + * @param {String/HTMLElement/Element/Array} el The id of or the element to be removed or an array of either + */ + unregister : function(el){ + if(el instanceof Array){ + for(var i = 0, len = el.length; i < len; i++) { + this.unregister(el[i]); + } + }else{ + el = Roo.get(el); + delete els[el.id]; + } + }, + + /** + * The number of pixels from the edge of a container the pointer needs to be to + * trigger scrolling (defaults to 25) + * @type Number + */ + thresh : 25, + + /** + * The number of pixels to scroll in each scroll increment (defaults to 50) + * @type Number + */ + increment : 100, + + /** + * The frequency of scrolls in milliseconds (defaults to 500) + * @type Number + */ + frequency : 500, + + /** + * True to animate the scroll (defaults to true) + * @type Boolean + */ + animate: true, + + /** + * The animation duration in seconds - + * MUST BE less than Roo.dd.ScrollManager.frequency! (defaults to .4) + * @type Number + */ + animDuration: .4, + + /** + * Manually trigger a cache refresh. + */ + refreshCache : function(){ + for(var id in els){ + if(typeof els[id] == 'object'){ // for people extending the object prototype + els[id]._region = els[id].getRegion(); + } + } + } + }; +}(); \ No newline at end of file diff --git a/docs2/src/Roo_dd_StatusProxy.js.html b/docs2/src/Roo_dd_StatusProxy.js.html new file mode 100644 index 0000000000..13adcea905 --- /dev/null +++ b/docs2/src/Roo_dd_StatusProxy.js.html @@ -0,0 +1,177 @@ +/home/alan/gitlive/roojs1/Roo/dd/StatusProxy.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.dd.StatusProxy + * A specialized drag proxy that supports a drop status icon, {@link Roo.Layer} styles and auto-repair. This is the + * default drag proxy used by all Roo.dd components. + * @constructor + * @param {Object} config + */ +Roo.dd.StatusProxy = function(config){ + Roo.apply(this, config); + this.id = this.id || Roo.id(); + this.el = new Roo.Layer({ + dh: { + id: this.id, tag: "div", cls: "x-dd-drag-proxy "+this.dropNotAllowed, children: [ + {tag: "div", cls: "x-dd-drop-icon"}, + {tag: "div", cls: "x-dd-drag-ghost"} + ] + }, + shadow: !config || config.shadow !== false + }); + this.ghost = Roo.get(this.el.dom.childNodes[1]); + this.dropStatus = this.dropNotAllowed; +}; + +Roo.dd.StatusProxy.prototype = { + /** + * @cfg {String} dropAllowed + * The CSS class to apply to the status element when drop is allowed (defaults to "x-dd-drop-ok"). + */ + dropAllowed : "x-dd-drop-ok", + /** + * @cfg {String} dropNotAllowed + * The CSS class to apply to the status element when drop is not allowed (defaults to "x-dd-drop-nodrop"). + */ + dropNotAllowed : "x-dd-drop-nodrop", + + /** + * Updates the proxy's visual element to indicate the status of whether or not drop is allowed + * over the current target element. + * @param {String} cssClass The css class for the new drop status indicator image + */ + setStatus : function(cssClass){ + cssClass = cssClass || this.dropNotAllowed; + if(this.dropStatus != cssClass){ + this.el.replaceClass(this.dropStatus, cssClass); + this.dropStatus = cssClass; + } + }, + + /** + * Resets the status indicator to the default dropNotAllowed value + * @param {Boolean} clearGhost True to also remove all content from the ghost, false to preserve it + */ + reset : function(clearGhost){ + this.el.dom.className = "x-dd-drag-proxy " + this.dropNotAllowed; + this.dropStatus = this.dropNotAllowed; + if(clearGhost){ + this.ghost.update(""); + } + }, + + /** + * Updates the contents of the ghost element + * @param {String} html The html that will replace the current innerHTML of the ghost element + */ + update : function(html){ + if(typeof html == "string"){ + this.ghost.update(html); + }else{ + this.ghost.update(""); + html.style.margin = "0"; + this.ghost.dom.appendChild(html); + } + // ensure float = none set?? cant remember why though. + var el = this.ghost.dom.firstChild; + if(el){ + Roo.fly(el).setStyle('float', 'none'); + } + }, + + /** + * Returns the underlying proxy {@link Roo.Layer} + * @return {Roo.Layer} el + */ + getEl : function(){ + return this.el; + }, + + /** + * Returns the ghost element + * @return {Roo.Element} el + */ + getGhost : function(){ + return this.ghost; + }, + + /** + * Hides the proxy + * @param {Boolean} clear True to reset the status and clear the ghost contents, false to preserve them + */ + hide : function(clear){ + this.el.hide(); + if(clear){ + this.reset(true); + } + }, + + /** + * Stops the repair animation if it's currently running + */ + stop : function(){ + if(this.anim && this.anim.isAnimated && this.anim.isAnimated()){ + this.anim.stop(); + } + }, + + /** + * Displays this proxy + */ + show : function(){ + this.el.show(); + }, + + /** + * Force the Layer to sync its shadow and shim positions to the element + */ + sync : function(){ + this.el.sync(); + }, + + /** + * Causes the proxy to return to its position of origin via an animation. Should be called after an + * invalid drop operation by the item being dragged. + * @param {Array} xy The XY position of the element ([x, y]) + * @param {Function} callback The function to call after the repair is complete + * @param {Object} scope The scope in which to execute the callback + */ + repair : function(xy, callback, scope){ + this.callback = callback; + this.scope = scope; + if(xy && this.animRepair !== false){ + this.el.addClass("x-dd-drag-repair"); + this.el.hideUnders(true); + this.anim = this.el.shift({ + duration: this.repairDuration || .5, + easing: 'easeOut', + xy: xy, + stopFx: true, + callback: this.afterRepair, + scope: this + }); + }else{ + this.afterRepair(); + } + }, + + // private + afterRepair : function(){ + this.hide(true); + if(typeof this.callback == "function"){ + this.callback.call(this.scope || this); + } + this.callback = null; + this.scope = null; + } +}; \ No newline at end of file diff --git a/docs2/src/Roo_form_Action.js.html b/docs2/src/Roo_form_Action.js.html new file mode 100644 index 0000000000..f4678e1690 --- /dev/null +++ b/docs2/src/Roo_form_Action.js.html @@ -0,0 +1,353 @@ +/home/alan/gitlive/roojs1/Roo/form/Action.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +// as we use this in bootstrap. +Roo.namespace('Roo.form'); + /** + * @class Roo.form.Action + * Internal Class used to handle form actions + * @constructor + * @param {Roo.form.BasicForm} el The form element or its id + * @param {Object} config Configuration options + */ + + + +// define the action interface +Roo.form.Action = function(form, options){ + this.form = form; + this.options = options || {}; +}; +/** + * Client Validation Failed + * @const + */ +Roo.form.Action.CLIENT_INVALID = 'client'; +/** + * Server Validation Failed + * @const + */ +Roo.form.Action.SERVER_INVALID = 'server'; + /** + * Connect to Server Failed + * @const + */ +Roo.form.Action.CONNECT_FAILURE = 'connect'; +/** + * Reading Data from Server Failed + * @const + */ +Roo.form.Action.LOAD_FAILURE = 'load'; + +Roo.form.Action.prototype = { + type : 'default', + failureType : undefined, + response : undefined, + result : undefined, + + // interface method + run : function(options){ + + }, + + // interface method + success : function(response){ + + }, + + // interface method + handleResponse : function(response){ + + }, + + // default connection failure + failure : function(response){ + + this.response = response; + this.failureType = Roo.form.Action.CONNECT_FAILURE; + this.form.afterAction(this, false); + }, + + processResponse : function(response){ + this.response = response; + if(!response.responseText){ + return true; + } + this.result = this.handleResponse(response); + return this.result; + }, + + // utility functions used internally + getUrl : function(appendParams){ + var url = this.options.url || this.form.url || this.form.el.dom.action; + if(appendParams){ + var p = this.getParams(); + if(p){ + url += (url.indexOf('?') != -1 ? '&' : '?') + p; + } + } + return url; + }, + + getMethod : function(){ + return (this.options.method || this.form.method || this.form.el.dom.method || 'POST').toUpperCase(); + }, + + getParams : function(){ + var bp = this.form.baseParams; + var p = this.options.params; + if(p){ + if(typeof p == "object"){ + p = Roo.urlEncode(Roo.applyIf(p, bp)); + }else if(typeof p == 'string' && bp){ + p += '&' + Roo.urlEncode(bp); + } + }else if(bp){ + p = Roo.urlEncode(bp); + } + return p; + }, + + createCallback : function(){ + return { + success: this.success, + failure: this.failure, + scope: this, + timeout: (this.form.timeout*1000), + upload: this.form.fileUpload ? this.success : undefined + }; + } +}; + +Roo.form.Action.Submit = function(form, options){ + Roo.form.Action.Submit.superclass.constructor.call(this, form, options); +}; + +Roo.extend(Roo.form.Action.Submit, Roo.form.Action, { + type : 'submit', + + haveProgress : false, + uploadComplete : false, + + // uploadProgress indicator. + uploadProgress : function() + { + if (!this.form.progressUrl) { + return; + } + + if (!this.haveProgress) { + Roo.MessageBox.progress("Uploading", "Uploading"); + } + if (this.uploadComplete) { + Roo.MessageBox.hide(); + return; + } + + this.haveProgress = true; + + var uid = this.form.findField('UPLOAD_IDENTIFIER').getValue(); + + var c = new Roo.data.Connection(); + c.request({ + url : this.form.progressUrl, + params: { + id : uid + }, + method: 'GET', + success : function(req){ + //console.log(data); + var rdata = false; + var edata; + try { + rdata = Roo.decode(req.responseText) + } catch (e) { + Roo.log("Invalid data from server.."); + Roo.log(edata); + return; + } + if (!rdata || !rdata.success) { + Roo.log(rdata); + Roo.MessageBox.alert(Roo.encode(rdata)); + return; + } + var data = rdata.data; + + if (this.uploadComplete) { + Roo.MessageBox.hide(); + return; + } + + if (data){ + Roo.MessageBox.updateProgress(data.bytes_uploaded/data.bytes_total, + Math.floor((data.bytes_total - data.bytes_uploaded)/1000) + 'k remaining' + ); + } + this.uploadProgress.defer(2000,this); + }, + + failure: function(data) { + Roo.log('progress url failed '); + Roo.log(data); + }, + scope : this + }); + + }, + + + run : function() + { + // run get Values on the form, so it syncs any secondary forms. + this.form.getValues(); + + var o = this.options; + var method = this.getMethod(); + var isPost = method == 'POST'; + if(o.clientValidation === false || this.form.isValid()){ + + if (this.form.progressUrl) { + this.form.findField('UPLOAD_IDENTIFIER').setValue( + (new Date() * 1) + '' + Math.random()); + + } + + + Roo.Ajax.request(Roo.apply(this.createCallback(), { + form:this.form.el.dom, + url:this.getUrl(!isPost), + method: method, + params:isPost ? this.getParams() : null, + isUpload: this.form.fileUpload, + formData : this.form.formData + })); + + this.uploadProgress(); + + }else if (o.clientValidation !== false){ // client validation failed + this.failureType = Roo.form.Action.CLIENT_INVALID; + this.form.afterAction(this, false); + } + }, + + success : function(response) + { + this.uploadComplete= true; + if (this.haveProgress) { + Roo.MessageBox.hide(); + } + + + var result = this.processResponse(response); + if(result === true || result.success){ + this.form.afterAction(this, true); + return; + } + if(result.errors){ + this.form.markInvalid(result.errors); + this.failureType = Roo.form.Action.SERVER_INVALID; + } + this.form.afterAction(this, false); + }, + failure : function(response) + { + this.uploadComplete= true; + if (this.haveProgress) { + Roo.MessageBox.hide(); + } + + this.response = response; + this.failureType = Roo.form.Action.CONNECT_FAILURE; + this.form.afterAction(this, false); + }, + + handleResponse : function(response){ + if(this.form.errorReader){ + var rs = this.form.errorReader.read(response); + var errors = []; + if(rs.records){ + for(var i = 0, len = rs.records.length; i < len; i++) { + var r = rs.records[i]; + errors[i] = r.data; + } + } + if(errors.length < 1){ + errors = null; + } + return { + success : rs.success, + errors : errors + }; + } + var ret = false; + try { + ret = Roo.decode(response.responseText); + } catch (e) { + ret = { + success: false, + errorMsg: "Failed to read server message: " + (response ? response.responseText : ' - no message'), + errors : [] + }; + } + return ret; + + } +}); + + +Roo.form.Action.Load = function(form, options){ + Roo.form.Action.Load.superclass.constructor.call(this, form, options); + this.reader = this.form.reader; +}; + +Roo.extend(Roo.form.Action.Load, Roo.form.Action, { + type : 'load', + + run : function(){ + + Roo.Ajax.request(Roo.apply( + this.createCallback(), { + method:this.getMethod(), + url:this.getUrl(false), + params:this.getParams() + })); + }, + + success : function(response){ + + var result = this.processResponse(response); + if(result === true || !result.success || !result.data){ + this.failureType = Roo.form.Action.LOAD_FAILURE; + this.form.afterAction(this, false); + return; + } + this.form.clearInvalid(); + this.form.setValues(result.data); + this.form.afterAction(this, true); + }, + + handleResponse : function(response){ + if(this.form.reader){ + var rs = this.form.reader.read(response); + var data = rs.records && rs.records[0] ? rs.records[0].data : null; + return { + success : rs.success, + data : data + }; + } + return Roo.decode(response.responseText); + } +}); + +Roo.form.Action.ACTION_TYPES = { + 'load' : Roo.form.Action.Load, + 'submit' : Roo.form.Action.Submit +}; \ No newline at end of file diff --git a/docs2/src/Roo_form_BasicForm.js.html b/docs2/src/Roo_form_BasicForm.js.html new file mode 100644 index 0000000000..2b4c8f1292 --- /dev/null +++ b/docs2/src/Roo_form_BasicForm.js.html @@ -0,0 +1,663 @@ +/home/alan/gitlive/roojs1/Roo/form/BasicForm.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.form.BasicForm + * @extends Roo.util.Observable + * Supplies the functionality to do "actions" on forms and initialize Roo.form.Field types on existing markup. + * @constructor + * @param {String/HTMLElement/Roo.Element} el The form element or its id + * @param {Object} config Configuration options + */ +Roo.form.BasicForm = function(el, config){ + this.allItems = []; + this.childForms = []; + Roo.apply(this, config); + /* + * The Roo.form.Field items in this form. + * @type MixedCollection + */ + + + this.items = new Roo.util.MixedCollection(false, function(o){ + return o.id || (o.id = Roo.id()); + }); + this.addEvents({ + /** + * @event beforeaction + * Fires before any action is performed. Return false to cancel the action. + * @param {Form} this + * @param {Action} action The action to be performed + */ + beforeaction: true, + /** + * @event actionfailed + * Fires when an action fails. + * @param {Form} this + * @param {Action} action The action that failed + */ + actionfailed : true, + /** + * @event actioncomplete + * Fires when an action is completed. + * @param {Form} this + * @param {Action} action The action that completed + */ + actioncomplete : true + }); + if(el){ + this.initEl(el); + } + Roo.form.BasicForm.superclass.constructor.call(this); +}; + +Roo.extend(Roo.form.BasicForm, Roo.util.Observable, { + /** + * @cfg {String} method + * The request method to use (GET or POST) for form actions if one isn't supplied in the action options. + */ + /** + * @cfg {DataReader} reader + * An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing "load" actions. + * This is optional as there is built-in support for processing JSON. + */ + /** + * @cfg {DataReader} errorReader + * An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on "submit" actions. + * This is completely optional as there is built-in support for processing JSON. + */ + /** + * @cfg {String} url + * The URL to use for form actions if one isn't supplied in the action options. + */ + /** + * @cfg {Boolean} fileUpload + * Set to true if this form is a file upload. + */ + + /** + * @cfg {Object} baseParams + * Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}. + */ + /** + + /** + * @cfg {Number} timeout Timeout for form actions in seconds (default is 30 seconds). + */ + timeout: 30, + + // private + activeAction : null, + + /** + * @cfg {Boolean} trackResetOnLoad If set to true, form.reset() resets to the last loaded + * or setValues() data instead of when the form was first created. + */ + trackResetOnLoad : false, + + + /** + * childForms - used for multi-tab forms + * @type {Array} + */ + childForms : false, + + /** + * allItems - full list of fields. + * @type {Array} + */ + allItems : false, + + /** + * By default wait messages are displayed with Roo.MessageBox.wait. You can target a specific + * element by passing it or its id or mask the form itself by passing in true. + * @type Mixed + */ + waitMsgTarget : false, + + // private + initEl : function(el){ + this.el = Roo.get(el); + this.id = this.el.id || Roo.id(); + this.el.on('submit', this.onSubmit, this); + this.el.addClass('x-form'); + }, + + // private + onSubmit : function(e){ + e.stopEvent(); + }, + + /** + * Returns true if client-side validation on the form is successful. + * @return Boolean + */ + isValid : function(){ + var valid = true; + this.items.each(function(f){ + if(!f.validate()){ + valid = false; + } + }); + return valid; + }, + + /** + * DEPRICATED Returns true if any fields in this form have changed since their original load. + * @return Boolean + */ + isDirty : function(){ + var dirty = false; + this.items.each(function(f){ + if(f.isDirty()){ + dirty = true; + return false; + } + }); + return dirty; + }, + + /** + * Returns true if any fields in this form have changed since their original load. (New version) + * @return Boolean + */ + + hasChanged : function() + { + var dirty = false; + this.items.each(function(f){ + if(f.hasChanged()){ + dirty = true; + return false; + } + }); + return dirty; + + }, + /** + * Resets all hasChanged to 'false' - + * The old 'isDirty' used 'original value..' however this breaks reset() and a few other things. + * So hasChanged storage is only to be used for this purpose + * @return Boolean + */ + resetHasChanged : function() + { + this.items.each(function(f){ + f.resetHasChanged(); + }); + + }, + + + /** + * Performs a predefined action (submit or load) or custom actions you define on this form. + * @param {String} actionName The name of the action type + * @param {Object} options (optional) The options to pass to the action. All of the config options listed + * below are supported by both the submit and load actions unless otherwise noted (custom actions could also + * accept other config options): + * <pre> +Property Type Description +---------------- --------------- ---------------------------------------------------------------------------------- +url String The url for the action (defaults to the form's url) +method String The form method to use (defaults to the form's method, or POST if not defined) +params String/Object The params to pass (defaults to the form's baseParams, or none if not defined) +clientValidation Boolean Applies to submit only. Pass true to call form.isValid() prior to posting to + validate the form on the client (defaults to false) + * </pre> + * @return {BasicForm} this + */ + doAction : function(action, options){ + if(typeof action == 'string'){ + action = new Roo.form.Action.ACTION_TYPES[action](this, options); + } + if(this.fireEvent('beforeaction', this, action) !== false){ + this.beforeAction(action); + action.run.defer(100, action); + } + return this; + }, + + /** + * Shortcut to do a submit action. + * @param {Object} options The options to pass to the action (see {@link #doAction} for details) + * @return {BasicForm} this + */ + submit : function(options){ + this.doAction('submit', options); + return this; + }, + + /** + * Shortcut to do a load action. + * @param {Object} options The options to pass to the action (see {@link #doAction} for details) + * @return {BasicForm} this + */ + load : function(options){ + this.doAction('load', options); + return this; + }, + + /** + * Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block. + * @param {Record} record The record to edit + * @return {BasicForm} this + */ + updateRecord : function(record){ + record.beginEdit(); + var fs = record.fields; + fs.each(function(f){ + var field = this.findField(f.name); + if(field){ + record.set(f.name, field.getValue()); + } + }, this); + record.endEdit(); + return this; + }, + + /** + * Loads an Roo.data.Record into this form. + * @param {Record} record The record to load + * @return {BasicForm} this + */ + loadRecord : function(record){ + this.setValues(record.data); + return this; + }, + + // private + beforeAction : function(action){ + var o = action.options; + + + if(this.waitMsgTarget === true){ + this.el.mask(o.waitMsg || "Sending", 'x-mask-loading'); + }else if(this.waitMsgTarget){ + this.waitMsgTarget = Roo.get(this.waitMsgTarget); + this.waitMsgTarget.mask(o.waitMsg || "Sending", 'x-mask-loading'); + }else { + Roo.MessageBox.wait(o.waitMsg || "Sending", o.waitTitle || this.waitTitle || 'Please Wait...'); + } + + }, + + // private + afterAction : function(action, success){ + this.activeAction = null; + var o = action.options; + + if(this.waitMsgTarget === true){ + this.el.unmask(); + }else if(this.waitMsgTarget){ + this.waitMsgTarget.unmask(); + }else{ + Roo.MessageBox.updateProgress(1); + Roo.MessageBox.hide(); + } + + if(success){ + if(o.reset){ + this.reset(); + } + Roo.callback(o.success, o.scope, [this, action]); + this.fireEvent('actioncomplete', this, action); + + }else{ + + // failure condition.. + // we have a scenario where updates need confirming. + // eg. if a locking scenario exists.. + // we look for { errors : { needs_confirm : true }} in the response. + if ( + (typeof(action.result) != 'undefined') && + (typeof(action.result.errors) != 'undefined') && + (typeof(action.result.errors.needs_confirm) != 'undefined') + ){ + var _t = this; + Roo.MessageBox.confirm( + "Change requires confirmation", + action.result.errorMsg, + function(r) { + if (r != 'yes') { + return; + } + _t.doAction('submit', { params : { _submit_confirmed : 1 } } ); + } + + ); + + + + return; + } + + Roo.callback(o.failure, o.scope, [this, action]); + // show an error message if no failed handler is set.. + if (!this.hasListener('actionfailed')) { + Roo.MessageBox.alert("Error", + (typeof(action.result) != 'undefined' && typeof(action.result.errorMsg) != 'undefined') ? + action.result.errorMsg : + "Saving Failed, please check your entries or try again" + ); + } + + this.fireEvent('actionfailed', this, action); + } + + }, + + /** + * Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName + * @param {String} id The value to search for + * @return Field + */ + findField : function(id){ + var field = this.items.get(id); + if(!field){ + this.items.each(function(f){ + if(f.isFormField && (f.dataIndex == id || f.id == id || f.getName() == id)){ + field = f; + return false; + } + }); + } + return field || null; + }, + + /** + * Add a secondary form to this one, + * Used to provide tabbed forms. One form is primary, with hidden values + * which mirror the elements from the other forms. + * + * @param {Roo.form.Form} form to add. + * + */ + addForm : function(form) + { + + if (this.childForms.indexOf(form) > -1) { + // already added.. + return; + } + this.childForms.push(form); + var n = ''; + Roo.each(form.allItems, function (fe) { + + n = typeof(fe.getName) == 'undefined' ? fe.name : fe.getName(); + if (this.findField(n)) { // already added.. + return; + } + var add = new Roo.form.Hidden({ + name : n + }); + add.render(this.el); + + this.add( add ); + }, this); + + }, + /** + * Mark fields in this form invalid in bulk. + * @param {Array/Object} errors Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2} + * @return {BasicForm} this + */ + markInvalid : function(errors){ + if(errors instanceof Array){ + for(var i = 0, len = errors.length; i < len; i++){ + var fieldError = errors[i]; + var f = this.findField(fieldError.id); + if(f){ + f.markInvalid(fieldError.msg); + } + } + }else{ + var field, id; + for(id in errors){ + if(typeof errors[id] != 'function' && (field = this.findField(id))){ + field.markInvalid(errors[id]); + } + } + } + Roo.each(this.childForms || [], function (f) { + f.markInvalid(errors); + }); + + return this; + }, + + /** + * Set values for fields in this form in bulk. + * @param {Array/Object} values Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2} + * @return {BasicForm} this + */ + setValues : function(values){ + if(values instanceof Array){ // array of objects + for(var i = 0, len = values.length; i < len; i++){ + var v = values[i]; + var f = this.findField(v.id); + if(f){ + f.setValue(v.value); + if(this.trackResetOnLoad){ + f.originalValue = f.getValue(); + } + } + } + }else{ // object hash + var field, id; + for(id in values){ + if(typeof values[id] != 'function' && (field = this.findField(id))){ + + if (field.setFromData && + field.valueField && + field.displayField && + // combos' with local stores can + // be queried via setValue() + // to set their value.. + (field.store && !field.store.isLocal) + ) { + // it's a combo + var sd = { }; + sd[field.valueField] = typeof(values[field.hiddenName]) == 'undefined' ? '' : values[field.hiddenName]; + sd[field.displayField] = typeof(values[field.name]) == 'undefined' ? '' : values[field.name]; + field.setFromData(sd); + + } else { + field.setValue(values[id]); + } + + + if(this.trackResetOnLoad){ + field.originalValue = field.getValue(); + } + } + } + } + this.resetHasChanged(); + + + Roo.each(this.childForms || [], function (f) { + f.setValues(values); + f.resetHasChanged(); + }); + + return this; + }, + + /** + * Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name + * they are returned as an array. + * @param {Boolean} asString + * @return {Object} + */ + getValues : function(asString){ + if (this.childForms) { + // copy values from the child forms + Roo.each(this.childForms, function (f) { + this.setValues(f.getValues()); + }, this); + } + + + + var fs = Roo.lib.Ajax.serializeForm(this.el.dom); + if(asString === true){ + return fs; + } + return Roo.urlDecode(fs); + }, + + /** + * Returns the fields in this form as an object with key/value pairs. + * This differs from getValues as it calls getValue on each child item, rather than using dom data. + * @return {Object} + */ + getFieldValues : function(with_hidden) + { + if (this.childForms) { + // copy values from the child forms + // should this call getFieldValues - probably not as we do not currently copy + // hidden fields when we generate.. + Roo.each(this.childForms, function (f) { + this.setValues(f.getValues()); + }, this); + } + + var ret = {}; + this.items.each(function(f){ + if (!f.getName()) { + return; + } + var v = f.getValue(); + if (f.inputType =='radio') { + if (typeof(ret[f.getName()]) == 'undefined') { + ret[f.getName()] = ''; // empty.. + } + + if (!f.el.dom.checked) { + return; + + } + v = f.el.dom.value; + + } + + // not sure if this supported any more.. + if ((typeof(v) == 'object') && f.getRawValue) { + v = f.getRawValue() ; // dates.. + } + // combo boxes where name != hiddenName... + if (f.name != f.getName()) { + ret[f.name] = f.getRawValue(); + } + ret[f.getName()] = v; + }); + + return ret; + }, + + /** + * Clears all invalid messages in this form. + * @return {BasicForm} this + */ + clearInvalid : function(){ + this.items.each(function(f){ + f.clearInvalid(); + }); + + Roo.each(this.childForms || [], function (f) { + f.clearInvalid(); + }); + + + return this; + }, + + /** + * Resets this form. + * @return {BasicForm} this + */ + reset : function(){ + this.items.each(function(f){ + f.reset(); + }); + + Roo.each(this.childForms || [], function (f) { + f.reset(); + }); + this.resetHasChanged(); + + return this; + }, + + /** + * Add Roo.form components to this form. + * @param {Field} field1 + * @param {Field} field2 (optional) + * @param {Field} etc (optional) + * @return {BasicForm} this + */ + add : function(){ + this.items.addAll(Array.prototype.slice.call(arguments, 0)); + return this; + }, + + + /** + * Removes a field from the items collection (does NOT remove its markup). + * @param {Field} field + * @return {BasicForm} this + */ + remove : function(field){ + this.items.remove(field); + return this; + }, + + /** + * Looks at the fields in this form, checks them for an id attribute, + * and calls applyTo on the existing dom element with that id. + * @return {BasicForm} this + */ + render : function(){ + this.items.each(function(f){ + if(f.isFormField && !f.rendered && document.getElementById(f.id)){ // if the element exists + f.applyTo(f.id); + } + }); + return this; + }, + + /** + * Calls {@link Ext#apply} for all fields in this form with the passed object. + * @param {Object} values + * @return {BasicForm} this + */ + applyToFields : function(o){ + this.items.each(function(f){ + Roo.apply(f, o); + }); + return this; + }, + + /** + * Calls {@link Ext#applyIf} for all field in this form with the passed object. + * @param {Object} values + * @return {BasicForm} this + */ + applyIfToFields : function(o){ + this.items.each(function(f){ + Roo.applyIf(f, o); + }); + return this; + } +}); + +// back compat +Roo.BasicForm = Roo.form.BasicForm; \ No newline at end of file diff --git a/docs2/src/Roo_form_Checkbox.js.html b/docs2/src/Roo_form_Checkbox.js.html new file mode 100644 index 0000000000..4c397ac663 --- /dev/null +++ b/docs2/src/Roo_form_Checkbox.js.html @@ -0,0 +1,222 @@ +/home/alan/gitlive/roojs1/Roo/form/Checkbox.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.form.Checkbox + * @extends Roo.form.Field + * Single checkbox field. Can be used as a direct replacement for traditional checkbox fields. + * @constructor + * Creates a new Checkbox + * @param {Object} config Configuration options + */ +Roo.form.Checkbox = function(config){ + Roo.form.Checkbox.superclass.constructor.call(this, config); + this.addEvents({ + /** + * @event check + * Fires when the checkbox is checked or unchecked. + * @param {Roo.form.Checkbox} this This checkbox + * @param {Boolean} checked The new checked value + */ + check : true + }); +}; + +Roo.extend(Roo.form.Checkbox, Roo.form.Field, { + /** + * @cfg {String} focusClass The CSS class to use when the checkbox receives focus (defaults to undefined) + */ + focusClass : undefined, + /** + * @cfg {String} fieldClass The default CSS class for the checkbox (defaults to "x-form-field") + */ + fieldClass: "x-form-field", + /** + * @cfg {Boolean} checked True if the the checkbox should render already checked (defaults to false) + */ + checked: false, + /** + * @cfg {String/Object} autoCreate A DomHelper element spec, or true for a default element spec (defaults to + * {tag: "input", type: "checkbox", autocomplete: "off"}) + */ + defaultAutoCreate : { tag: "input", type: 'hidden', autocomplete: "off"}, + /** + * @cfg {String} boxLabel The text that appears beside the checkbox + */ + boxLabel : "", + /** + * @cfg {String} inputValue The value that should go into the generated input element's value attribute + */ + inputValue : '1', + /** + * @cfg {String} valueOff The value that should go into the generated input element's value when unchecked. + */ + valueOff: '0', // value when not checked.. + + actionMode : 'viewEl', + // + // private + itemCls : 'x-menu-check-item x-form-item', + groupClass : 'x-menu-group-item', + inputType : 'hidden', + + + inSetChecked: false, // check that we are not calling self... + + inputElement: false, // real input element? + basedOn: false, // ???? + + isFormField: true, // not sure where this is needed!!!! + + onResize : function(){ + Roo.form.Checkbox.superclass.onResize.apply(this, arguments); + if(!this.boxLabel){ + this.el.alignTo(this.wrap, 'c-c'); + } + }, + + initEvents : function(){ + Roo.form.Checkbox.superclass.initEvents.call(this); + this.el.on("click", this.onClick, this); + this.el.on("change", this.onClick, this); + }, + + + getResizeEl : function(){ + return this.wrap; + }, + + getPositionEl : function(){ + return this.wrap; + }, + + // private + onRender : function(ct, position){ + Roo.form.Checkbox.superclass.onRender.call(this, ct, position); + /* + if(this.inputValue !== undefined){ + this.el.dom.value = this.inputValue; + } + */ + //this.wrap = this.el.wrap({cls: "x-form-check-wrap"}); + this.wrap = this.el.wrap({cls: 'x-menu-check-item '}); + var viewEl = this.wrap.createChild({ + tag: 'img', cls: 'x-menu-item-icon', style: 'margin: 0px;' ,src : Roo.BLANK_IMAGE_URL }); + this.viewEl = viewEl; + this.wrap.on('click', this.onClick, this); + + this.el.on('DOMAttrModified', this.setFromHidden, this); //ff + this.el.on('propertychange', this.setFromHidden, this); //ie + + + + if(this.boxLabel){ + this.wrap.createChild({tag: 'label', htmlFor: this.el.id, cls: 'x-form-cb-label', html: this.boxLabel}); + // viewEl.on('click', this.onClick, this); + } + //if(this.checked){ + this.setChecked(this.checked); + //}else{ + //this.checked = this.el.dom; + //} + + }, + + // private + initValue : Roo.emptyFn, + + /** + * Returns the checked state of the checkbox. + * @return {Boolean} True if checked, else false + */ + getValue : function(){ + if(this.el){ + return String(this.el.dom.value) == String(this.inputValue ) ? this.inputValue : this.valueOff; + } + return this.valueOff; + + }, + + // private + onClick : function(){ + if (this.disabled) { + return; + } + this.setChecked(!this.checked); + + //if(this.el.dom.checked != this.checked){ + // this.setValue(this.el.dom.checked); + // } + }, + + /** + * Sets the checked state of the checkbox. + * On is always based on a string comparison between inputValue and the param. + * @param {Boolean/String} value - the value to set + * @param {Boolean/String} suppressEvent - whether to suppress the checkchange event. + */ + setValue : function(v,suppressEvent){ + + + //this.checked = (v === true || v === 'true' || v == '1' || String(v).toLowerCase() == 'on'); + //if(this.el && this.el.dom){ + // this.el.dom.checked = this.checked; + // this.el.dom.defaultChecked = this.checked; + //} + this.setChecked(String(v) === String(this.inputValue), suppressEvent); + //this.fireEvent("check", this, this.checked); + }, + // private.. + setChecked : function(state,suppressEvent) + { + if (this.inSetChecked) { + this.checked = state; + return; + } + + + if(this.wrap){ + this.wrap[state ? 'addClass' : 'removeClass']('x-menu-item-checked'); + } + this.checked = state; + if(suppressEvent !== true){ + this.fireEvent('check', this, state); + } + this.inSetChecked = true; + this.el.dom.value = state ? this.inputValue : this.valueOff; + this.inSetChecked = false; + + }, + // handle setting of hidden value by some other method!!?!? + setFromHidden: function() + { + if(!this.el){ + return; + } + //console.log("SET FROM HIDDEN"); + //alert('setFrom hidden'); + this.setValue(this.el.dom.value); + }, + + onDestroy : function() + { + if(this.viewEl){ + Roo.get(this.viewEl).remove(); + } + + Roo.form.Checkbox.superclass.onDestroy.call(this); + }, + + setBoxLabel : function(str) + { + this.wrap.select('.x-form-cb-label', true).first().dom.innerHTML = str; + } + +}); \ No newline at end of file diff --git a/docs2/src/Roo_form_ComboBox.js.html b/docs2/src/Roo_form_ComboBox.js.html new file mode 100644 index 0000000000..d389d510a8 --- /dev/null +++ b/docs2/src/Roo_form_ComboBox.js.html @@ -0,0 +1,1086 @@ +/home/alan/gitlive/roojs1/Roo/form/ComboBox.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.form.ComboBox + * @extends Roo.form.TriggerField + * A combobox control with support for autocomplete, remote-loading, paging and many other features. + * @constructor + * Create a new ComboBox. + * @param {Object} config Configuration options + */ +Roo.form.ComboBox = function(config){ + Roo.form.ComboBox.superclass.constructor.call(this, config); + this.addEvents({ + /** + * @event expand + * Fires when the dropdown list is expanded + * @param {Roo.form.ComboBox} combo This combo box + */ + 'expand' : true, + /** + * @event collapse + * Fires when the dropdown list is collapsed + * @param {Roo.form.ComboBox} combo This combo box + */ + 'collapse' : true, + /** + * @event beforeselect + * Fires before a list item is selected. Return false to cancel the selection. + * @param {Roo.form.ComboBox} combo This combo box + * @param {Roo.data.Record} record The data record returned from the underlying store + * @param {Number} index The index of the selected item in the dropdown list + */ + 'beforeselect' : true, + /** + * @event select + * Fires when a list item is selected + * @param {Roo.form.ComboBox} combo This combo box + * @param {Roo.data.Record} record The data record returned from the underlying store (or false on clear) + * @param {Number} index The index of the selected item in the dropdown list + */ + 'select' : true, + /** + * @event beforequery + * Fires before all queries are processed. Return false to cancel the query or set cancel to true. + * The event object passed has these properties: + * @param {Roo.form.ComboBox} combo This combo box + * @param {String} query The query + * @param {Boolean} forceAll true to force "all" query + * @param {Boolean} cancel true to cancel the query + * @param {Object} e The query event object + */ + 'beforequery': true, + /** + * @event add + * Fires when the 'add' icon is pressed (add a listener to enable add button) + * @param {Roo.form.ComboBox} combo This combo box + */ + 'add' : true, + /** + * @event edit + * Fires when the 'edit' icon is pressed (add a listener to enable add button) + * @param {Roo.form.ComboBox} combo This combo box + * @param {Roo.data.Record|false} record The data record returned from the underlying store (or false on nothing selected) + */ + 'edit' : true + + + }); + if(this.transform){ + this.allowDomMove = false; + var s = Roo.getDom(this.transform); + if(!this.hiddenName){ + this.hiddenName = s.name; + } + if(!this.store){ + this.mode = 'local'; + var d = [], opts = s.options; + for(var i = 0, len = opts.length;i < len; i++){ + var o = opts[i]; + var value = (Roo.isIE ? o.getAttributeNode('value').specified : o.hasAttribute('value')) ? o.value : o.text; + if(o.selected) { + this.value = value; + } + d.push([value, o.text]); + } + this.store = new Roo.data.SimpleStore({ + 'id': 0, + fields: ['value', 'text'], + data : d + }); + this.valueField = 'value'; + this.displayField = 'text'; + } + s.name = Roo.id(); // wipe out the name in case somewhere else they have a reference + if(!this.lazyRender){ + this.target = true; + this.el = Roo.DomHelper.insertBefore(s, this.autoCreate || this.defaultAutoCreate); + s.parentNode.removeChild(s); // remove it + this.render(this.el.parentNode); + }else{ + s.parentNode.removeChild(s); // remove it + } + + } + if (this.store) { + this.store = Roo.factory(this.store, Roo.data); + } + + this.selectedIndex = -1; + if(this.mode == 'local'){ + if(config.queryDelay === undefined){ + this.queryDelay = 10; + } + if(config.minChars === undefined){ + this.minChars = 0; + } + } +}; + +Roo.extend(Roo.form.ComboBox, Roo.form.TriggerField, { + /** + * @cfg {String/HTMLElement/Element} transform The id, DOM node or element of an existing select to convert to a ComboBox + */ + /** + * @cfg {Boolean} lazyRender True to prevent the ComboBox from rendering until requested (should always be used when + * rendering into an Roo.Editor, defaults to false) + */ + /** + * @cfg {Boolean/Object} autoCreate A DomHelper element spec, or true for a default element spec (defaults to: + * {tag: "input", type: "text", size: "24", autocomplete: "off"}) + */ + /** + * @cfg {Roo.data.Store} store The data store to which this combo is bound (defaults to undefined) + */ + /** + * @cfg {String} title If supplied, a header element is created containing this text and added into the top of + * the dropdown list (defaults to undefined, with no header element) + */ + + /** + * @cfg {String/Roo.Template} tpl The template to use to render the output + */ + + // private + defaultAutoCreate : {tag: "input", type: "text", size: "24", autocomplete: "off"}, + /** + * @cfg {Number} listWidth The width in pixels of the dropdown list (defaults to the width of the ComboBox field) + */ + listWidth: undefined, + /** + * @cfg {String} displayField The underlying data field name to bind to this CombBox (defaults to undefined if + * mode = 'remote' or 'text' if mode = 'local') + */ + displayField: undefined, + /** + * @cfg {String} valueField The underlying data value name to bind to this CombBox (defaults to undefined if + * mode = 'remote' or 'value' if mode = 'local'). + * Note: use of a valueField requires the user make a selection + * in order for a value to be mapped. + */ + valueField: undefined, + + + /** + * @cfg {String} hiddenName If specified, a hidden form field with this name is dynamically generated to store the + * field's data value (defaults to the underlying DOM element's name) + */ + hiddenName: undefined, + /** + * @cfg {String} listClass CSS class to apply to the dropdown list element (defaults to '') + */ + listClass: '', + /** + * @cfg {String} selectedClass CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected') + */ + selectedClass: 'x-combo-selected', + /** + * @cfg {String} triggerClass An additional CSS class used to style the trigger button. The trigger will always get the + * class 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger' + * which displays a downward arrow icon). + */ + triggerClass : 'x-form-arrow-trigger', + /** + * @cfg {Boolean/String} shadow True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right + */ + shadow:'sides', + /** + * @cfg {String} listAlign A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported + * anchor positions (defaults to 'tl-bl') + */ + listAlign: 'tl-bl?', + /** + * @cfg {Number} maxHeight The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300) + */ + maxHeight: 300, + /** + * @cfg {String} triggerAction The action to execute when the trigger field is activated. Use 'all' to run the + * query specified by the allQuery config option (defaults to 'query') + */ + triggerAction: 'query', + /** + * @cfg {Number} minChars The minimum number of characters the user must type before autocomplete and typeahead activate + * (defaults to 4, does not apply if editable = false) + */ + minChars : 4, + /** + * @cfg {Boolean} typeAhead True to populate and autoselect the remainder of the text being typed after a configurable + * delay (typeAheadDelay) if it matches a known value (defaults to false) + */ + typeAhead: false, + /** + * @cfg {Number} queryDelay The length of time in milliseconds to delay between the start of typing and sending the + * query to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local') + */ + queryDelay: 500, + /** + * @cfg {Number} pageSize If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the + * filter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0) + */ + pageSize: 0, + /** + * @cfg {Boolean} selectOnFocus True to select any existing text in the field immediately on focus. Only applies + * when editable = true (defaults to false) + */ + selectOnFocus:false, + /** + * @cfg {String} queryParam Name of the query as it will be passed on the querystring (defaults to 'query') + */ + queryParam: 'query', + /** + * @cfg {String} loadingText The text to display in the dropdown list while data is loading. Only applies + * when mode = 'remote' (defaults to 'Loading...') + */ + loadingText: 'Loading...', + /** + * @cfg {Boolean} resizable True to add a resize handle to the bottom of the dropdown list (defaults to false) + */ + resizable: false, + /** + * @cfg {Number} handleHeight The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8) + */ + handleHeight : 8, + /** + * @cfg {Boolean} editable False to prevent the user from typing text directly into the field, just like a + * traditional select (defaults to true) + */ + editable: true, + /** + * @cfg {String} allQuery The text query to send to the server to return all records for the list with no filtering (defaults to '') + */ + allQuery: '', + /** + * @cfg {String} mode Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server) + */ + mode: 'remote', + /** + * @cfg {Number} minListWidth The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if + * listWidth has a higher value) + */ + minListWidth : 70, + /** + * @cfg {Boolean} forceSelection True to restrict the selected value to one of the values in the list, false to + * allow the user to set arbitrary text into the field (defaults to false) + */ + forceSelection:false, + /** + * @cfg {Number} typeAheadDelay The length of time in milliseconds to wait until the typeahead text is displayed + * if typeAhead = true (defaults to 250) + */ + typeAheadDelay : 250, + /** + * @cfg {String} valueNotFoundText When using a name/value combo, if the value passed to setValue is not found in + * the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined) + */ + valueNotFoundText : undefined, + /** + * @cfg {Boolean} blockFocus Prevents all focus calls, so it can work with things like HTML edtor bar + */ + blockFocus : false, + + /** + * @cfg {Boolean} disableClear Disable showing of clear button. + */ + disableClear : false, + /** + * @cfg {Boolean} alwaysQuery Disable caching of results, and always send query + */ + alwaysQuery : false, + + //private + addicon : false, + editicon: false, + + // element that contains real text value.. (when hidden is used..) + + // private + onRender : function(ct, position){ + Roo.form.ComboBox.superclass.onRender.call(this, ct, position); + if(this.hiddenName){ + this.hiddenField = this.el.insertSibling({tag:'input', type:'hidden', name: this.hiddenName, id: (this.hiddenId||this.hiddenName)}, + 'before', true); + this.hiddenField.value = + this.hiddenValue !== undefined ? this.hiddenValue : + this.value !== undefined ? this.value : ''; + + // prevent input submission + this.el.dom.removeAttribute('name'); + + + } + if(Roo.isGecko){ + this.el.dom.setAttribute('autocomplete', 'off'); + } + + var cls = 'x-combo-list'; + + this.list = new Roo.Layer({ + shadow: this.shadow, cls: [cls, this.listClass].join(' '), constrain:false + }); + + var lw = this.listWidth || Math.max(this.wrap.getWidth(), this.minListWidth); + this.list.setWidth(lw); + this.list.swallowEvent('mousewheel'); + this.assetHeight = 0; + + if(this.title){ + this.header = this.list.createChild({cls:cls+'-hd', html: this.title}); + this.assetHeight += this.header.getHeight(); + } + + this.innerList = this.list.createChild({cls:cls+'-inner'}); + this.innerList.on('mouseover', this.onViewOver, this); + this.innerList.on('mousemove', this.onViewMove, this); + this.innerList.setWidth(lw - this.list.getFrameWidth('lr')); + + if(this.allowBlank && !this.pageSize && !this.disableClear){ + this.footer = this.list.createChild({cls:cls+'-ft'}); + this.pageTb = new Roo.Toolbar(this.footer); + + } + if(this.pageSize){ + this.footer = this.list.createChild({cls:cls+'-ft'}); + this.pageTb = new Roo.PagingToolbar(this.footer, this.store, + {pageSize: this.pageSize}); + + } + + if (this.pageTb && this.allowBlank && !this.disableClear) { + var _this = this; + this.pageTb.add(new Roo.Toolbar.Fill(), { + cls: 'x-btn-icon x-btn-clear', + text: '&#160;', + handler: function() + { + _this.collapse(); + _this.clearValue(); + _this.onSelect(false, -1); + } + }); + } + if (this.footer) { + this.assetHeight += this.footer.getHeight(); + } + + + if(!this.tpl){ + this.tpl = '<div class="'+cls+'-item">{' + this.displayField + '}</div>'; + } + + this.view = new Roo.View(this.innerList, this.tpl, { + singleSelect:true, store: this.store, selectedClass: this.selectedClass + }); + + this.view.on('click', this.onViewClick, this); + + this.store.on('beforeload', this.onBeforeLoad, this); + this.store.on('load', this.onLoad, this); + this.store.on('loadexception', this.onLoadException, this); + + if(this.resizable){ + this.resizer = new Roo.Resizable(this.list, { + pinned:true, handles:'se' + }); + this.resizer.on('resize', function(r, w, h){ + this.maxHeight = h-this.handleHeight-this.list.getFrameWidth('tb')-this.assetHeight; + this.listWidth = w; + this.innerList.setWidth(w - this.list.getFrameWidth('lr')); + this.restrictHeight(); + }, this); + this[this.pageSize?'footer':'innerList'].setStyle('margin-bottom', this.handleHeight+'px'); + } + if(!this.editable){ + this.editable = true; + this.setEditable(false); + } + + + if (typeof(this.events.add.listeners) != 'undefined') { + + this.addicon = this.wrap.createChild( + {tag: 'img', src: Roo.BLANK_IMAGE_URL, cls: 'x-form-combo-add' }); + + this.addicon.on('click', function(e) { + this.fireEvent('add', this); + }, this); + } + if (typeof(this.events.edit.listeners) != 'undefined') { + + this.editicon = this.wrap.createChild( + {tag: 'img', src: Roo.BLANK_IMAGE_URL, cls: 'x-form-combo-edit' }); + if (this.addicon) { + this.editicon.setStyle('margin-left', '40px'); + } + this.editicon.on('click', function(e) { + + // we fire even if inothing is selected.. + this.fireEvent('edit', this, this.lastData ); + + }, this); + } + + + + }, + + // private + initEvents : function(){ + Roo.form.ComboBox.superclass.initEvents.call(this); + + this.keyNav = new Roo.KeyNav(this.el, { + "up" : function(e){ + this.inKeyMode = true; + this.selectPrev(); + }, + + "down" : function(e){ + if(!this.isExpanded()){ + this.onTriggerClick(); + }else{ + this.inKeyMode = true; + this.selectNext(); + } + }, + + "enter" : function(e){ + this.onViewClick(); + //return true; + }, + + "esc" : function(e){ + this.collapse(); + }, + + "tab" : function(e){ + this.onViewClick(false); + this.fireEvent("specialkey", this, e); + return true; + }, + + scope : this, + + doRelay : function(foo, bar, hname){ + if(hname == 'down' || this.scope.isExpanded()){ + return Roo.KeyNav.prototype.doRelay.apply(this, arguments); + } + return true; + }, + + forceKeyDown: true + }); + this.queryDelay = Math.max(this.queryDelay || 10, + this.mode == 'local' ? 10 : 250); + this.dqTask = new Roo.util.DelayedTask(this.initQuery, this); + if(this.typeAhead){ + this.taTask = new Roo.util.DelayedTask(this.onTypeAhead, this); + } + if(this.editable !== false){ + this.el.on("keyup", this.onKeyUp, this); + } + if(this.forceSelection){ + this.on('blur', this.doForce, this); + } + }, + + onDestroy : function(){ + if(this.view){ + this.view.setStore(null); + this.view.el.removeAllListeners(); + this.view.el.remove(); + this.view.purgeListeners(); + } + if(this.list){ + this.list.destroy(); + } + if(this.store){ + this.store.un('beforeload', this.onBeforeLoad, this); + this.store.un('load', this.onLoad, this); + this.store.un('loadexception', this.onLoadException, this); + } + Roo.form.ComboBox.superclass.onDestroy.call(this); + }, + + // private + fireKey : function(e){ + if(e.isNavKeyPress() && !this.list.isVisible()){ + this.fireEvent("specialkey", this, e); + } + }, + + // private + onResize: function(w, h){ + Roo.form.ComboBox.superclass.onResize.apply(this, arguments); + + if(typeof w != 'number'){ + // we do not handle it!?!? + return; + } + var tw = this.trigger.getWidth(); + tw += this.addicon ? this.addicon.getWidth() : 0; + tw += this.editicon ? this.editicon.getWidth() : 0; + var x = w - tw; + this.el.setWidth( this.adjustWidth('input', x)); + + this.trigger.setStyle('left', x+'px'); + + if(this.list && this.listWidth === undefined){ + var lw = Math.max(x + this.trigger.getWidth(), this.minListWidth); + this.list.setWidth(lw); + this.innerList.setWidth(lw - this.list.getFrameWidth('lr')); + } + + + + }, + + /** + * Allow or prevent the user from directly editing the field text. If false is passed, + * the user will only be able to select from the items defined in the dropdown list. This method + * is the runtime equivalent of setting the 'editable' config option at config time. + * @param {Boolean} value True to allow the user to directly edit the field text + */ + setEditable : function(value){ + if(value == this.editable){ + return; + } + this.editable = value; + if(!value){ + this.el.dom.setAttribute('readOnly', true); + this.el.on('mousedown', this.onTriggerClick, this); + this.el.addClass('x-combo-noedit'); + }else{ + this.el.dom.setAttribute('readOnly', false); + this.el.un('mousedown', this.onTriggerClick, this); + this.el.removeClass('x-combo-noedit'); + } + }, + + // private + onBeforeLoad : function(){ + if(!this.hasFocus){ + return; + } + this.innerList.update(this.loadingText ? + '<div class="loading-indicator">'+this.loadingText+'</div>' : ''); + this.restrictHeight(); + this.selectedIndex = -1; + }, + + // private + onLoad : function(){ + if(!this.hasFocus){ + return; + } + if(this.store.getCount() > 0){ + this.expand(); + this.restrictHeight(); + if(this.lastQuery == this.allQuery){ + if(this.editable){ + this.el.dom.select(); + } + if(!this.selectByValue(this.value, true)){ + this.select(0, true); + } + }else{ + this.selectNext(); + if(this.typeAhead && this.lastKey != Roo.EventObject.BACKSPACE && this.lastKey != Roo.EventObject.DELETE){ + this.taTask.delay(this.typeAheadDelay); + } + } + }else{ + this.onEmptyResults(); + } + //this.el.focus(); + }, + // private + onLoadException : function() + { + this.collapse(); + Roo.log(this.store.reader.jsonData); + if (this.store && typeof(this.store.reader.jsonData.errorMsg) != 'undefined') { + Roo.MessageBox.alert("Error loading",this.store.reader.jsonData.errorMsg); + } + + + }, + // private + onTypeAhead : function(){ + if(this.store.getCount() > 0){ + var r = this.store.getAt(0); + var newValue = r.data[this.displayField]; + var len = newValue.length; + var selStart = this.getRawValue().length; + if(selStart != len){ + this.setRawValue(newValue); + this.selectText(selStart, newValue.length); + } + } + }, + + // private + onSelect : function(record, index){ + if(this.fireEvent('beforeselect', this, record, index) !== false){ + this.setFromData(index > -1 ? record.data : false); + this.collapse(); + this.fireEvent('select', this, record, index); + } + }, + + /** + * Returns the currently selected field value or empty string if no value is set. + * @return {String} value The selected value + */ + getValue : function(){ + if(this.valueField){ + return typeof this.value != 'undefined' ? this.value : ''; + } + return Roo.form.ComboBox.superclass.getValue.call(this); + }, + + /** + * Clears any text/value currently set in the field + */ + clearValue : function(){ + if(this.hiddenField){ + this.hiddenField.value = ''; + } + this.value = ''; + this.setRawValue(''); + this.lastSelectionText = ''; + + }, + + /** + * Sets the specified value into the field. If the value finds a match, the corresponding record text + * will be displayed in the field. If the value does not match the data value of an existing item, + * and the valueNotFoundText config option is defined, it will be displayed as the default field text. + * Otherwise the field will be blank (although the value will still be set). + * @param {String} value The value to match + */ + setValue : function(v){ + var text = v; + if(this.valueField){ + var r = this.findRecord(this.valueField, v); + if(r){ + text = r.data[this.displayField]; + }else if(this.valueNotFoundText !== undefined){ + text = this.valueNotFoundText; + } + } + this.lastSelectionText = text; + if(this.hiddenField){ + this.hiddenField.value = v; + } + Roo.form.ComboBox.superclass.setValue.call(this, text); + this.value = v; + }, + /** + * @property {Object} the last set data for the element + */ + + lastData : false, + /** + * Sets the value of the field based on a object which is related to the record format for the store. + * @param {Object} value the value to set as. or false on reset? + */ + setFromData : function(o){ + var dv = ''; // display value + var vv = ''; // value value.. + this.lastData = o; + if (this.displayField) { + dv = !o || typeof(o[this.displayField]) == 'undefined' ? '' : o[this.displayField]; + } else { + // this is an error condition!!! + Roo.log('no displayField value set for '+ (this.name ? this.name : this.id)); + } + + if(this.valueField){ + vv = !o || typeof(o[this.valueField]) == 'undefined' ? dv : o[this.valueField]; + } + if(this.hiddenField){ + this.hiddenField.value = vv; + + this.lastSelectionText = dv; + Roo.form.ComboBox.superclass.setValue.call(this, dv); + this.value = vv; + return; + } + // no hidden field.. - we store the value in 'value', but still display + // display field!!!! + this.lastSelectionText = dv; + Roo.form.ComboBox.superclass.setValue.call(this, dv); + this.value = vv; + + + }, + // private + reset : function(){ + // overridden so that last data is reset.. + this.setValue(this.resetValue); + this.originalValue = this.getValue(); + this.clearInvalid(); + this.lastData = false; + if (this.view) { + this.view.clearSelections(); + } + }, + // private + findRecord : function(prop, value){ + var record; + if(this.store.getCount() > 0){ + this.store.each(function(r){ + if(r.data[prop] == value){ + record = r; + return false; + } + return true; + }); + } + return record; + }, + + getName: function() + { + // returns hidden if it's set.. + if (!this.rendered) {return ''}; + return !this.hiddenName && this.el.dom.name ? this.el.dom.name : (this.hiddenName || ''); + + }, + // private + onViewMove : function(e, t){ + this.inKeyMode = false; + }, + + // private + onViewOver : function(e, t){ + if(this.inKeyMode){ // prevent key nav and mouse over conflicts + return; + } + var item = this.view.findItemFromChild(t); + if(item){ + var index = this.view.indexOf(item); + this.select(index, false); + } + }, + + // private + onViewClick : function(doFocus) + { + var index = this.view.getSelectedIndexes()[0]; + var r = this.store.getAt(index); + if(r){ + this.onSelect(r, index); + } + if(doFocus !== false && !this.blockFocus){ + this.el.focus(); + } + }, + + // private + restrictHeight : function(){ + this.innerList.dom.style.height = ''; + var inner = this.innerList.dom; + var h = Math.max(inner.clientHeight, inner.offsetHeight, inner.scrollHeight); + this.innerList.setHeight(h < this.maxHeight ? 'auto' : this.maxHeight); + this.list.beginUpdate(); + this.list.setHeight(this.innerList.getHeight()+this.list.getFrameWidth('tb')+(this.resizable?this.handleHeight:0)+this.assetHeight); + this.list.alignTo(this.el, this.listAlign); + this.list.endUpdate(); + }, + + // private + onEmptyResults : function(){ + this.collapse(); + }, + + /** + * Returns true if the dropdown list is expanded, else false. + */ + isExpanded : function(){ + return this.list.isVisible(); + }, + + /** + * Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire. + * The store must be loaded and the list expanded for this function to work, otherwise use setValue. + * @param {String} value The data value of the item to select + * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the + * selected item if it is not currently in view (defaults to true) + * @return {Boolean} True if the value matched an item in the list, else false + */ + selectByValue : function(v, scrollIntoView){ + if(v !== undefined && v !== null){ + var r = this.findRecord(this.valueField || this.displayField, v); + if(r){ + this.select(this.store.indexOf(r), scrollIntoView); + return true; + } + } + return false; + }, + + /** + * Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire. + * The store must be loaded and the list expanded for this function to work, otherwise use setValue. + * @param {Number} index The zero-based index of the list item to select + * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the + * selected item if it is not currently in view (defaults to true) + */ + select : function(index, scrollIntoView){ + this.selectedIndex = index; + this.view.select(index); + if(scrollIntoView !== false){ + var el = this.view.getNode(index); + if(el){ + this.innerList.scrollChildIntoView(el, false); + } + } + }, + + // private + selectNext : function(){ + var ct = this.store.getCount(); + if(ct > 0){ + if(this.selectedIndex == -1){ + this.select(0); + }else if(this.selectedIndex < ct-1){ + this.select(this.selectedIndex+1); + } + } + }, + + // private + selectPrev : function(){ + var ct = this.store.getCount(); + if(ct > 0){ + if(this.selectedIndex == -1){ + this.select(0); + }else if(this.selectedIndex != 0){ + this.select(this.selectedIndex-1); + } + } + }, + + // private + onKeyUp : function(e){ + if(this.editable !== false && !e.isSpecialKey()){ + this.lastKey = e.getKey(); + this.dqTask.delay(this.queryDelay); + } + }, + + // private + validateBlur : function(){ + return !this.list || !this.list.isVisible(); + }, + + // private + initQuery : function(){ + this.doQuery(this.getRawValue()); + }, + + // private + doForce : function(){ + if(this.el.dom.value.length > 0){ + this.el.dom.value = + this.lastSelectionText === undefined ? '' : this.lastSelectionText; + + } + }, + + /** + * Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the + * query allowing the query action to be canceled if needed. + * @param {String} query The SQL query to execute + * @param {Boolean} forceAll True to force the query to execute even if there are currently fewer characters + * in the field than the minimum specified by the minChars config option. It also clears any filter previously + * saved in the current store (defaults to false) + */ + doQuery : function(q, forceAll){ + if(q === undefined || q === null){ + q = ''; + } + var qe = { + query: q, + forceAll: forceAll, + combo: this, + cancel:false + }; + if(this.fireEvent('beforequery', qe)===false || qe.cancel){ + return false; + } + q = qe.query; + forceAll = qe.forceAll; + if(forceAll === true || (q.length >= this.minChars)){ + if(this.lastQuery != q || this.alwaysQuery){ + this.lastQuery = q; + if(this.mode == 'local'){ + this.selectedIndex = -1; + if(forceAll){ + this.store.clearFilter(); + }else{ + this.store.filter(this.displayField, q); + } + this.onLoad(); + }else{ + this.store.baseParams[this.queryParam] = q; + this.store.load({ + params: this.getParams(q) + }); + this.expand(); + } + }else{ + this.selectedIndex = -1; + this.onLoad(); + } + } + }, + + // private + getParams : function(q){ + var p = {}; + //p[this.queryParam] = q; + if(this.pageSize){ + p.start = 0; + p.limit = this.pageSize; + } + return p; + }, + + /** + * Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion. + */ + collapse : function(){ + if(!this.isExpanded()){ + return; + } + this.list.hide(); + Roo.get(document).un('mousedown', this.collapseIf, this); + Roo.get(document).un('mousewheel', this.collapseIf, this); + if (!this.editable) { + Roo.get(document).un('keydown', this.listKeyPress, this); + } + this.fireEvent('collapse', this); + }, + + // private + collapseIf : function(e){ + if(!e.within(this.wrap) && !e.within(this.list)){ + this.collapse(); + } + }, + + /** + * Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion. + */ + expand : function(){ + if(this.isExpanded() || !this.hasFocus){ + return; + } + this.list.alignTo(this.el, this.listAlign); + this.list.show(); + Roo.get(document).on('mousedown', this.collapseIf, this); + Roo.get(document).on('mousewheel', this.collapseIf, this); + if (!this.editable) { + Roo.get(document).on('keydown', this.listKeyPress, this); + } + + this.fireEvent('expand', this); + }, + + // private + // Implements the default empty TriggerField.onTriggerClick function + onTriggerClick : function(){ + if(this.disabled){ + return; + } + if(this.isExpanded()){ + this.collapse(); + if (!this.blockFocus) { + this.el.focus(); + } + + }else { + this.hasFocus = true; + if(this.triggerAction == 'all') { + this.doQuery(this.allQuery, true); + } else { + this.doQuery(this.getRawValue()); + } + if (!this.blockFocus) { + this.el.focus(); + } + } + }, + listKeyPress : function(e) + { + //Roo.log('listkeypress'); + // scroll to first matching element based on key pres.. + if (e.isSpecialKey()) { + return false; + } + var k = String.fromCharCode(e.getKey()).toUpperCase(); + //Roo.log(k); + var match = false; + var csel = this.view.getSelectedNodes(); + var cselitem = false; + if (csel.length) { + var ix = this.view.indexOf(csel[0]); + cselitem = this.store.getAt(ix); + if (!cselitem.get(this.displayField) || cselitem.get(this.displayField).substring(0,1).toUpperCase() != k) { + cselitem = false; + } + + } + + this.store.each(function(v) { + if (cselitem) { + // start at existing selection. + if (cselitem.id == v.id) { + cselitem = false; + } + return; + } + + if (v.get(this.displayField) && v.get(this.displayField).substring(0,1).toUpperCase() == k) { + match = this.store.indexOf(v); + return false; + } + }, this); + + if (match === false) { + return true; // no more action? + } + // scroll to? + this.view.select(match); + var sn = Roo.get(this.view.getSelectedNodes()[0]); + sn.scrollIntoView(sn.dom.parentNode, false); + } + + /** + * @cfg {Boolean} grow + * @hide + */ + /** + * @cfg {Number} growMin + * @hide + */ + /** + * @cfg {Number} growMax + * @hide + */ + /** + * @hide + * @method autoSize + */ +}); \ No newline at end of file diff --git a/docs2/src/Roo_form_ComboBoxArray.js.html b/docs2/src/Roo_form_ComboBoxArray.js.html new file mode 100644 index 0000000000..6becb15f28 --- /dev/null +++ b/docs2/src/Roo_form_ComboBoxArray.js.html @@ -0,0 +1,484 @@ +/home/alan/gitlive/roojs1/Roo/form/ComboBoxArray.js/* + * Copyright(c) 2010-2012, Roo J Solutions Limited + * + * Licence LGPL + * + */ + +/** + * @class Roo.form.ComboBoxArray + * @extends Roo.form.TextField + * A facebook style adder... for lists of email / people / countries etc... + * pick multiple items from a combo box, and shows each one. + * + * Fred [x] Brian [x] [Pick another |v] + * + * + * For this to work: it needs various extra information + * - normal combo problay has + * name, hiddenName + * + displayField, valueField + * + * For our purpose... + * + * + * If we change from 'extends' to wrapping... + * + * + * + + + * @constructor + * Create a new ComboBoxArray. + * @param {Object} config Configuration options + */ + + +Roo.form.ComboBoxArray = function(config) +{ + this.addEvents({ + /** + * @event beforeremove + * Fires before remove the value from the list + * @param {Roo.form.ComboBoxArray} _self This combo box array + * @param {Roo.form.ComboBoxArray.Item} item removed item + */ + 'beforeremove' : true, + /** + * @event remove + * Fires when remove the value from the list + * @param {Roo.form.ComboBoxArray} _self This combo box array + * @param {Roo.form.ComboBoxArray.Item} item removed item + */ + 'remove' : true + + + }); + + Roo.form.ComboBoxArray.superclass.constructor.call(this, config); + + this.items = new Roo.util.MixedCollection(false); + + // construct the child combo... + + + + + + +} + + +Roo.extend(Roo.form.ComboBoxArray, Roo.form.TextField, +{ + /** + * @cfg {Roo.form.Combo} combo The combo box that is wrapped + */ + + lastData : false, + + // behavies liek a hiddne field + inputType: 'hidden', + /** + * @cfg {Number} width The width of the box that displays the selected element + */ + width: 300, + + + + /** + * @cfg {String} name The name of the visable items on this form (eg. titles not ids) + */ + name : false, + /** + * @cfg {String} hiddenName The hidden name of the field, often contains an comma seperated list of names + */ + hiddenName : false, + + + // private the array of items that are displayed.. + items : false, + // private - the hidden field el. + hiddenEl : false, + // private - the filed el.. + el : false, + + //validateValue : function() { return true; }, // all values are ok! + //onAddClick: function() { }, + + onRender : function(ct, position) + { + + // create the standard hidden element + //Roo.form.ComboBoxArray.superclass.onRender.call(this, ct, position); + + + // give fake names to child combo; + this.combo.hiddenName = this.hiddenName ? (this.hiddenName+'-subcombo') : this.hiddenName; + this.combo.name = this.name? (this.name+'-subcombo') : this.name; + + this.combo = Roo.factory(this.combo, Roo.form); + this.combo.onRender(ct, position); + if (typeof(this.combo.width) != 'undefined') { + this.combo.onResize(this.combo.width,0); + } + + this.combo.initEvents(); + + // assigned so form know we need to do this.. + this.store = this.combo.store; + this.valueField = this.combo.valueField; + this.displayField = this.combo.displayField ; + + + this.combo.wrap.addClass('x-cbarray-grp'); + + var cbwrap = this.combo.wrap.createChild( + {tag: 'div', cls: 'x-cbarray-cb'}, + this.combo.el.dom + ); + + + this.hiddenEl = this.combo.wrap.createChild({ + tag: 'input', type:'hidden' , name: this.hiddenName, value : '' + }); + this.el = this.combo.wrap.createChild({ + tag: 'input', type:'hidden' , name: this.name, value : '' + }); + // this.el.dom.removeAttribute("name"); + + + this.outerWrap = this.combo.wrap; + this.wrap = cbwrap; + + this.outerWrap.setWidth(this.width); + this.outerWrap.dom.removeChild(this.el.dom); + + this.wrap.dom.appendChild(this.el.dom); + this.outerWrap.dom.removeChild(this.combo.trigger.dom); + this.combo.wrap.dom.appendChild(this.combo.trigger.dom); + + this.combo.trigger.setStyle('position','relative'); + this.combo.trigger.setStyle('left', '0px'); + this.combo.trigger.setStyle('top', '2px'); + + this.combo.el.setStyle('vertical-align', 'text-bottom'); + + //this.trigger.setStyle('vertical-align', 'top'); + + // this should use the code from combo really... on('add' ....) + if (this.adder) { + + + this.adder = this.outerWrap.createChild( + {tag: 'img', src: Roo.BLANK_IMAGE_URL, cls: 'x-form-adder', style: 'margin-left:2px'}); + var _t = this; + this.adder.on('click', function(e) { + _t.fireEvent('adderclick', this, e); + }, _t); + } + //var _t = this; + //this.adder.on('click', this.onAddClick, _t); + + + this.combo.on('select', function(cb, rec, ix) { + this.addItem(rec.data); + + cb.setValue(''); + cb.el.dom.value = ''; + //cb.lastData = rec.data; + // add to list + + }, this); + + + }, + + + getName: function() + { + // returns hidden if it's set.. + if (!this.rendered) {return ''}; + return this.hiddenName ? this.hiddenName : this.name; + + }, + + + onResize: function(w, h){ + + return; + // not sure if this is needed.. + //this.combo.onResize(w,h); + + if(typeof w != 'number'){ + // we do not handle it!?!? + return; + } + var tw = this.combo.trigger.getWidth(); + tw += this.addicon ? this.addicon.getWidth() : 0; + tw += this.editicon ? this.editicon.getWidth() : 0; + var x = w - tw; + this.combo.el.setWidth( this.combo.adjustWidth('input', x)); + + this.combo.trigger.setStyle('left', '0px'); + + if(this.list && this.listWidth === undefined){ + var lw = Math.max(x + this.combo.trigger.getWidth(), this.combo.minListWidth); + this.list.setWidth(lw); + this.innerList.setWidth(lw - this.list.getFrameWidth('lr')); + } + + + + }, + + addItem: function(rec) + { + var valueField = this.combo.valueField; + var displayField = this.combo.displayField; + if (this.items.indexOfKey(rec[valueField]) > -1) { + //console.log("GOT " + rec.data.id); + return; + } + + var x = new Roo.form.ComboBoxArray.Item({ + //id : rec[this.idField], + data : rec, + displayField : displayField , + tipField : displayField , + cb : this + }); + // use the + this.items.add(rec[valueField],x); + // add it before the element.. + this.updateHiddenEl(); + x.render(this.outerWrap, this.wrap.dom); + // add the image handler.. + }, + + updateHiddenEl : function() + { + this.validate(); + if (!this.hiddenEl) { + return; + } + var ar = []; + var idField = this.combo.valueField; + + this.items.each(function(f) { + ar.push(f.data[idField]); + + }); + this.hiddenEl.dom.value = ar.join(','); + this.validate(); + }, + + reset : function() + { + this.items.clear(); + + Roo.each(this.outerWrap.select('.x-cbarray-item', true).elements, function(el){ + el.remove(); + }); + + this.el.dom.value = ''; + if (this.hiddenEl) { + this.hiddenEl.dom.value = ''; + } + + }, + getValue: function() + { + return this.hiddenEl ? this.hiddenEl.dom.value : ''; + }, + setValue: function(v) // not a valid action - must use addItems.. + { + + this.reset(); + + + + if (this.store.isLocal && (typeof(v) == 'string')) { + // then we can use the store to find the values.. + // comma seperated at present.. this needs to allow JSON based encoding.. + this.hiddenEl.value = v; + var v_ar = []; + Roo.each(v.split(','), function(k) { + Roo.log("CHECK " + this.valueField + ',' + k); + var li = this.store.query(this.valueField, k); + if (!li.length) { + return; + } + var add = {}; + add[this.valueField] = k; + add[this.displayField] = li.item(0).data[this.displayField]; + + this.addItem(add); + }, this) + + } + if (typeof(v) == 'object' ) { + // then let's assume it's an array of objects.. + Roo.each(v, function(l) { + this.addItem(l); + }, this); + + } + + + }, + setFromData: function(v) + { + // this recieves an object, if setValues is called. + this.reset(); + this.el.dom.value = v[this.displayField]; + this.hiddenEl.dom.value = v[this.valueField]; + if (typeof(v[this.valueField]) != 'string' || !v[this.valueField].length) { + return; + } + var kv = v[this.valueField]; + var dv = v[this.displayField]; + kv = typeof(kv) != 'string' ? '' : kv; + dv = typeof(dv) != 'string' ? '' : dv; + + + var keys = kv.split(','); + var display = dv.split(','); + for (var i = 0 ; i < keys.length; i++) { + + add = {}; + add[this.valueField] = keys[i]; + add[this.displayField] = display[i]; + this.addItem(add); + } + + + }, + + /** + * Validates the combox array value + * @return {Boolean} True if the value is valid, else false + */ + validate : function(){ + if(this.disabled || this.validateValue(this.processValue(this.getValue()))){ + this.clearInvalid(); + return true; + } + return false; + }, + + validateValue : function(value){ + return Roo.form.ComboBoxArray.superclass.validateValue.call(this, this.getValue()); + + }, + + /*@ + * overide + * + */ + isDirty : function() { + if(this.disabled) { + return false; + } + + try { + var d = Roo.decode(String(this.originalValue)); + } catch (e) { + return String(this.getValue()) !== String(this.originalValue); + } + + var originalValue = []; + + for (var i = 0; i < d.length; i++){ + originalValue.push(d[i][this.valueField]); + } + + return String(this.getValue()) !== String(originalValue.join(',')); + + } + +}); + + + +/** + * @class Roo.form.ComboBoxArray.Item + * @extends Roo.BoxComponent + * A selected item in the list + * Fred [x] Brian [x] [Pick another |v] + * + * @constructor + * Create a new item. + * @param {Object} config Configuration options + */ + +Roo.form.ComboBoxArray.Item = function(config) { + config.id = Roo.id(); + Roo.form.ComboBoxArray.Item.superclass.constructor.call(this, config); +} + +Roo.extend(Roo.form.ComboBoxArray.Item, Roo.BoxComponent, { + data : {}, + cb: false, + displayField : false, + tipField : false, + + + defaultAutoCreate : { + tag: 'div', + cls: 'x-cbarray-item', + cn : [ + { tag: 'div' }, + { + tag: 'img', + width:16, + height : 16, + src : Roo.BLANK_IMAGE_URL , + align: 'center' + } + ] + + }, + + + onRender : function(ct, position) + { + Roo.form.Field.superclass.onRender.call(this, ct, position); + + if(!this.el){ + var cfg = this.getAutoCreate(); + this.el = ct.createChild(cfg, position); + } + + this.el.child('img').dom.setAttribute('src', Roo.BLANK_IMAGE_URL); + + this.el.child('div').dom.innerHTML = this.cb.renderer ? + this.cb.renderer(this.data) : + String.format('{0}',this.data[this.displayField]); + + + this.el.child('div').dom.setAttribute('qtip', + String.format('{0}',this.data[this.tipField]) + ); + + this.el.child('img').on('click', this.remove, this); + + }, + + remove : function() + { + if(this.cb.disabled){ + return; + } + + if(false !== this.cb.fireEvent('beforeremove', this.cb, this)){ + this.cb.items.remove(this); + this.el.child('img').un('click', this.remove, this); + this.el.remove(); + this.cb.updateHiddenEl(); + + this.cb.fireEvent('remove', this.cb, this); + } + + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_form_ComboCheck.js.html b/docs2/src/Roo_form_ComboCheck.js.html new file mode 100644 index 0000000000..424d8570f5 --- /dev/null +++ b/docs2/src/Roo_form_ComboCheck.js.html @@ -0,0 +1,192 @@ +/home/alan/gitlive/roojs1/Roo/form/ComboCheck.js/* + * RooJS Library 1.1.1 + * Copyright(c) 2008-2011 Alan Knowles + * + * License - LGPL + */ + + +/** + * @class Roo.form.ComboCheck + * @extends Roo.form.ComboBox + * A combobox for multiple select items. + * + * FIXME - could do with a reset button.. + * + * @constructor + * Create a new ComboCheck + * @param {Object} config Configuration options + */ +Roo.form.ComboCheck = function(config){ + Roo.form.ComboCheck.superclass.constructor.call(this, config); + // should verify some data... + // like + // hiddenName = required.. + // displayField = required + // valudField == required + var req= [ 'hiddenName', 'displayField', 'valueField' ]; + var _t = this; + Roo.each(req, function(e) { + if ((typeof(_t[e]) == 'undefined' ) || !_t[e].length) { + throw "Roo.form.ComboCheck : missing value for: " + e; + } + }); + + +}; + +Roo.extend(Roo.form.ComboCheck, Roo.form.ComboBox, { + + + editable : false, + + selectedClass: 'x-menu-item-checked', + + // private + onRender : function(ct, position){ + var _t = this; + + + + if(!this.tpl){ + var cls = 'x-combo-list'; + + + this.tpl = new Roo.Template({ + html : '<div class="'+cls+'-item x-menu-check-item">' + + '<img class="x-menu-item-icon" style="margin: 0px;" src="' + Roo.BLANK_IMAGE_URL + '">' + + '<span>{' + this.displayField + '}</span>' + + '</div>' + + }); + } + + + Roo.form.ComboCheck.superclass.onRender.call(this, ct, position); + this.view.singleSelect = false; + this.view.multiSelect = true; + this.view.toggleSelect = true; + this.pageTb.add(new Roo.Toolbar.Fill(), { + + text: 'Done', + handler: function() + { + _t.collapse(); + } + }); + }, + + onViewOver : function(e, t){ + // do nothing... + return; + + }, + + onViewClick : function(doFocus,index){ + return; + + }, + select: function () { + //Roo.log("SELECT CALLED"); + }, + + selectByValue : function(xv, scrollIntoView){ + var ar = this.getValueArray(); + var sels = []; + + Roo.each(ar, function(v) { + if(v === undefined || v === null){ + return; + } + var r = this.findRecord(this.valueField, v); + if(r){ + sels.push(this.store.indexOf(r)) + + } + },this); + this.view.select(sels); + return false; + }, + + + + onSelect : function(record, index){ + // Roo.log("onselect Called"); + // this is only called by the clear button now.. + this.view.clearSelections(); + this.setValue('[]'); + if (this.value != this.valueBefore) { + this.fireEvent('change', this, this.value, this.valueBefore); + this.valueBefore = this.value; + } + }, + getValueArray : function() + { + var ar = [] ; + + try { + //Roo.log(this.value); + if (typeof(this.value) == 'undefined') { + return []; + } + var ar = Roo.decode(this.value); + return ar instanceof Array ? ar : []; //?? valid? + + } catch(e) { + Roo.log(e + "\nRoo.form.ComboCheck:getValueArray invalid data:" + this.getValue()); + return []; + } + + }, + expand : function () + { + + Roo.form.ComboCheck.superclass.expand.call(this); + this.valueBefore = typeof(this.value) == 'undefined' ? '' : this.value; + //this.valueBefore = typeof(this.valueBefore) == 'undefined' ? '' : this.valueBefore; + + + }, + + collapse : function(){ + Roo.form.ComboCheck.superclass.collapse.call(this); + var sl = this.view.getSelectedIndexes(); + var st = this.store; + var nv = []; + var tv = []; + var r; + Roo.each(sl, function(i) { + r = st.getAt(i); + nv.push(r.get(this.valueField)); + },this); + this.setValue(Roo.encode(nv)); + if (this.value != this.valueBefore) { + + this.fireEvent('change', this, this.value, this.valueBefore); + this.valueBefore = this.value; + } + + }, + + setValue : function(v){ + // Roo.log(v); + this.value = v; + + var vals = this.getValueArray(); + var tv = []; + Roo.each(vals, function(k) { + var r = this.findRecord(this.valueField, k); + if(r){ + tv.push(r.data[this.displayField]); + }else if(this.valueNotFoundText !== undefined){ + tv.push( this.valueNotFoundText ); + } + },this); + // Roo.log(tv); + + Roo.form.ComboBox.superclass.setValue.call(this, tv.join(', ')); + this.hiddenField.value = v; + this.value = v; + } + +}); \ No newline at end of file diff --git a/docs2/src/Roo_form_DateField.js.html b/docs2/src/Roo_form_DateField.js.html new file mode 100644 index 0000000000..d5a92767a5 --- /dev/null +++ b/docs2/src/Roo_form_DateField.js.html @@ -0,0 +1,369 @@ +/home/alan/gitlive/roojs1/Roo/form/DateField.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.form.DateField + * @extends Roo.form.TriggerField + * Provides a date input field with a {@link Roo.DatePicker} dropdown and automatic date validation. +* @constructor +* Create a new DateField +* @param {Object} config + */ +Roo.form.DateField = function(config){ + Roo.form.DateField.superclass.constructor.call(this, config); + + this.addEvents({ + + /** + * @event select + * Fires when a date is selected + * @param {Roo.form.DateField} combo This combo box + * @param {Date} date The date selected + */ + 'select' : true + + }); + + + if(typeof this.minValue == "string") { + this.minValue = this.parseDate(this.minValue); + } + if(typeof this.maxValue == "string") { + this.maxValue = this.parseDate(this.maxValue); + } + this.ddMatch = null; + if(this.disabledDates){ + var dd = this.disabledDates; + var re = "(?:"; + for(var i = 0; i < dd.length; i++){ + re += dd[i]; + if(i != dd.length-1) { + re += "|"; + } + } + this.ddMatch = new RegExp(re + ")"); + } +}; + +Roo.extend(Roo.form.DateField, Roo.form.TriggerField, { + /** + * @cfg {String} format + * The default date format string which can be overriden for localization support. The format must be + * valid according to {@link Date#parseDate} (defaults to 'm/d/y'). + */ + format : "m/d/y", + /** + * @cfg {String} altFormats + * Multiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined + * format (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d'). + */ + altFormats : "m/d/Y|m-d-y|m-d-Y|m/d|m-d|md|mdy|mdY|d", + /** + * @cfg {Array} disabledDays + * An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null). + */ + disabledDays : null, + /** + * @cfg {String} disabledDaysText + * The tooltip to display when the date falls on a disabled day (defaults to 'Disabled') + */ + disabledDaysText : "Disabled", + /** + * @cfg {Array} disabledDates + * An array of "dates" to disable, as strings. These strings will be used to build a dynamic regular + * expression so they are very powerful. Some examples: + * <ul> + * <li>["03/08/2003", "09/16/2003"] would disable those exact dates</li> + * <li>["03/08", "09/16"] would disable those days for every year</li> + * <li>["^03/08"] would only match the beginning (useful if you are using short years)</li> + * <li>["03/../2006"] would disable every day in March 2006</li> + * <li>["^03"] would disable every day in every March</li> + * </ul> + * In order to support regular expressions, if you are using a date format that has "." in it, you will have to + * escape the dot when restricting dates. For example: ["03\\.08\\.03"]. + */ + disabledDates : null, + /** + * @cfg {String} disabledDatesText + * The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled') + */ + disabledDatesText : "Disabled", + /** + * @cfg {Date/String} minValue + * The minimum allowed date. Can be either a Javascript date object or a string date in a + * valid format (defaults to null). + */ + minValue : null, + /** + * @cfg {Date/String} maxValue + * The maximum allowed date. Can be either a Javascript date object or a string date in a + * valid format (defaults to null). + */ + maxValue : null, + /** + * @cfg {String} minText + * The error text to display when the date in the cell is before minValue (defaults to + * 'The date in this field must be after {minValue}'). + */ + minText : "The date in this field must be equal to or after {0}", + /** + * @cfg {String} maxText + * The error text to display when the date in the cell is after maxValue (defaults to + * 'The date in this field must be before {maxValue}'). + */ + maxText : "The date in this field must be equal to or before {0}", + /** + * @cfg {String} invalidText + * The error text to display when the date in the field is invalid (defaults to + * '{value} is not a valid date - it must be in the format {format}'). + */ + invalidText : "{0} is not a valid date - it must be in the format {1}", + /** + * @cfg {String} triggerClass + * An additional CSS class used to style the trigger button. The trigger will always get the + * class 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-date-trigger' + * which displays a calendar icon). + */ + triggerClass : 'x-form-date-trigger', + + + /** + * @cfg {Boolean} useIso + * if enabled, then the date field will use a hidden field to store the + * real value as iso formated date. default (false) + */ + useIso : false, + /** + * @cfg {String/Object} autoCreate + * A DomHelper element spec, or true for a default element spec (defaults to + * {tag: "input", type: "text", size: "10", autocomplete: "off"}) + */ + // private + defaultAutoCreate : {tag: "input", type: "text", size: "10", autocomplete: "off"}, + + // private + hiddenField: false, + + onRender : function(ct, position) + { + Roo.form.DateField.superclass.onRender.call(this, ct, position); + if (this.useIso) { + //this.el.dom.removeAttribute('name'); + Roo.log("Changing name?"); + this.el.dom.setAttribute('name', this.name + '____hidden___' ); + this.hiddenField = this.el.insertSibling({ tag:'input', type:'hidden', name: this.name }, + 'before', true); + this.hiddenField.value = this.value ? this.formatDate(this.value, 'Y-m-d') : ''; + // prevent input submission + this.hiddenName = this.name; + } + + + }, + + // private + validateValue : function(value) + { + value = this.formatDate(value); + if(!Roo.form.DateField.superclass.validateValue.call(this, value)){ + Roo.log('super failed'); + return false; + } + if(value.length < 1){ // if it's blank and textfield didn't flag it then it's valid + return true; + } + var svalue = value; + value = this.parseDate(value); + if(!value){ + Roo.log('parse date failed' + svalue); + this.markInvalid(String.format(this.invalidText, svalue, this.format)); + return false; + } + var time = value.getTime(); + if(this.minValue && time < this.minValue.getTime()){ + this.markInvalid(String.format(this.minText, this.formatDate(this.minValue))); + return false; + } + if(this.maxValue && time > this.maxValue.getTime()){ + this.markInvalid(String.format(this.maxText, this.formatDate(this.maxValue))); + return false; + } + if(this.disabledDays){ + var day = value.getDay(); + for(var i = 0; i < this.disabledDays.length; i++) { + if(day === this.disabledDays[i]){ + this.markInvalid(this.disabledDaysText); + return false; + } + } + } + var fvalue = this.formatDate(value); + if(this.ddMatch && this.ddMatch.test(fvalue)){ + this.markInvalid(String.format(this.disabledDatesText, fvalue)); + return false; + } + return true; + }, + + // private + // Provides logic to override the default TriggerField.validateBlur which just returns true + validateBlur : function(){ + return !this.menu || !this.menu.isVisible(); + }, + + getName: function() + { + // returns hidden if it's set.. + if (!this.rendered) {return ''}; + return !this.hiddenName && this.el.dom.name ? this.el.dom.name : (this.hiddenName || ''); + + }, + + /** + * Returns the current date value of the date field. + * @return {Date} The date value + */ + getValue : function(){ + + return this.hiddenField ? + this.hiddenField.value : + this.parseDate(Roo.form.DateField.superclass.getValue.call(this)) || ""; + }, + + /** + * Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid + * date, using DateField.format as the date format, according to the same rules as {@link Date#parseDate} + * (the default format used is "m/d/y"). + * <br />Usage: + * <pre><code> +//All of these calls set the same date value (May 4, 2006) + +//Pass a date object: +var dt = new Date('5/4/06'); +dateField.setValue(dt); + +//Pass a date string (default format): +dateField.setValue('5/4/06'); + +//Pass a date string (custom format): +dateField.format = 'Y-m-d'; +dateField.setValue('2006-5-4'); +</code></pre> + * @param {String/Date} date The date or valid date string + */ + setValue : function(date){ + if (this.hiddenField) { + this.hiddenField.value = this.formatDate(this.parseDate(date), 'Y-m-d'); + } + Roo.form.DateField.superclass.setValue.call(this, this.formatDate(this.parseDate(date))); + // make sure the value field is always stored as a date.. + this.value = this.parseDate(date); + + + }, + + // private + parseDate : function(value){ + if(!value || value instanceof Date){ + return value; + } + var v = Date.parseDate(value, this.format); + if (!v && this.useIso) { + v = Date.parseDate(value, 'Y-m-d'); + } + if(!v && this.altFormats){ + if(!this.altFormatsArray){ + this.altFormatsArray = this.altFormats.split("|"); + } + for(var i = 0, len = this.altFormatsArray.length; i < len && !v; i++){ + v = Date.parseDate(value, this.altFormatsArray[i]); + } + } + return v; + }, + + // private + formatDate : function(date, fmt){ + return (!date || !(date instanceof Date)) ? + date : date.dateFormat(fmt || this.format); + }, + + // private + menuListeners : { + select: function(m, d){ + + this.setValue(d); + this.fireEvent('select', this, d); + }, + show : function(){ // retain focus styling + this.onFocus(); + }, + hide : function(){ + this.focus.defer(10, this); + var ml = this.menuListeners; + this.menu.un("select", ml.select, this); + this.menu.un("show", ml.show, this); + this.menu.un("hide", ml.hide, this); + } + }, + + // private + // Implements the default empty TriggerField.onTriggerClick function to display the DatePicker + onTriggerClick : function(){ + if(this.disabled){ + return; + } + if(this.menu == null){ + this.menu = new Roo.menu.DateMenu(); + } + Roo.apply(this.menu.picker, { + showClear: this.allowBlank, + minDate : this.minValue, + maxDate : this.maxValue, + disabledDatesRE : this.ddMatch, + disabledDatesText : this.disabledDatesText, + disabledDays : this.disabledDays, + disabledDaysText : this.disabledDaysText, + format : this.useIso ? 'Y-m-d' : this.format, + minText : String.format(this.minText, this.formatDate(this.minValue)), + maxText : String.format(this.maxText, this.formatDate(this.maxValue)) + }); + this.menu.on(Roo.apply({}, this.menuListeners, { + scope:this + })); + this.menu.picker.setValue(this.getValue() || new Date()); + this.menu.show(this.el, "tl-bl?"); + }, + + beforeBlur : function(){ + var v = this.parseDate(this.getRawValue()); + if(v){ + this.setValue(v); + } + }, + + /*@ + * overide + * + */ + isDirty : function() { + if(this.disabled) { + return false; + } + + if(typeof(this.startValue) === 'undefined'){ + return false; + } + + return String(this.getValue()) !== String(this.startValue); + + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_form_DayPicker.js.html b/docs2/src/Roo_form_DayPicker.js.html new file mode 100644 index 0000000000..69bf1d1511 --- /dev/null +++ b/docs2/src/Roo_form_DayPicker.js.html @@ -0,0 +1,184 @@ +/home/alan/gitlive/roojs1/Roo/form/DayPicker.js/* + * + * Licence- LGPL + * + */ + +/** + * @class Roo.form.DayPicker + * @extends Roo.form.Field + * A Day picker show [M] [T] [W] .... + * @constructor + * Creates a new Day Picker + * @param {Object} config Configuration options + */ +Roo.form.DayPicker= function(config){ + Roo.form.DayPicker.superclass.constructor.call(this, config); + +}; + +Roo.extend(Roo.form.DayPicker, Roo.form.Field, { + /** + * @cfg {String} focusClass The CSS class to use when the checkbox receives focus (defaults to undefined) + */ + focusClass : undefined, + /** + * @cfg {String} fieldClass The default CSS class for the checkbox (defaults to "x-form-field") + */ + fieldClass: "x-form-field", + + /** + * @cfg {String/Object} autoCreate A DomHelper element spec, or true for a default element spec (defaults to + * {tag: "input", type: "checkbox", autocomplete: "off"}) + */ + defaultAutoCreate : { tag: "input", type: 'hidden', autocomplete: "new-password"}, + + + actionMode : 'viewEl', + // + // private + + inputType : 'hidden', + + + inputElement: false, // real input element? + basedOn: false, // ???? + + isFormField: true, // not sure where this is needed!!!! + + onResize : function(){ + Roo.form.Checkbox.superclass.onResize.apply(this, arguments); + if(!this.boxLabel){ + this.el.alignTo(this.wrap, 'c-c'); + } + }, + + initEvents : function(){ + Roo.form.Checkbox.superclass.initEvents.call(this); + this.el.on("click", this.onClick, this); + this.el.on("change", this.onClick, this); + }, + + + getResizeEl : function(){ + return this.wrap; + }, + + getPositionEl : function(){ + return this.wrap; + }, + + + // private + onRender : function(ct, position){ + Roo.form.Checkbox.superclass.onRender.call(this, ct, position); + + this.wrap = this.el.wrap({cls: 'x-form-daypick-item '}); + + var r1 = '<table><tr>'; + var r2 = '<tr class="x-form-daypick-icons">'; + for (var i=0; i < 7; i++) { + r1+= '<td><div>' + Date.dayNames[i].substring(0,3) + '</div></td>'; + r2+= '<td><img class="x-menu-item-icon" src="' + Roo.BLANK_IMAGE_URL +'"></td>'; + } + + var viewEl = this.wrap.createChild( r1 + '</tr>' + r2 + '</tr></table>'); + viewEl.select('img').on('click', this.onClick, this); + this.viewEl = viewEl; + + + // this will not work on Chrome!!! + this.el.on('DOMAttrModified', this.setFromHidden, this); //ff + this.el.on('propertychange', this.setFromHidden, this); //ie + + + + + }, + + // private + initValue : Roo.emptyFn, + + /** + * Returns the checked state of the checkbox. + * @return {Boolean} True if checked, else false + */ + getValue : function(){ + return this.el.dom.value; + + }, + + // private + onClick : function(e){ + //this.setChecked(!this.checked); + Roo.get(e.target).toggleClass('x-menu-item-checked'); + this.refreshValue(); + //if(this.el.dom.checked != this.checked){ + // this.setValue(this.el.dom.checked); + // } + }, + + // private + refreshValue : function() + { + var val = ''; + this.viewEl.select('img',true).each(function(e,i,n) { + val += e.is(".x-menu-item-checked") ? String(n) : ''; + }); + this.setValue(val, true); + }, + + /** + * Sets the checked state of the checkbox. + * On is always based on a string comparison between inputValue and the param. + * @param {Boolean/String} value - the value to set + * @param {Boolean/String} suppressEvent - whether to suppress the checkchange event. + */ + setValue : function(v,suppressEvent){ + if (!this.el.dom) { + return; + } + var old = this.el.dom.value ; + this.el.dom.value = v; + if (suppressEvent) { + return ; + } + + // update display.. + this.viewEl.select('img',true).each(function(e,i,n) { + + var on = e.is(".x-menu-item-checked"); + var newv = v.indexOf(String(n)) > -1; + if (on != newv) { + e.toggleClass('x-menu-item-checked'); + } + + }); + + + this.fireEvent('change', this, v, old); + + + }, + + // handle setting of hidden value by some other method!!?!? + setFromHidden: function() + { + if(!this.el){ + return; + } + //console.log("SET FROM HIDDEN"); + //alert('setFrom hidden'); + this.setValue(this.el.dom.value); + }, + + onDestroy : function() + { + if(this.viewEl){ + Roo.get(this.viewEl).remove(); + } + + Roo.form.DayPicker.superclass.onDestroy.call(this); + } + +}); \ No newline at end of file diff --git a/docs2/src/Roo_form_DisplayField.js.html b/docs2/src/Roo_form_DisplayField.js.html new file mode 100644 index 0000000000..578aeb20d7 --- /dev/null +++ b/docs2/src/Roo_form_DisplayField.js.html @@ -0,0 +1,141 @@ +/home/alan/gitlive/roojs1/Roo/form/DisplayField.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.form.DisplayField + * @extends Roo.form.Field + * A generic Field to display non-editable data. + * @cfg {Boolean} closable (true|false) default false + * @constructor + * Creates a new Display Field item. + * @param {Object} config Configuration options + */ +Roo.form.DisplayField = function(config){ + Roo.form.DisplayField.superclass.constructor.call(this, config); + + this.addEvents({ + /** + * @event close + * Fires after the click the close btn + * @param {Roo.form.DisplayField} this + */ + close : true + }); +}; + +Roo.extend(Roo.form.DisplayField, Roo.form.TextField, { + inputType: 'hidden', + allowBlank: true, + readOnly: true, + + + /** + * @cfg {String} focusClass The CSS class to use when the checkbox receives focus (defaults to undefined) + */ + focusClass : undefined, + /** + * @cfg {String} fieldClass The default CSS class for the checkbox (defaults to "x-form-field") + */ + fieldClass: 'x-form-field', + + /** + * @cfg {Function} valueRenderer The renderer for the field (so you can reformat output). should return raw HTML + */ + valueRenderer: undefined, + + width: 100, + /** + * @cfg {String/Object} autoCreate A DomHelper element spec, or true for a default element spec (defaults to + * {tag: "input", type: "checkbox", autocomplete: "off"}) + */ + + // defaultAutoCreate : { tag: 'input', type: 'hidden', autocomplete: 'off'}, + + closable : false, + + onResize : function(){ + Roo.form.DisplayField.superclass.onResize.apply(this, arguments); + + }, + + initEvents : function(){ + // Roo.form.Checkbox.superclass.initEvents.call(this); + // has no events... + + if(this.closable){ + this.closeEl.on('click', this.onClose, this); + } + + }, + + + getResizeEl : function(){ + return this.wrap; + }, + + getPositionEl : function(){ + return this.wrap; + }, + + // private + onRender : function(ct, position){ + + Roo.form.DisplayField.superclass.onRender.call(this, ct, position); + //if(this.inputValue !== undefined){ + this.wrap = this.el.wrap(); + + this.viewEl = this.wrap.createChild({ tag: 'div', cls: 'x-form-displayfield'}); + + if(this.closable){ + this.closeEl = this.wrap.createChild({ tag: 'div', cls: 'x-dlg-close'}); + } + + if (this.bodyStyle) { + this.viewEl.applyStyles(this.bodyStyle); + } + //this.viewEl.setStyle('padding', '2px'); + + this.setValue(this.value); + + }, +/* + // private + initValue : Roo.emptyFn, + + */ + + // private + onClick : function(){ + + }, + + /** + * Sets the checked state of the checkbox. + * @param {Boolean/String} checked True, 'true', '1', or 'on' to check the checkbox, any other value will uncheck it. + */ + setValue : function(v){ + this.value = v; + var html = this.valueRenderer ? this.valueRenderer(v) : String.format('{0}', v); + // this might be called before we have a dom element.. + if (!this.viewEl) { + return; + } + this.viewEl.dom.innerHTML = html; + Roo.form.DisplayField.superclass.setValue.call(this, v); + + }, + + onClose : function(e) + { + e.preventDefault(); + + this.fireEvent('close', this); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_form_FCKeditor.js.html b/docs2/src/Roo_form_FCKeditor.js.html new file mode 100644 index 0000000000..929157f91a --- /dev/null +++ b/docs2/src/Roo_form_FCKeditor.js.html @@ -0,0 +1,339 @@ +/home/alan/gitlive/roojs1/Roo/form/FCKeditor.js//<script type="text/javascript"> + +/** + * @class Roo.form.FCKeditor + * @extends Roo.form.TextArea + * Wrapper around the FCKEditor http://www.fckeditor.net + * @constructor + * Creates a new FCKeditor + * @param {Object} config Configuration options + */ +Roo.form.FCKeditor = function(config){ + Roo.form.FCKeditor.superclass.constructor.call(this, config); + this.addEvents({ + /** + * @event editorinit + * Fired when the editor is initialized - you can add extra handlers here.. + * @param {FCKeditor} this + * @param {Object} the FCK object. + */ + editorinit : true + }); + + +}; +Roo.form.FCKeditor.editors = { }; +Roo.extend(Roo.form.FCKeditor, Roo.form.TextArea, +{ + //defaultAutoCreate : { + // tag : "textarea",style : "width:100px;height:60px;" ,autocomplete : "off" + //}, + // private + /** + * @cfg {Object} fck options - see fck manual for details. + */ + fckconfig : false, + + /** + * @cfg {Object} fck toolbar set (Basic or Default) + */ + toolbarSet : 'Basic', + /** + * @cfg {Object} fck BasePath + */ + basePath : '/fckeditor/', + + + frame : false, + + value : '', + + + onRender : function(ct, position) + { + if(!this.el){ + this.defaultAutoCreate = { + tag: "textarea", + style:"width:300px;height:60px;", + autocomplete: "new-password" + }; + } + Roo.form.FCKeditor.superclass.onRender.call(this, ct, position); + /* + if(this.grow){ + this.textSizeEl = Roo.DomHelper.append(document.body, {tag: "pre", cls: "x-form-grow-sizer"}); + if(this.preventScrollbars){ + this.el.setStyle("overflow", "hidden"); + } + this.el.setHeight(this.growMin); + } + */ + //console.log('onrender' + this.getId() ); + Roo.form.FCKeditor.editors[this.getId()] = this; + + + this.replaceTextarea() ; + + }, + + getEditor : function() { + return this.fckEditor; + }, + /** + * Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}. + * @param {Mixed} value The value to set + */ + + + setValue : function(value) + { + //console.log('setValue: ' + value); + + if(typeof(value) == 'undefined') { // not sure why this is happending... + return; + } + Roo.form.FCKeditor.superclass.setValue.apply(this,[value]); + + //if(!this.el || !this.getEditor()) { + // this.value = value; + //this.setValue.defer(100,this,[value]); + // return; + //} + + if(!this.getEditor()) { + return; + } + + this.getEditor().SetData(value); + + // + + }, + + /** + * Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}. + * @return {Mixed} value The field value + */ + getValue : function() + { + + if (this.frame && this.frame.dom.style.display == 'none') { + return Roo.form.FCKeditor.superclass.getValue.call(this); + } + + if(!this.el || !this.getEditor()) { + + // this.getValue.defer(100,this); + return this.value; + } + + + var value=this.getEditor().GetData(); + Roo.form.FCKeditor.superclass.setValue.apply(this,[value]); + return Roo.form.FCKeditor.superclass.getValue.call(this); + + + }, + + /** + * Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}. + * @return {Mixed} value The field value + */ + getRawValue : function() + { + if (this.frame && this.frame.dom.style.display == 'none') { + return Roo.form.FCKeditor.superclass.getRawValue.call(this); + } + + if(!this.el || !this.getEditor()) { + //this.getRawValue.defer(100,this); + return this.value; + return; + } + + + + var value=this.getEditor().GetData(); + Roo.form.FCKeditor.superclass.setRawValue.apply(this,[value]); + return Roo.form.FCKeditor.superclass.getRawValue.call(this); + + }, + + setSize : function(w,h) { + + + + //if (this.frame && this.frame.dom.style.display == 'none') { + // Roo.form.FCKeditor.superclass.setSize.apply(this, [w, h]); + // return; + //} + //if(!this.el || !this.getEditor()) { + // this.setSize.defer(100,this, [w,h]); + // return; + //} + + + + Roo.form.FCKeditor.superclass.setSize.apply(this, [w, h]); + + this.frame.dom.setAttribute('width', w); + this.frame.dom.setAttribute('height', h); + this.frame.setSize(w,h); + + }, + + toggleSourceEdit : function(value) { + + + + this.el.dom.style.display = value ? '' : 'none'; + this.frame.dom.style.display = value ? 'none' : ''; + + }, + + + focus: function(tag) + { + if (this.frame.dom.style.display == 'none') { + return Roo.form.FCKeditor.superclass.focus.call(this); + } + if(!this.el || !this.getEditor()) { + this.focus.defer(100,this, [tag]); + return; + } + + + + + var tgs = this.getEditor().EditorDocument.getElementsByTagName(tag); + this.getEditor().Focus(); + if (tgs.length) { + if (!this.getEditor().Selection.GetSelection()) { + this.focus.defer(100,this, [tag]); + return; + } + + + var r = this.getEditor().EditorDocument.createRange(); + r.setStart(tgs[0],0); + r.setEnd(tgs[0],0); + this.getEditor().Selection.GetSelection().removeAllRanges(); + this.getEditor().Selection.GetSelection().addRange(r); + this.getEditor().Focus(); + } + + }, + + + + replaceTextarea : function() + { + if ( document.getElementById( this.getId() + '___Frame' ) ) { + return ; + } + //if ( !this.checkBrowser || this._isCompatibleBrowser() ) + //{ + // We must check the elements firstly using the Id and then the name. + var oTextarea = document.getElementById( this.getId() ); + + var colElementsByName = document.getElementsByName( this.getId() ) ; + + oTextarea.style.display = 'none' ; + + if ( oTextarea.tabIndex ) { + this.TabIndex = oTextarea.tabIndex ; + } + + this._insertHtmlBefore( this._getConfigHtml(), oTextarea ) ; + this._insertHtmlBefore( this._getIFrameHtml(), oTextarea ) ; + this.frame = Roo.get(this.getId() + '___Frame') + }, + + _getConfigHtml : function() + { + var sConfig = '' ; + + for ( var o in this.fckconfig ) { + sConfig += sConfig.length > 0 ? '&amp;' : ''; + sConfig += encodeURIComponent( o ) + '=' + encodeURIComponent( this.fckconfig[o] ) ; + } + + return '<input type="hidden" id="' + this.getId() + '___Config" value="' + sConfig + '" style="display:none" />' ; + }, + + + _getIFrameHtml : function() + { + var sFile = 'fckeditor.html' ; + /* no idea what this is about.. + try + { + if ( (/fcksource=true/i).test( window.top.location.search ) ) + sFile = 'fckeditor.original.html' ; + } + catch (e) { + */ + + var sLink = this.basePath + 'editor/' + sFile + '?InstanceName=' + encodeURIComponent( this.getId() ) ; + sLink += this.toolbarSet ? ( '&amp;Toolbar=' + this.toolbarSet) : ''; + + + var html = '<iframe id="' + this.getId() + + '___Frame" src="' + sLink + + '" width="' + this.width + + '" height="' + this.height + '"' + + (this.tabIndex ? ' tabindex="' + this.tabIndex + '"' :'' ) + + ' frameborder="0" scrolling="no"></iframe>' ; + + return html ; + }, + + _insertHtmlBefore : function( html, element ) + { + if ( element.insertAdjacentHTML ) { + // IE + element.insertAdjacentHTML( 'beforeBegin', html ) ; + } else { // Gecko + var oRange = document.createRange() ; + oRange.setStartBefore( element ) ; + var oFragment = oRange.createContextualFragment( html ); + element.parentNode.insertBefore( oFragment, element ) ; + } + } + + + + + + + + +}); + +//Roo.reg('fckeditor', Roo.form.FCKeditor); + +function FCKeditor_OnComplete(editorInstance){ + var f = Roo.form.FCKeditor.editors[editorInstance.Name]; + f.fckEditor = editorInstance; + //console.log("loaded"); + f.fireEvent('editorinit', f, editorInstance); +} + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs2/src/Roo_form_Field.js.html b/docs2/src/Roo_form_Field.js.html new file mode 100644 index 0000000000..0ed80d3c22 --- /dev/null +++ b/docs2/src/Roo_form_Field.js.html @@ -0,0 +1,582 @@ +/home/alan/gitlive/roojs1/Roo/form/Field.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.form.Field + * @extends Roo.BoxComponent + * Base class for form fields that provides default event handling, sizing, value handling and other functionality. + * @constructor + * Creates a new Field + * @param {Object} config Configuration options + */ +Roo.form.Field = function(config){ + Roo.form.Field.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.form.Field, Roo.BoxComponent, { + /** + * @cfg {String} fieldLabel Label to use when rendering a form. + */ + /** + * @cfg {String} qtip Mouse over tip + */ + + /** + * @cfg {String} invalidClass The CSS class to use when marking a field invalid (defaults to "x-form-invalid") + */ + invalidClass : "x-form-invalid", + /** + * @cfg {String} invalidText The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid") + */ + invalidText : "The value in this field is invalid", + /** + * @cfg {String} focusClass The CSS class to use when the field receives focus (defaults to "x-form-focus") + */ + focusClass : "x-form-focus", + /** + * @cfg {String/Boolean} validationEvent The event that should initiate field validation. Set to false to disable + automatic validation (defaults to "keyup"). + */ + validationEvent : "keyup", + /** + * @cfg {Boolean} validateOnBlur Whether the field should validate when it loses focus (defaults to true). + */ + validateOnBlur : true, + /** + * @cfg {Number} validationDelay The length of time in milliseconds after user input begins until validation is initiated (defaults to 250) + */ + validationDelay : 250, + /** + * @cfg {String/Object} autoCreate A DomHelper element spec, or true for a default element spec (defaults to + * {tag: "input", type: "text", size: "20", autocomplete: "off"}) + */ + defaultAutoCreate : {tag: "input", type: "text", size: "20", autocomplete: "new-password"}, + /** + * @cfg {String} fieldClass The default CSS class for the field (defaults to "x-form-field") + */ + fieldClass : "x-form-field", + /** + * @cfg {String} msgTarget The location where error text should display. Should be one of the following values (defaults to 'qtip'): + *<pre> +Value Description +----------- ---------------------------------------------------------------------- +qtip Display a quick tip when the user hovers over the field +title Display a default browser title attribute popup +under Add a block div beneath the field containing the error text +side Add an error icon to the right of the field with a popup on hover +[element id] Add the error text directly to the innerHTML of the specified element +</pre> + */ + msgTarget : 'qtip', + /** + * @cfg {String} msgFx <b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal'). + */ + msgFx : 'normal', + + /** + * @cfg {Boolean} readOnly True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute. + */ + readOnly : false, + + /** + * @cfg {Boolean} disabled True to disable the field (defaults to false). + */ + disabled : false, + + /** + * @cfg {String} inputType The type attribute for input fields -- e.g. radio, text, password (defaults to "text"). + */ + inputType : undefined, + + /** + * @cfg {Number} tabIndex The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined). + */ + tabIndex : undefined, + + // private + isFormField : true, + + // private + hasFocus : false, + /** + * @property {Roo.Element} fieldEl + * Element Containing the rendered Field (with label etc.) + */ + /** + * @cfg {Mixed} value A value to initialize this field with. + */ + value : undefined, + + /** + * @cfg {String} name The field's HTML name attribute. + */ + /** + * @cfg {String} cls A CSS class to apply to the field's underlying element. + */ + // private + loadedValue : false, + + + // private ?? + initComponent : function(){ + Roo.form.Field.superclass.initComponent.call(this); + this.addEvents({ + /** + * @event focus + * Fires when this field receives input focus. + * @param {Roo.form.Field} this + */ + focus : true, + /** + * @event blur + * Fires when this field loses input focus. + * @param {Roo.form.Field} this + */ + blur : true, + /** + * @event specialkey + * Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check + * {@link Roo.EventObject#getKey} to determine which key was pressed. + * @param {Roo.form.Field} this + * @param {Roo.EventObject} e The event object + */ + specialkey : true, + /** + * @event change + * Fires just before the field blurs if the field value has changed. + * @param {Roo.form.Field} this + * @param {Mixed} newValue The new value + * @param {Mixed} oldValue The original value + */ + change : true, + /** + * @event invalid + * Fires after the field has been marked as invalid. + * @param {Roo.form.Field} this + * @param {String} msg The validation message + */ + invalid : true, + /** + * @event valid + * Fires after the field has been validated with no errors. + * @param {Roo.form.Field} this + */ + valid : true, + /** + * @event keyup + * Fires after the key up + * @param {Roo.form.Field} this + * @param {Roo.EventObject} e The event Object + */ + keyup : true + }); + }, + + /** + * Returns the name attribute of the field if available + * @return {String} name The field name + */ + getName: function(){ + return this.rendered && this.el.dom.name ? this.el.dom.name : (this.hiddenName || ''); + }, + + // private + onRender : function(ct, position){ + Roo.form.Field.superclass.onRender.call(this, ct, position); + if(!this.el){ + var cfg = this.getAutoCreate(); + if(!cfg.name){ + cfg.name = typeof(this.name) == 'undefined' ? this.id : this.name; + } + if (!cfg.name.length) { + delete cfg.name; + } + if(this.inputType){ + cfg.type = this.inputType; + } + this.el = ct.createChild(cfg, position); + } + var type = this.el.dom.type; + if(type){ + if(type == 'password'){ + type = 'text'; + } + this.el.addClass('x-form-'+type); + } + if(this.readOnly){ + this.el.dom.readOnly = true; + } + if(this.tabIndex !== undefined){ + this.el.dom.setAttribute('tabIndex', this.tabIndex); + } + + this.el.addClass([this.fieldClass, this.cls]); + this.initValue(); + }, + + /** + * Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b> + * @param {String/HTMLElement/Element} el The id of the node, a DOM node or an existing Element + * @return {Roo.form.Field} this + */ + applyTo : function(target){ + this.allowDomMove = false; + this.el = Roo.get(target); + this.render(this.el.dom.parentNode); + return this; + }, + + // private + initValue : function(){ + if(this.value !== undefined){ + this.setValue(this.value); + }else if(this.el.dom.value.length > 0){ + this.setValue(this.el.dom.value); + } + }, + + /** + * Returns true if this field has been changed since it was originally loaded and is not disabled. + * DEPRICATED - it never worked well - use hasChanged/resetHasChanged. + */ + isDirty : function() { + if(this.disabled) { + return false; + } + return String(this.getValue()) !== String(this.originalValue); + }, + + /** + * stores the current value in loadedValue + */ + resetHasChanged : function() + { + this.loadedValue = String(this.getValue()); + }, + /** + * checks the current value against the 'loaded' value. + * Note - will return false if 'resetHasChanged' has not been called first. + */ + hasChanged : function() + { + if(this.disabled || this.readOnly) { + return false; + } + return this.loadedValue !== false && String(this.getValue()) !== this.loadedValue; + }, + + + + // private + afterRender : function(){ + Roo.form.Field.superclass.afterRender.call(this); + this.initEvents(); + }, + + // private + fireKey : function(e){ + //Roo.log('field ' + e.getKey()); + if(e.isNavKeyPress()){ + this.fireEvent("specialkey", this, e); + } + }, + + /** + * Resets the current field value to the originally loaded value and clears any validation messages + */ + reset : function(){ + this.setValue(this.resetValue); + this.originalValue = this.getValue(); + this.clearInvalid(); + }, + + // private + initEvents : function(){ + // safari killled keypress - so keydown is now used.. + this.el.on("keydown" , this.fireKey, this); + this.el.on("focus", this.onFocus, this); + this.el.on("blur", this.onBlur, this); + this.el.relayEvent('keyup', this); + + // reference to original value for reset + this.originalValue = this.getValue(); + this.resetValue = this.getValue(); + }, + + // private + onFocus : function(){ + if(!Roo.isOpera && this.focusClass){ // don't touch in Opera + this.el.addClass(this.focusClass); + } + if(!this.hasFocus){ + this.hasFocus = true; + this.startValue = this.getValue(); + this.fireEvent("focus", this); + } + }, + + beforeBlur : Roo.emptyFn, + + // private + onBlur : function(){ + this.beforeBlur(); + if(!Roo.isOpera && this.focusClass){ // don't touch in Opera + this.el.removeClass(this.focusClass); + } + this.hasFocus = false; + if(this.validationEvent !== false && this.validateOnBlur && this.validationEvent != "blur"){ + this.validate(); + } + var v = this.getValue(); + if(String(v) !== String(this.startValue)){ + this.fireEvent('change', this, v, this.startValue); + } + this.fireEvent("blur", this); + }, + + /** + * Returns whether or not the field value is currently valid + * @param {Boolean} preventMark True to disable marking the field invalid + * @return {Boolean} True if the value is valid, else false + */ + isValid : function(preventMark){ + if(this.disabled){ + return true; + } + var restore = this.preventMark; + this.preventMark = preventMark === true; + var v = this.validateValue(this.processValue(this.getRawValue())); + this.preventMark = restore; + return v; + }, + + /** + * Validates the field value + * @return {Boolean} True if the value is valid, else false + */ + validate : function(){ + if(this.disabled || this.validateValue(this.processValue(this.getRawValue()))){ + this.clearInvalid(); + return true; + } + return false; + }, + + processValue : function(value){ + return value; + }, + + // private + // Subclasses should provide the validation implementation by overriding this + validateValue : function(value){ + return true; + }, + + /** + * Mark this field as invalid + * @param {String} msg The validation message + */ + markInvalid : function(msg){ + if(!this.rendered || this.preventMark){ // not rendered + return; + } + + var obj = (typeof(this.combo) != 'undefined') ? this.combo : this; // fix the combox array!! + + obj.el.addClass(this.invalidClass); + msg = msg || this.invalidText; + switch(this.msgTarget){ + case 'qtip': + obj.el.dom.qtip = msg; + obj.el.dom.qclass = 'x-form-invalid-tip'; + if(Roo.QuickTips){ // fix for floating editors interacting with DND + Roo.QuickTips.enable(); + } + break; + case 'title': + this.el.dom.title = msg; + break; + case 'under': + if(!this.errorEl){ + var elp = this.el.findParent('.x-form-element', 5, true); + this.errorEl = elp.createChild({cls:'x-form-invalid-msg'}); + this.errorEl.setWidth(elp.getWidth(true)-20); + } + this.errorEl.update(msg); + Roo.form.Field.msgFx[this.msgFx].show(this.errorEl, this); + break; + case 'side': + if(!this.errorIcon){ + var elp = this.el.findParent('.x-form-element', 5, true); + this.errorIcon = elp.createChild({cls:'x-form-invalid-icon'}); + } + this.alignErrorIcon(); + this.errorIcon.dom.qtip = msg; + this.errorIcon.dom.qclass = 'x-form-invalid-tip'; + this.errorIcon.show(); + this.on('resize', this.alignErrorIcon, this); + break; + default: + var t = Roo.getDom(this.msgTarget); + t.innerHTML = msg; + t.style.display = this.msgDisplay; + break; + } + this.fireEvent('invalid', this, msg); + }, + + // private + alignErrorIcon : function(){ + this.errorIcon.alignTo(this.el, 'tl-tr', [2, 0]); + }, + + /** + * Clear any invalid styles/messages for this field + */ + clearInvalid : function(){ + if(!this.rendered || this.preventMark){ // not rendered + return; + } + var obj = (typeof(this.combo) != 'undefined') ? this.combo : this; // fix the combox array!! + + obj.el.removeClass(this.invalidClass); + switch(this.msgTarget){ + case 'qtip': + obj.el.dom.qtip = ''; + break; + case 'title': + this.el.dom.title = ''; + break; + case 'under': + if(this.errorEl){ + Roo.form.Field.msgFx[this.msgFx].hide(this.errorEl, this); + } + break; + case 'side': + if(this.errorIcon){ + this.errorIcon.dom.qtip = ''; + this.errorIcon.hide(); + this.un('resize', this.alignErrorIcon, this); + } + break; + default: + var t = Roo.getDom(this.msgTarget); + t.innerHTML = ''; + t.style.display = 'none'; + break; + } + this.fireEvent('valid', this); + }, + + /** + * Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}. + * @return {Mixed} value The field value + */ + getRawValue : function(){ + var v = this.el.getValue(); + + return v; + }, + + /** + * Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}. + * @return {Mixed} value The field value + */ + getValue : function(){ + var v = this.el.getValue(); + + return v; + }, + + /** + * Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}. + * @param {Mixed} value The value to set + */ + setRawValue : function(v){ + return this.el.dom.value = (v === null || v === undefined ? '' : v); + }, + + /** + * Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}. + * @param {Mixed} value The value to set + */ + setValue : function(v){ + this.value = v; + if(this.rendered){ + this.el.dom.value = (v === null || v === undefined ? '' : v); + this.validate(); + } + }, + + adjustSize : function(w, h){ + var s = Roo.form.Field.superclass.adjustSize.call(this, w, h); + s.width = this.adjustWidth(this.el.dom.tagName, s.width); + return s; + }, + + adjustWidth : function(tag, w){ + tag = tag.toLowerCase(); + if(typeof w == 'number' && Roo.isStrict && !Roo.isSafari){ + if(Roo.isIE && (tag == 'input' || tag == 'textarea')){ + if(tag == 'input'){ + return w + 2; + } + if(tag == 'textarea'){ + return w-2; + } + }else if(Roo.isOpera){ + if(tag == 'input'){ + return w + 2; + } + if(tag == 'textarea'){ + return w-2; + } + } + } + return w; + } +}); + + +// anything other than normal should be considered experimental +Roo.form.Field.msgFx = { + normal : { + show: function(msgEl, f){ + msgEl.setDisplayed('block'); + }, + + hide : function(msgEl, f){ + msgEl.setDisplayed(false).update(''); + } + }, + + slide : { + show: function(msgEl, f){ + msgEl.slideIn('t', {stopFx:true}); + }, + + hide : function(msgEl, f){ + msgEl.slideOut('t', {stopFx:true,useDisplay:true}); + } + }, + + slideRight : { + show: function(msgEl, f){ + msgEl.fixDisplay(); + msgEl.alignTo(f.el, 'tl-tr'); + msgEl.slideIn('l', {stopFx:true}); + }, + + hide : function(msgEl, f){ + msgEl.slideOut('l', {stopFx:true,useDisplay:true}); + } + } +}; \ No newline at end of file diff --git a/docs2/src/Roo_form_Form.js.html b/docs2/src/Roo_form_Form.js.html new file mode 100644 index 0000000000..d54e8f8ba1 --- /dev/null +++ b/docs2/src/Roo_form_Form.js.html @@ -0,0 +1,447 @@ +/home/alan/gitlive/roojs1/Roo/form/Form.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.form.Form + * @extends Roo.form.BasicForm + * Adds the ability to dynamically render forms with JavaScript to {@link Roo.form.BasicForm}. + * @constructor + * @param {Object} config Configuration options + */ +Roo.form.Form = function(config){ + var xitems = []; + if (config.items) { + xitems = config.items; + delete config.items; + } + + + Roo.form.Form.superclass.constructor.call(this, null, config); + this.url = this.url || this.action; + if(!this.root){ + this.root = new Roo.form.Layout(Roo.applyIf({ + id: Roo.id() + }, config)); + } + this.active = this.root; + /** + * Array of all the buttons that have been added to this form via {@link addButton} + * @type Array + */ + this.buttons = []; + this.allItems = []; + this.addEvents({ + /** + * @event clientvalidation + * If the monitorValid config option is true, this event fires repetitively to notify of valid state + * @param {Form} this + * @param {Boolean} valid true if the form has passed client-side validation + */ + clientvalidation: true, + /** + * @event rendered + * Fires when the form is rendered + * @param {Roo.form.Form} form + */ + rendered : true + }); + + if (this.progressUrl) { + // push a hidden field onto the list of fields.. + this.addxtype( { + xns: Roo.form, + xtype : 'Hidden', + name : 'UPLOAD_IDENTIFIER' + }); + } + + + Roo.each(xitems, this.addxtype, this); + + + +}; + +Roo.extend(Roo.form.Form, Roo.form.BasicForm, { + /** + * @cfg {Number} labelWidth The width of labels. This property cascades to child containers. + */ + /** + * @cfg {String} itemCls A css class to apply to the x-form-item of fields. This property cascades to child containers. + */ + /** + * @cfg {String} buttonAlign Valid values are "left," "center" and "right" (defaults to "center") + */ + buttonAlign:'center', + + /** + * @cfg {Number} minButtonWidth Minimum width of all buttons in pixels (defaults to 75) + */ + minButtonWidth:75, + + /** + * @cfg {String} labelAlign Valid values are "left," "top" and "right" (defaults to "left"). + * This property cascades to child containers if not set. + */ + labelAlign:'left', + + /** + * @cfg {Boolean} monitorValid If true the form monitors its valid state <b>client-side</b> and + * fires a looping event with that state. This is required to bind buttons to the valid + * state using the config value formBind:true on the button. + */ + monitorValid : false, + + /** + * @cfg {Number} monitorPoll The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200) + */ + monitorPoll : 200, + + /** + * @cfg {String} progressUrl - Url to return progress data + */ + + progressUrl : false, + /** + * @cfg {boolean|FormData} formData - true to use new 'FormData' post, or set to a new FormData({dom form}) Object, if + * sending a formdata with extra parameters - eg uploaded elements. + */ + + formData : false, + + /** + * Opens a new {@link Roo.form.Column} container in the layout stack. If fields are passed after the config, the + * fields are added and the column is closed. If no fields are passed the column remains open + * until end() is called. + * @param {Object} config The config to pass to the column + * @param {Field} field1 (optional) + * @param {Field} field2 (optional) + * @param {Field} etc (optional) + * @return Column The column container object + */ + column : function(c){ + var col = new Roo.form.Column(c); + this.start(col); + if(arguments.length > 1){ // duplicate code required because of Opera + this.add.apply(this, Array.prototype.slice.call(arguments, 1)); + this.end(); + } + return col; + }, + + /** + * Opens a new {@link Roo.form.FieldSet} container in the layout stack. If fields are passed after the config, the + * fields are added and the fieldset is closed. If no fields are passed the fieldset remains open + * until end() is called. + * @param {Object} config The config to pass to the fieldset + * @param {Field} field1 (optional) + * @param {Field} field2 (optional) + * @param {Field} etc (optional) + * @return FieldSet The fieldset container object + */ + fieldset : function(c){ + var fs = new Roo.form.FieldSet(c); + this.start(fs); + if(arguments.length > 1){ // duplicate code required because of Opera + this.add.apply(this, Array.prototype.slice.call(arguments, 1)); + this.end(); + } + return fs; + }, + + /** + * Opens a new {@link Roo.form.Layout} container in the layout stack. If fields are passed after the config, the + * fields are added and the container is closed. If no fields are passed the container remains open + * until end() is called. + * @param {Object} config The config to pass to the Layout + * @param {Field} field1 (optional) + * @param {Field} field2 (optional) + * @param {Field} etc (optional) + * @return Layout The container object + */ + container : function(c){ + var l = new Roo.form.Layout(c); + this.start(l); + if(arguments.length > 1){ // duplicate code required because of Opera + this.add.apply(this, Array.prototype.slice.call(arguments, 1)); + this.end(); + } + return l; + }, + + /** + * Opens the passed container in the layout stack. The container can be any {@link Roo.form.Layout} or subclass. + * @param {Object} container A Roo.form.Layout or subclass of Layout + * @return {Form} this + */ + start : function(c){ + // cascade label info + Roo.applyIf(c, {'labelAlign': this.active.labelAlign, 'labelWidth': this.active.labelWidth, 'itemCls': this.active.itemCls}); + this.active.stack.push(c); + c.ownerCt = this.active; + this.active = c; + return this; + }, + + /** + * Closes the current open container + * @return {Form} this + */ + end : function(){ + if(this.active == this.root){ + return this; + } + this.active = this.active.ownerCt; + return this; + }, + + /** + * Add Roo.form components to the current open container (e.g. column, fieldset, etc.). Fields added via this method + * can also be passed with an additional property of fieldLabel, which if supplied, will provide the text to display + * as the label of the field. + * @param {Field} field1 + * @param {Field} field2 (optional) + * @param {Field} etc. (optional) + * @return {Form} this + */ + add : function(){ + this.active.stack.push.apply(this.active.stack, arguments); + this.allItems.push.apply(this.allItems,arguments); + var r = []; + for(var i = 0, a = arguments, len = a.length; i < len; i++) { + if(a[i].isFormField){ + r.push(a[i]); + } + } + if(r.length > 0){ + Roo.form.Form.superclass.add.apply(this, r); + } + return this; + }, + + + + + + /** + * Find any element that has been added to a form, using it's ID or name + * This can include framesets, columns etc. along with regular fields.. + * @param {String} id - id or name to find. + + * @return {Element} e - or false if nothing found. + */ + findbyId : function(id) + { + var ret = false; + if (!id) { + return ret; + } + Roo.each(this.allItems, function(f){ + if (f.id == id || f.name == id ){ + ret = f; + return false; + } + }); + return ret; + }, + + + + /** + * Render this form into the passed container. This should only be called once! + * @param {String/HTMLElement/Element} container The element this component should be rendered into + * @return {Form} this + */ + render : function(ct) + { + + + + ct = Roo.get(ct); + var o = this.autoCreate || { + tag: 'form', + method : this.method || 'POST', + id : this.id || Roo.id() + }; + this.initEl(ct.createChild(o)); + + this.root.render(this.el); + + + + this.items.each(function(f){ + f.render('x-form-el-'+f.id); + }); + + if(this.buttons.length > 0){ + // tables are required to maintain order and for correct IE layout + var tb = this.el.createChild({cls:'x-form-btns-ct', cn: { + cls:"x-form-btns x-form-btns-"+this.buttonAlign, + html:'<table cellspacing="0"><tbody><tr></tr></tbody></table><div class="x-clear"></div>' + }}, null, true); + var tr = tb.getElementsByTagName('tr')[0]; + for(var i = 0, len = this.buttons.length; i < len; i++) { + var b = this.buttons[i]; + var td = document.createElement('td'); + td.className = 'x-form-btn-td'; + b.render(tr.appendChild(td)); + } + } + if(this.monitorValid){ // initialize after render + this.startMonitoring(); + } + this.fireEvent('rendered', this); + return this; + }, + + /** + * Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered. + * @param {String/Object} config A string becomes the button text, an object can either be a Button config + * object or a valid Roo.DomHelper element config + * @param {Function} handler The function called when the button is clicked + * @param {Object} scope (optional) The scope of the handler function + * @return {Roo.Button} + */ + addButton : function(config, handler, scope){ + var bc = { + handler: handler, + scope: scope, + minWidth: this.minButtonWidth, + hideParent:true + }; + if(typeof config == "string"){ + bc.text = config; + }else{ + Roo.apply(bc, config); + } + var btn = new Roo.Button(null, bc); + this.buttons.push(btn); + return btn; + }, + + /** + * Adds a series of form elements (using the xtype property as the factory method. + * Valid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column, (and 'end' to close a block) + * @param {Object} config + */ + + addxtype : function() + { + var ar = Array.prototype.slice.call(arguments, 0); + var ret = false; + for(var i = 0; i < ar.length; i++) { + if (!ar[i]) { + continue; // skip -- if this happends something invalid got sent, we + // should ignore it, as basically that interface element will not show up + // and that should be pretty obvious!! + } + + if (Roo.form[ar[i].xtype]) { + ar[i].form = this; + var fe = Roo.factory(ar[i], Roo.form); + if (!ret) { + ret = fe; + } + fe.form = this; + if (fe.store) { + fe.store.form = this; + } + if (fe.isLayout) { + + this.start(fe); + this.allItems.push(fe); + if (fe.items && fe.addxtype) { + fe.addxtype.apply(fe, fe.items); + delete fe.items; + } + this.end(); + continue; + } + + + + this.add(fe); + // console.log('adding ' + ar[i].xtype); + } + if (ar[i].xtype == 'Button') { + //console.log('adding button'); + //console.log(ar[i]); + this.addButton(ar[i]); + this.allItems.push(fe); + continue; + } + + if (ar[i].xtype == 'end') { // so we can add fieldsets... / layout etc. + alert('end is not supported on xtype any more, use items'); + // this.end(); + // //console.log('adding end'); + } + + } + return ret; + }, + + /** + * Starts monitoring of the valid state of this form. Usually this is done by passing the config + * option "monitorValid" + */ + startMonitoring : function(){ + if(!this.bound){ + this.bound = true; + Roo.TaskMgr.start({ + run : this.bindHandler, + interval : this.monitorPoll || 200, + scope: this + }); + } + }, + + /** + * Stops monitoring of the valid state of this form + */ + stopMonitoring : function(){ + this.bound = false; + }, + + // private + bindHandler : function(){ + if(!this.bound){ + return false; // stops binding + } + var valid = true; + this.items.each(function(f){ + if(!f.isValid(true)){ + valid = false; + return false; + } + }); + for(var i = 0, len = this.buttons.length; i < len; i++){ + var btn = this.buttons[i]; + if(btn.formBind === true && btn.disabled === valid){ + btn.setDisabled(!valid); + } + } + this.fireEvent('clientvalidation', this, valid); + } + + + + + + + + +}); + + +// back compat +Roo.Form = Roo.form.Form; + \ No newline at end of file diff --git a/docs2/src/Roo_form_GridField.js.html b/docs2/src/Roo_form_GridField.js.html new file mode 100644 index 0000000000..fed9226e26 --- /dev/null +++ b/docs2/src/Roo_form_GridField.js.html @@ -0,0 +1,140 @@ +/home/alan/gitlive/roojs1/Roo/form/GridField.js//<script type="text/javascript"> +/** + * @class Roo.form.GridField + * @extends Roo.form.Field + * Embed a grid (or editable grid into a form) + * STATUS ALPHA + * + * This embeds a grid in a form, the value of the field should be the json encoded array of rows + * it needs + * xgrid.store = Roo.data.Store + * xgrid.store.proxy = Roo.data.MemoryProxy (data = [] ) + * xgrid.store.reader = Roo.data.JsonReader + * + * + * @constructor + * Creates a new GridField + * @param {Object} config Configuration options + */ +Roo.form.GridField = function(config){ + Roo.form.GridField.superclass.constructor.call(this, config); + +}; + +Roo.extend(Roo.form.GridField, Roo.form.Field, { + /** + * @cfg {Number} width - used to restrict width of grid.. + */ + width : 100, + /** + * @cfg {Number} height - used to restrict height of grid.. + */ + height : 50, + /** + * @cfg {Object} xgrid (xtype'd description of grid) { xtype : 'Grid', dataSource: .... } + * + *} + */ + xgrid : false, + /** + * @cfg {String/Object} autoCreate A DomHelper element spec, or true for a default element spec (defaults to + * {tag: "input", type: "checkbox", autocomplete: "off"}) + */ + // defaultAutoCreate : { tag: 'div' }, + defaultAutoCreate : { tag: 'input', type: 'hidden', autocomplete: 'new-password'}, + /** + * @cfg {String} addTitle Text to include for adding a title. + */ + addTitle : false, + // + onResize : function(){ + Roo.form.Field.superclass.onResize.apply(this, arguments); + }, + + initEvents : function(){ + // Roo.form.Checkbox.superclass.initEvents.call(this); + // has no events... + + }, + + + getResizeEl : function(){ + return this.wrap; + }, + + getPositionEl : function(){ + return this.wrap; + }, + + // private + onRender : function(ct, position){ + + this.style = this.style || 'overflow: hidden; border:1px solid #c3daf9;'; + var style = this.style; + delete this.style; + + Roo.form.GridField.superclass.onRender.call(this, ct, position); + this.wrap = this.el.wrap({cls: ''}); // not sure why ive done thsi... + this.viewEl = this.wrap.createChild({ tag: 'div' }); + if (style) { + this.viewEl.applyStyles(style); + } + if (this.width) { + this.viewEl.setWidth(this.width); + } + if (this.height) { + this.viewEl.setHeight(this.height); + } + //if(this.inputValue !== undefined){ + //this.setValue(this.value); + + + this.grid = new Roo.grid[this.xgrid.xtype](this.viewEl, this.xgrid); + + + this.grid.render(); + this.grid.getDataSource().on('remove', this.refreshValue, this); + this.grid.getDataSource().on('update', this.refreshValue, this); + this.grid.on('afteredit', this.refreshValue, this); + + }, + + + /** + * Sets the value of the item. + * @param {String} either an object or a string.. + */ + setValue : function(v){ + //this.value = v; + v = v || []; // empty set.. + // this does not seem smart - it really only affects memoryproxy grids.. + if (this.grid && this.grid.getDataSource() && typeof(v) != 'undefined') { + var ds = this.grid.getDataSource(); + // assumes a json reader.. + var data = {} + data[ds.reader.meta.root ] = typeof(v) == 'string' ? Roo.decode(v) : v; + ds.loadData( data); + } + // clear selection so it does not get stale. + if (this.grid.sm) { + this.grid.sm.clearSelections(); + } + + Roo.form.GridField.superclass.setValue.call(this, v); + this.refreshValue(); + // should load data in the grid really.... + }, + + // private + refreshValue: function() { + var val = []; + this.grid.getDataSource().each(function(r) { + val.push(r.data); + }); + this.el.dom.value = Roo.encode(val); + } + + + + +}); \ No newline at end of file diff --git a/docs2/src/Roo_form_Hidden.js.html b/docs2/src/Roo_form_Hidden.js.html new file mode 100644 index 0000000000..c863924be3 --- /dev/null +++ b/docs2/src/Roo_form_Hidden.js.html @@ -0,0 +1,44 @@ +/home/alan/gitlive/roojs1/Roo/form/Hidden.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.form.Hidden + * @extends Roo.form.TextField + * Simple Hidden element used on forms + * + * usage: form.add(new Roo.form.HiddenField({ 'name' : 'test1' })); + * + * @constructor + * Creates a new Hidden form element. + * @param {Object} config Configuration options + */ + + + +// easy hidden field... +Roo.form.Hidden = function(config){ + Roo.form.Hidden.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.form.Hidden, Roo.form.TextField, { + fieldLabel: '', + inputType: 'hidden', + width: 50, + allowBlank: true, + labelSeparator: '', + hidden: true, + itemCls : 'x-form-item-display-none' + + +}); + + + \ No newline at end of file diff --git a/docs2/src/Roo_form_HtmlEditor.js.html b/docs2/src/Roo_form_HtmlEditor.js.html new file mode 100644 index 0000000000..7133d5ff16 --- /dev/null +++ b/docs2/src/Roo_form_HtmlEditor.js.html @@ -0,0 +1,619 @@ +/home/alan/gitlive/roojs1/Roo/form/HtmlEditor.js//<script type="text/javascript"> + +/* + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * Licence LGPL + * + */ + + +Roo.form.HtmlEditor = function(config){ + + + + Roo.form.HtmlEditor.superclass.constructor.call(this, config); + + if (!this.toolbars) { + this.toolbars = []; + } + this.editorcore = new Roo.HtmlEditorCore(Roo.apply({ owner : this} , config)); + + +}; + +/** + * @class Roo.form.HtmlEditor + * @extends Roo.form.Field + * Provides a lightweight HTML Editor component. + * + * This has been tested on Fireforx / Chrome.. IE may not be so great.. + * + * <br><br><b>Note: The focus/blur and validation marking functionality inherited from Ext.form.Field is NOT + * supported by this editor.</b><br/><br/> + * An Editor is a sensitive component that can't be used in all spots standard fields can be used. Putting an Editor within + * any element that has display set to 'none' can cause problems in Safari and Firefox.<br/><br/> + */ +Roo.extend(Roo.form.HtmlEditor, Roo.form.Field, { + /** + * @cfg {Boolean} clearUp + */ + clearUp : true, + /** + * @cfg {Array} toolbars Array of toolbars. - defaults to just the Standard one + */ + toolbars : false, + + /** + * @cfg {String} resizable 's' or 'se' or 'e' - wrapps the element in a + * Roo.resizable. + */ + resizable : false, + /** + * @cfg {Number} height (in pixels) + */ + height: 300, + /** + * @cfg {Number} width (in pixels) + */ + width: 500, + + /** + * @cfg {Array} stylesheets url of stylesheets. set to [] to disable stylesheets. + * + */ + stylesheets: false, + + + /** + * @cfg {Array} blacklist of css styles style attributes (blacklist overrides whitelist) + * + */ + cblack: false, + /** + * @cfg {Array} whitelist of css styles style attributes (blacklist overrides whitelist) + * + */ + cwhite: false, + + /** + * @cfg {Array} blacklist of html tags - in addition to standard blacklist. + * + */ + black: false, + /** + * @cfg {Array} whitelist of html tags - in addition to statndard whitelist + * + */ + white: false, + + // id of frame.. + frameId: false, + + // private properties + validationEvent : false, + deferHeight: true, + initialized : false, + activated : false, + + onFocus : Roo.emptyFn, + iframePad:3, + hideMode:'offsets', + + actionMode : 'container', // defaults to hiding it... + + defaultAutoCreate : { // modified by initCompnoent.. + tag: "textarea", + style:"width:500px;height:300px;", + autocomplete: "new-password" + }, + + // private + initComponent : function(){ + this.addEvents({ + /** + * @event initialize + * Fires when the editor is fully initialized (including the iframe) + * @param {HtmlEditor} this + */ + initialize: true, + /** + * @event activate + * Fires when the editor is first receives the focus. Any insertion must wait + * until after this event. + * @param {HtmlEditor} this + */ + activate: true, + /** + * @event beforesync + * Fires before the textarea is updated with content from the editor iframe. Return false + * to cancel the sync. + * @param {HtmlEditor} this + * @param {String} html + */ + beforesync: true, + /** + * @event beforepush + * Fires before the iframe editor is updated with content from the textarea. Return false + * to cancel the push. + * @param {HtmlEditor} this + * @param {String} html + */ + beforepush: true, + /** + * @event sync + * Fires when the textarea is updated with content from the editor iframe. + * @param {HtmlEditor} this + * @param {String} html + */ + sync: true, + /** + * @event push + * Fires when the iframe editor is updated with content from the textarea. + * @param {HtmlEditor} this + * @param {String} html + */ + push: true, + /** + * @event editmodechange + * Fires when the editor switches edit modes + * @param {HtmlEditor} this + * @param {Boolean} sourceEdit True if source edit, false if standard editing. + */ + editmodechange: true, + /** + * @event editorevent + * Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks. + * @param {HtmlEditor} this + */ + editorevent: true, + /** + * @event firstfocus + * Fires when on first focus - needed by toolbars.. + * @param {HtmlEditor} this + */ + firstfocus: true, + /** + * @event autosave + * Auto save the htmlEditor value as a file into Events + * @param {HtmlEditor} this + */ + autosave: true, + /** + * @event savedpreview + * preview the saved version of htmlEditor + * @param {HtmlEditor} this + */ + savedpreview: true, + + /** + * @event stylesheetsclick + * Fires when press the Sytlesheets button + * @param {Roo.HtmlEditorCore} this + */ + stylesheetsclick: true + }); + this.defaultAutoCreate = { + tag: "textarea", + style:'width: ' + this.width + 'px;height: ' + this.height + 'px;', + autocomplete: "new-password" + }; + }, + + /** + * Protected method that will not generally be called directly. It + * is called when the editor creates its toolbar. Override this method if you need to + * add custom toolbar buttons. + * @param {HtmlEditor} editor + */ + createToolbar : function(editor){ + Roo.log("create toolbars"); + if (!editor.toolbars || !editor.toolbars.length) { + editor.toolbars = [ new Roo.form.HtmlEditor.ToolbarStandard() ]; // can be empty? + } + + for (var i =0 ; i < editor.toolbars.length;i++) { + editor.toolbars[i] = Roo.factory( + typeof(editor.toolbars[i]) == 'string' ? + { xtype: editor.toolbars[i]} : editor.toolbars[i], + Roo.form.HtmlEditor); + editor.toolbars[i].init(editor); + } + + + }, + + + // private + onRender : function(ct, position) + { + var _t = this; + Roo.form.HtmlEditor.superclass.onRender.call(this, ct, position); + + this.wrap = this.el.wrap({ + cls:'x-html-editor-wrap', cn:{cls:'x-html-editor-tb'} + }); + + this.editorcore.onRender(ct, position); + + if (this.resizable) { + this.resizeEl = new Roo.Resizable(this.wrap, { + pinned : true, + wrap: true, + dynamic : true, + minHeight : this.height, + height: this.height, + handles : this.resizable, + width: this.width, + listeners : { + resize : function(r, w, h) { + _t.onResize(w,h); // -something + } + } + }); + + } + this.createToolbar(this); + + + if(!this.width){ + this.setSize(this.wrap.getSize()); + } + if (this.resizeEl) { + this.resizeEl.resizeTo.defer(100, this.resizeEl,[ this.width,this.height ] ); + // should trigger onReize.. + } + + this.keyNav = new Roo.KeyNav(this.el, { + + "tab" : function(e){ + e.preventDefault(); + + var value = this.getValue(); + + var start = this.el.dom.selectionStart; + var end = this.el.dom.selectionEnd; + + if(!e.shiftKey){ + + this.setValue(value.substring(0, start) + "\t" + value.substring(end)); + this.el.dom.setSelectionRange(end + 1, end + 1); + return; + } + + var f = value.substring(0, start).split("\t"); + + if(f.pop().length != 0){ + return; + } + + this.setValue(f.join("\t") + value.substring(end)); + this.el.dom.setSelectionRange(start - 1, start - 1); + + }, + + "home" : function(e){ + e.preventDefault(); + + var curr = this.el.dom.selectionStart; + var lines = this.getValue().split("\n"); + + if(!lines.length){ + return; + } + + if(e.ctrlKey){ + this.el.dom.setSelectionRange(0, 0); + return; + } + + var pos = 0; + + for (var i = 0; i < lines.length;i++) { + pos += lines[i].length; + + if(i != 0){ + pos += 1; + } + + if(pos < curr){ + continue; + } + + pos -= lines[i].length; + + break; + } + + if(!e.shiftKey){ + this.el.dom.setSelectionRange(pos, pos); + return; + } + + this.el.dom.selectionStart = pos; + this.el.dom.selectionEnd = curr; + }, + + "end" : function(e){ + e.preventDefault(); + + var curr = this.el.dom.selectionStart; + var lines = this.getValue().split("\n"); + + if(!lines.length){ + return; + } + + if(e.ctrlKey){ + this.el.dom.setSelectionRange(this.getValue().length, this.getValue().length); + return; + } + + var pos = 0; + + for (var i = 0; i < lines.length;i++) { + + pos += lines[i].length; + + if(i != 0){ + pos += 1; + } + + if(pos < curr){ + continue; + } + + break; + } + + if(!e.shiftKey){ + this.el.dom.setSelectionRange(pos, pos); + return; + } + + this.el.dom.selectionStart = curr; + this.el.dom.selectionEnd = pos; + }, + + scope : this, + + doRelay : function(foo, bar, hname){ + return Roo.KeyNav.prototype.doRelay.apply(this, arguments); + }, + + forceKeyDown: true + }); + +// if(this.autosave && this.w){ +// this.autoSaveFn = setInterval(this.autosave, 1000); +// } + }, + + // private + onResize : function(w, h) + { + Roo.form.HtmlEditor.superclass.onResize.apply(this, arguments); + var ew = false; + var eh = false; + + if(this.el ){ + if(typeof w == 'number'){ + var aw = w - this.wrap.getFrameWidth('lr'); + this.el.setWidth(this.adjustWidth('textarea', aw)); + ew = aw; + } + if(typeof h == 'number'){ + var tbh = 0; + for (var i =0; i < this.toolbars.length;i++) { + // fixme - ask toolbars for heights? + tbh += this.toolbars[i].tb.el.getHeight(); + if (this.toolbars[i].footer) { + tbh += this.toolbars[i].footer.el.getHeight(); + } + } + + + + + var ah = h - this.wrap.getFrameWidth('tb') - tbh;// this.tb.el.getHeight(); + ah -= 5; // knock a few pixes off for look.. +// Roo.log(ah); + this.el.setHeight(this.adjustWidth('textarea', ah)); + var eh = ah; + } + } + Roo.log('onResize:' + [w,h,ew,eh].join(',') ); + this.editorcore.onResize(ew,eh); + + }, + + /** + * Toggles the editor between standard and source edit mode. + * @param {Boolean} sourceEdit (optional) True for source edit, false for standard + */ + toggleSourceEdit : function(sourceEditMode) + { + this.editorcore.toggleSourceEdit(sourceEditMode); + + if(this.editorcore.sourceEditMode){ + Roo.log('editor - showing textarea'); + +// Roo.log('in'); +// Roo.log(this.syncValue()); + this.editorcore.syncValue(); + this.el.removeClass('x-hidden'); + this.el.dom.removeAttribute('tabIndex'); + this.el.focus(); + + for (var i = 0; i < this.toolbars.length; i++) { + if(this.toolbars[i] instanceof Roo.form.HtmlEditor.ToolbarContext){ + this.toolbars[i].tb.hide(); + this.toolbars[i].footer.hide(); + } + } + + }else{ + Roo.log('editor - hiding textarea'); +// Roo.log('out') +// Roo.log(this.pushValue()); + this.editorcore.pushValue(); + + this.el.addClass('x-hidden'); + this.el.dom.setAttribute('tabIndex', -1); + + for (var i = 0; i < this.toolbars.length; i++) { + if(this.toolbars[i] instanceof Roo.form.HtmlEditor.ToolbarContext){ + this.toolbars[i].tb.show(); + this.toolbars[i].footer.show(); + } + } + + //this.deferFocus(); + } + + this.setSize(this.wrap.getSize()); + this.onResize(this.wrap.getSize().width, this.wrap.getSize().height); + + this.fireEvent('editmodechange', this, this.editorcore.sourceEditMode); + }, + + // private (for BoxComponent) + adjustSize : Roo.BoxComponent.prototype.adjustSize, + + // private (for BoxComponent) + getResizeEl : function(){ + return this.wrap; + }, + + // private (for BoxComponent) + getPositionEl : function(){ + return this.wrap; + }, + + // private + initEvents : function(){ + this.originalValue = this.getValue(); + }, + + /** + * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide + * @method + */ + markInvalid : Roo.emptyFn, + /** + * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide + * @method + */ + clearInvalid : Roo.emptyFn, + + setValue : function(v){ + Roo.form.HtmlEditor.superclass.setValue.call(this, v); + this.editorcore.pushValue(); + }, + + + // private + deferFocus : function(){ + this.focus.defer(10, this); + }, + + // doc'ed in Field + focus : function(){ + this.editorcore.focus(); + + }, + + + // private + onDestroy : function(){ + + + + if(this.rendered){ + + for (var i =0; i < this.toolbars.length;i++) { + // fixme - ask toolbars for heights? + this.toolbars[i].onDestroy(); + } + + this.wrap.dom.innerHTML = ''; + this.wrap.remove(); + } + }, + + // private + onFirstFocus : function(){ + //Roo.log("onFirstFocus"); + this.editorcore.onFirstFocus(); + for (var i =0; i < this.toolbars.length;i++) { + this.toolbars[i].onFirstFocus(); + } + + }, + + // private + syncValue : function() + { + this.editorcore.syncValue(); + }, + + pushValue : function() + { + this.editorcore.pushValue(); + }, + + setStylesheets : function(stylesheets) + { + this.editorcore.setStylesheets(stylesheets); + }, + + removeStylesheets : function() + { + this.editorcore.removeStylesheets(); + } + + + // hide stuff that is not compatible + /** + * @event blur + * @hide + */ + /** + * @event change + * @hide + */ + /** + * @event focus + * @hide + */ + /** + * @event specialkey + * @hide + */ + /** + * @cfg {String} fieldClass @hide + */ + /** + * @cfg {String} focusClass @hide + */ + /** + * @cfg {String} autoCreate @hide + */ + /** + * @cfg {String} inputType @hide + */ + /** + * @cfg {String} invalidClass @hide + */ + /** + * @cfg {String} invalidText @hide + */ + /** + * @cfg {String} msgFx @hide + */ + /** + * @cfg {String} validateOnBlur @hide + */ +}); + + \ No newline at end of file diff --git a/docs2/src/Roo_form_HtmlEditor_ToolbarContext.js.html b/docs2/src/Roo_form_HtmlEditor_ToolbarContext.js.html new file mode 100644 index 0000000000..a5e3869eb7 --- /dev/null +++ b/docs2/src/Roo_form_HtmlEditor_ToolbarContext.js.html @@ -0,0 +1,798 @@ +/home/alan/gitlive/roojs1/Roo/form/HtmlEditor/ToolbarContext.js// <script type="text/javascript"> +/* + * Based on + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + + */ + + +/** + * @class Roo.form.HtmlEditor.ToolbarContext + * Context Toolbar + * + * Usage: + * + new Roo.form.HtmlEditor({ + .... + toolbars : [ + { xtype: 'ToolbarStandard', styles : {} } + { xtype: 'ToolbarContext', disable : {} } + ] +}) + + + * + * @config : {Object} disable List of elements to disable.. (not done yet.) + * @config : {Object} styles Map of styles available. + * + */ + +Roo.form.HtmlEditor.ToolbarContext = function(config) +{ + + Roo.apply(this, config); + //Roo.form.HtmlEditorToolbar1.superclass.constructor.call(this, editor.wrap.dom.firstChild, [], config); + // dont call parent... till later. + this.styles = this.styles || {}; +} + + + +Roo.form.HtmlEditor.ToolbarContext.types = { + 'IMG' : { + width : { + title: "Width", + width: 40 + }, + height: { + title: "Height", + width: 40 + }, + align: { + title: "Align", + opts : [ [""],[ "left"],[ "right"],[ "center"],[ "top"]], + width : 80 + + }, + border: { + title: "Border", + width: 40 + }, + alt: { + title: "Alt", + width: 120 + }, + src : { + title: "Src", + width: 220 + } + + }, + 'A' : { + name : { + title: "Name", + width: 50 + }, + target: { + title: "Target", + width: 120 + }, + href: { + title: "Href", + width: 220 + } // border? + + }, + 'TABLE' : { + rows : { + title: "Rows", + width: 20 + }, + cols : { + title: "Cols", + width: 20 + }, + width : { + title: "Width", + width: 40 + }, + height : { + title: "Height", + width: 40 + }, + border : { + title: "Border", + width: 20 + } + }, + 'TD' : { + width : { + title: "Width", + width: 40 + }, + height : { + title: "Height", + width: 40 + }, + align: { + title: "Align", + opts : [[""],[ "left"],[ "center"],[ "right"],[ "justify"],[ "char"]], + width: 80 + }, + valign: { + title: "Valign", + opts : [[""],[ "top"],[ "middle"],[ "bottom"],[ "baseline"]], + width: 80 + }, + colspan: { + title: "Colspan", + width: 20 + + }, + 'font-family' : { + title : "Font", + style : 'fontFamily', + displayField: 'display', + optname : 'font-family', + width: 140 + } + }, + 'INPUT' : { + name : { + title: "name", + width: 120 + }, + value : { + title: "Value", + width: 120 + }, + width : { + title: "Width", + width: 40 + } + }, + 'LABEL' : { + 'for' : { + title: "For", + width: 120 + } + }, + 'TEXTAREA' : { + name : { + title: "name", + width: 120 + }, + rows : { + title: "Rows", + width: 20 + }, + cols : { + title: "Cols", + width: 20 + } + }, + 'SELECT' : { + name : { + title: "name", + width: 120 + }, + selectoptions : { + title: "Options", + width: 200 + } + }, + + // should we really allow this?? + // should this just be + 'BODY' : { + title : { + title: "Title", + width: 200, + disabled : true + } + }, + 'SPAN' : { + 'font-family' : { + title : "Font", + style : 'fontFamily', + displayField: 'display', + optname : 'font-family', + width: 140 + } + }, + 'DIV' : { + 'font-family' : { + title : "Font", + style : 'fontFamily', + displayField: 'display', + optname : 'font-family', + width: 140 + } + }, + 'P' : { + 'font-family' : { + title : "Font", + style : 'fontFamily', + displayField: 'display', + optname : 'font-family', + width: 140 + } + }, + + '*' : { + // empty.. + } + +}; + +// this should be configurable.. - you can either set it up using stores, or modify options somehwere.. +Roo.form.HtmlEditor.ToolbarContext.stores = false; + +Roo.form.HtmlEditor.ToolbarContext.options = { + 'font-family' : [ + [ 'Helvetica,Arial,sans-serif', 'Helvetica'], + [ 'Courier New', 'Courier New'], + [ 'Tahoma', 'Tahoma'], + [ 'Times New Roman,serif', 'Times'], + [ 'Verdana','Verdana' ] + ] +}; + +// fixme - these need to be configurable.. + + +//Roo.form.HtmlEditor.ToolbarContext.types + + +Roo.apply(Roo.form.HtmlEditor.ToolbarContext.prototype, { + + tb: false, + + rendered: false, + + editor : false, + editorcore : false, + /** + * @cfg {Object} disable List of toolbar elements to disable + + */ + disable : false, + /** + * @cfg {Object} styles List of styles + * eg. { '*' : [ 'headline' ] , 'TD' : [ 'underline', 'double-underline' ] } + * + * These must be defined in the page, so they get rendered correctly.. + * .headline { } + * TD.underline { } + * + */ + styles : false, + + options: false, + + toolbars : false, + + init : function(editor) + { + this.editor = editor; + this.editorcore = editor.editorcore ? editor.editorcore : editor; + var editorcore = this.editorcore; + + var fid = editorcore.frameId; + var etb = this; + function btn(id, toggle, handler){ + var xid = fid + '-'+ id ; + return { + id : xid, + cmd : id, + cls : 'x-btn-icon x-edit-'+id, + enableToggle:toggle !== false, + scope: editorcore, // was editor... + handler:handler||editorcore.relayBtnCmd, + clickEvent:'mousedown', + tooltip: etb.buttonTips[id] || undefined, ///tips ??? + tabIndex:-1 + }; + } + // create a new element. + var wdiv = editor.wrap.createChild({ + tag: 'div' + }, editor.wrap.dom.firstChild.nextSibling, true); + + // can we do this more than once?? + + // stop form submits + + + // disable everything... + var ty= Roo.form.HtmlEditor.ToolbarContext.types; + this.toolbars = {}; + + for (var i in ty) { + + this.toolbars[i] = this.buildToolbar(ty[i],i); + } + this.tb = this.toolbars.BODY; + this.tb.el.show(); + this.buildFooter(); + this.footer.show(); + editor.on('hide', function( ) { this.footer.hide() }, this); + editor.on('show', function( ) { this.footer.show() }, this); + + + this.rendered = true; + + // the all the btns; + editor.on('editorevent', this.updateToolbar, this); + // other toolbars need to implement this.. + //editor.on('editmodechange', this.updateToolbar, this); + }, + + + + /** + * Protected method that will not generally be called directly. It triggers + * a toolbar update by reading the markup state of the current selection in the editor. + * + * Note you can force an update by calling on('editorevent', scope, false) + */ + updateToolbar: function(editor,ev,sel){ + + //Roo.log(ev); + // capture mouse up - this is handy for selecting images.. + // perhaps should go somewhere else... + if(!this.editorcore.activated){ + this.editor.onFirstFocus(); + return; + } + + + + // http://developer.yahoo.com/yui/docs/simple-editor.js.html + // selectNode - might want to handle IE? + if (ev && + (ev.type == 'mouseup' || ev.type == 'click' ) && + ev.target && ev.target.tagName == 'IMG') { + // they have click on an image... + // let's see if we can change the selection... + sel = ev.target; + + var nodeRange = sel.ownerDocument.createRange(); + try { + nodeRange.selectNode(sel); + } catch (e) { + nodeRange.selectNodeContents(sel); + } + //nodeRange.collapse(true); + var s = this.editorcore.win.getSelection(); + s.removeAllRanges(); + s.addRange(nodeRange); + } + + + var updateFooter = sel ? false : true; + + + var ans = this.editorcore.getAllAncestors(); + + // pick + var ty= Roo.form.HtmlEditor.ToolbarContext.types; + + if (!sel) { + sel = ans.length ? (ans[0] ? ans[0] : ans[1]) : this.editorcore.doc.body; + sel = sel ? sel : this.editorcore.doc.body; + sel = sel.tagName.length ? sel : this.editorcore.doc.body; + + } + // pick a menu that exists.. + var tn = sel.tagName.toUpperCase(); + //sel = typeof(ty[tn]) != 'undefined' ? sel : this.editor.doc.body; + + tn = sel.tagName.toUpperCase(); + + var lastSel = this.tb.selectedNode; + + this.tb.selectedNode = sel; + + // if current menu does not match.. + + if ((this.tb.name != tn) || (lastSel != this.tb.selectedNode) || ev === false) { + + this.tb.el.hide(); + ///console.log("show: " + tn); + this.tb = typeof(ty[tn]) != 'undefined' ? this.toolbars[tn] : this.toolbars['*']; + this.tb.el.show(); + // update name + this.tb.items.first().el.innerHTML = tn + ':&nbsp;'; + + + // update attributes + if (this.tb.fields) { + this.tb.fields.each(function(e) { + if (e.stylename) { + e.setValue(sel.style[e.stylename]); + return; + } + e.setValue(sel.getAttribute(e.attrname)); + }); + } + + var hasStyles = false; + for(var i in this.styles) { + hasStyles = true; + break; + } + + // update styles + if (hasStyles) { + var st = this.tb.fields.item(0); + + st.store.removeAll(); + + + var cn = sel.className.split(/\s+/); + + var avs = []; + if (this.styles['*']) { + + Roo.each(this.styles['*'], function(v) { + avs.push( [ v , cn.indexOf(v) > -1 ? 1 : 0 ] ); + }); + } + if (this.styles[tn]) { + Roo.each(this.styles[tn], function(v) { + avs.push( [ v , cn.indexOf(v) > -1 ? 1 : 0 ] ); + }); + } + + st.store.loadData(avs); + st.collapse(); + st.setValue(cn); + } + // flag our selected Node. + this.tb.selectedNode = sel; + + + Roo.menu.MenuMgr.hideAll(); + + } + + if (!updateFooter) { + //this.footDisp.dom.innerHTML = ''; + return; + } + // update the footer + // + var html = ''; + + this.footerEls = ans.reverse(); + Roo.each(this.footerEls, function(a,i) { + if (!a) { return; } + html += html.length ? ' &gt; ' : ''; + + html += '<span class="x-ed-loc-' + i + '">' + a.tagName + '</span>'; + + }); + + // + var sz = this.footDisp.up('td').getSize(); + this.footDisp.dom.style.width = (sz.width -10) + 'px'; + this.footDisp.dom.style.marginLeft = '5px'; + + this.footDisp.dom.style.overflow = 'hidden'; + + this.footDisp.dom.innerHTML = html; + + //this.editorsyncValue(); + }, + + + + + // private + onDestroy : function(){ + if(this.rendered){ + + this.tb.items.each(function(item){ + if(item.menu){ + item.menu.removeAll(); + if(item.menu.el){ + item.menu.el.destroy(); + } + } + item.destroy(); + }); + + } + }, + onFirstFocus: function() { + // need to do this for all the toolbars.. + this.tb.items.each(function(item){ + item.enable(); + }); + }, + buildToolbar: function(tlist, nm) + { + var editor = this.editor; + var editorcore = this.editorcore; + // create a new element. + var wdiv = editor.wrap.createChild({ + tag: 'div' + }, editor.wrap.dom.firstChild.nextSibling, true); + + + var tb = new Roo.Toolbar(wdiv); + // add the name.. + + tb.add(nm+ ":&nbsp;"); + + var styles = []; + for(var i in this.styles) { + styles.push(i); + } + + // styles... + if (styles && styles.length) { + + // this needs a multi-select checkbox... + tb.addField( new Roo.form.ComboBox({ + store: new Roo.data.SimpleStore({ + id : 'val', + fields: ['val', 'selected'], + data : [] + }), + name : '-roo-edit-className', + attrname : 'className', + displayField: 'val', + typeAhead: false, + mode: 'local', + editable : false, + triggerAction: 'all', + emptyText:'Select Style', + selectOnFocus:true, + width: 130, + listeners : { + 'select': function(c, r, i) { + // initial support only for on class per el.. + tb.selectedNode.className = r ? r.get('val') : ''; + editorcore.syncValue(); + } + } + + })); + } + + var tbc = Roo.form.HtmlEditor.ToolbarContext; + var tbops = tbc.options; + + for (var i in tlist) { + + var item = tlist[i]; + tb.add(item.title + ":&nbsp;"); + + + //optname == used so you can configure the options available.. + var opts = item.opts ? item.opts : false; + if (item.optname) { + opts = tbops[item.optname]; + + } + + if (opts) { + // opts == pulldown.. + tb.addField( new Roo.form.ComboBox({ + store: typeof(tbc.stores[i]) != 'undefined' ? Roo.factory(tbc.stores[i],Roo.data) : new Roo.data.SimpleStore({ + id : 'val', + fields: ['val', 'display'], + data : opts + }), + name : '-roo-edit-' + i, + attrname : i, + stylename : item.style ? item.style : false, + displayField: item.displayField ? item.displayField : 'val', + valueField : 'val', + typeAhead: false, + mode: typeof(tbc.stores[i]) != 'undefined' ? 'remote' : 'local', + editable : false, + triggerAction: 'all', + emptyText:'Select', + selectOnFocus:true, + width: item.width ? item.width : 130, + listeners : { + 'select': function(c, r, i) { + if (c.stylename) { + tb.selectedNode.style[c.stylename] = r.get('val'); + return; + } + tb.selectedNode.setAttribute(c.attrname, r.get('val')); + } + } + + })); + continue; + + + + tb.addField( new Roo.form.TextField({ + name: i, + width: 100, + //allowBlank:false, + value: '' + })); + continue; + } + tb.addField( new Roo.form.TextField({ + name: '-roo-edit-' + i, + attrname : i, + + width: item.width, + //allowBlank:true, + value: '', + listeners: { + 'change' : function(f, nv, ov) { + tb.selectedNode.setAttribute(f.attrname, nv); + editorcore.syncValue(); + } + } + })); + + } + + var _this = this; + + if(nm == 'BODY'){ + tb.addSeparator(); + + tb.addButton( { + text: 'Stylesheets', + + listeners : { + click : function () + { + _this.editor.fireEvent('stylesheetsclick', _this.editor); + } + } + }); + } + + tb.addFill(); + tb.addButton( { + text: 'Remove Tag', + + listeners : { + click : function () + { + // remove + // undo does not work. + + var sn = tb.selectedNode; + + var pn = sn.parentNode; + + var stn = sn.childNodes[0]; + var en = sn.childNodes[sn.childNodes.length - 1 ]; + while (sn.childNodes.length) { + var node = sn.childNodes[0]; + sn.removeChild(node); + //Roo.log(node); + pn.insertBefore(node, sn); + + } + pn.removeChild(sn); + var range = editorcore.createRange(); + + range.setStart(stn,0); + range.setEnd(en,0); //???? + //range.selectNode(sel); + + + var selection = editorcore.getSelection(); + selection.removeAllRanges(); + selection.addRange(range); + + + + //_this.updateToolbar(null, null, pn); + _this.updateToolbar(null, null, null); + _this.footDisp.dom.innerHTML = ''; + } + } + + + + + }); + + + tb.el.on('click', function(e){ + e.preventDefault(); // what does this do? + }); + tb.el.setVisibilityMode( Roo.Element.DISPLAY); + tb.el.hide(); + tb.name = nm; + // dont need to disable them... as they will get hidden + return tb; + + + }, + buildFooter : function() + { + + var fel = this.editor.wrap.createChild(); + this.footer = new Roo.Toolbar(fel); + // toolbar has scrolly on left / right? + var footDisp= new Roo.Toolbar.Fill(); + var _t = this; + this.footer.add( + { + text : '&lt;', + xtype: 'Button', + handler : function() { + _t.footDisp.scrollTo('left',0,true) + } + } + ); + this.footer.add( footDisp ); + this.footer.add( + { + text : '&gt;', + xtype: 'Button', + handler : function() { + // no animation.. + _t.footDisp.select('span').last().scrollIntoView(_t.footDisp,true); + } + } + ); + var fel = Roo.get(footDisp.el); + fel.addClass('x-editor-context'); + this.footDispWrap = fel; + this.footDispWrap.overflow = 'hidden'; + + this.footDisp = fel.createChild(); + this.footDispWrap.on('click', this.onContextClick, this) + + + }, + onContextClick : function (ev,dom) + { + ev.preventDefault(); + var cn = dom.className; + //Roo.log(cn); + if (!cn.match(/x-ed-loc-/)) { + return; + } + var n = cn.split('-').pop(); + var ans = this.footerEls; + var sel = ans[n]; + + // pick + var range = this.editorcore.createRange(); + + range.selectNodeContents(sel); + //range.selectNode(sel); + + + var selection = this.editorcore.getSelection(); + selection.removeAllRanges(); + selection.addRange(range); + + + + this.updateToolbar(null, null, sel); + + + } + + + + + +}); + + + + + + \ No newline at end of file diff --git a/docs2/src/Roo_form_HtmlEditor_ToolbarStandard.js.html b/docs2/src/Roo_form_HtmlEditor_ToolbarStandard.js.html new file mode 100644 index 0000000000..70b130d6ad --- /dev/null +++ b/docs2/src/Roo_form_HtmlEditor_ToolbarStandard.js.html @@ -0,0 +1,774 @@ +/home/alan/gitlive/roojs1/Roo/form/HtmlEditor/ToolbarStandard.js// <script type="text/javascript"> +/* + * Based on + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + + */ + +/** + * @class Roo.form.HtmlEditorToolbar1 + * Basic Toolbar + * + * Usage: + * + new Roo.form.HtmlEditor({ + .... + toolbars : [ + new Roo.form.HtmlEditorToolbar1({ + disable : { fonts: 1 , format: 1, ..., ... , ...], + btns : [ .... ] + }) + } + + * + * @cfg {Object} disable List of elements to disable.. + * @cfg {Array} btns List of additional buttons. + * + * + * NEEDS Extra CSS? + * .x-html-editor-tb .x-edit-none .x-btn-text { background: none; } + */ + +Roo.form.HtmlEditor.ToolbarStandard = function(config) +{ + + Roo.apply(this, config); + + // default disabled, based on 'good practice'.. + this.disable = this.disable || {}; + Roo.applyIf(this.disable, { + fontSize : true, + colors : true, + specialElements : true + }); + + + //Roo.form.HtmlEditorToolbar1.superclass.constructor.call(this, editor.wrap.dom.firstChild, [], config); + // dont call parent... till later. +} + +Roo.apply(Roo.form.HtmlEditor.ToolbarStandard.prototype, { + + tb: false, + + rendered: false, + + editor : false, + editorcore : false, + /** + * @cfg {Object} disable List of toolbar elements to disable + + */ + disable : false, + + + /** + * @cfg {String} createLinkText The default text for the create link prompt + */ + createLinkText : 'Please enter the URL for the link:', + /** + * @cfg {String} defaultLinkValue The default value for the create link prompt (defaults to http:/ /) + */ + defaultLinkValue : 'http:/'+'/', + + + /** + * @cfg {Array} fontFamilies An array of available font families + */ + fontFamilies : [ + 'Arial', + 'Courier New', + 'Tahoma', + 'Times New Roman', + 'Verdana' + ], + + specialChars : [ + "&#169;", + "&#174;", + "&#8482;", + "&#163;" , + // "&#8212;", + "&#8230;", + "&#247;" , + // "&#225;" , ?? a acute? + "&#8364;" , //Euro + // "&#8220;" , + // "&#8221;" , + // "&#8226;" , + "&#176;" // , // degrees + + // "&#233;" , // e ecute + // "&#250;" , // u ecute? + ], + + specialElements : [ + { + text: "Insert Table", + xtype: 'MenuItem', + xns : Roo.Menu, + ihtml : '<table><tr><td>Cell</td></tr></table>' + + }, + { + text: "Insert Image", + xtype: 'MenuItem', + xns : Roo.Menu, + ihtml : '<img src="about:blank"/>' + + } + + + ], + + + inputElements : [ + "form", "input:text", "input:hidden", "input:checkbox", "input:radio", "input:password", + "input:submit", "input:button", "select", "textarea", "label" ], + formats : [ + ["p"] , + ["h1"],["h2"],["h3"],["h4"],["h5"],["h6"], + ["pre"],[ "code"], + ["abbr"],[ "acronym"],[ "address"],[ "cite"],[ "samp"],[ "var"], + ['div'],['span'] + ], + + cleanStyles : [ + "font-size" + ], + /** + * @cfg {String} defaultFont default font to use. + */ + defaultFont: 'tahoma', + + fontSelect : false, + + + formatCombo : false, + + init : function(editor) + { + this.editor = editor; + this.editorcore = editor.editorcore ? editor.editorcore : editor; + var editorcore = this.editorcore; + + var _t = this; + + var fid = editorcore.frameId; + var etb = this; + function btn(id, toggle, handler){ + var xid = fid + '-'+ id ; + return { + id : xid, + cmd : id, + cls : 'x-btn-icon x-edit-'+id, + enableToggle:toggle !== false, + scope: _t, // was editor... + handler:handler||_t.relayBtnCmd, + clickEvent:'mousedown', + tooltip: etb.buttonTips[id] || undefined, ///tips ??? + tabIndex:-1 + }; + } + + + + var tb = new Roo.Toolbar(editor.wrap.dom.firstChild); + this.tb = tb; + // stop form submits + tb.el.on('click', function(e){ + e.preventDefault(); // what does this do? + }); + + if(!this.disable.font) { // && !Roo.isSafari){ + /* why no safari for fonts + editor.fontSelect = tb.el.createChild({ + tag:'select', + tabIndex: -1, + cls:'x-font-select', + html: this.createFontOptions() + }); + + editor.fontSelect.on('change', function(){ + var font = editor.fontSelect.dom.value; + editor.relayCmd('fontname', font); + editor.deferFocus(); + }, editor); + + tb.add( + editor.fontSelect.dom, + '-' + ); + */ + + }; + if(!this.disable.formats){ + this.formatCombo = new Roo.form.ComboBox({ + store: new Roo.data.SimpleStore({ + id : 'tag', + fields: ['tag'], + data : this.formats // from states.js + }), + blockFocus : true, + name : '', + //autoCreate : {tag: "div", size: "20"}, + displayField:'tag', + typeAhead: false, + mode: 'local', + editable : false, + triggerAction: 'all', + emptyText:'Add tag', + selectOnFocus:true, + width:135, + listeners : { + 'select': function(c, r, i) { + editorcore.insertTag(r.get('tag')); + editor.focus(); + } + } + + }); + tb.addField(this.formatCombo); + + } + + if(!this.disable.format){ + tb.add( + btn('bold'), + btn('italic'), + btn('underline'), + btn('strikethrough') + ); + }; + if(!this.disable.fontSize){ + tb.add( + '-', + + + btn('increasefontsize', false, editorcore.adjustFont), + btn('decreasefontsize', false, editorcore.adjustFont) + ); + }; + + + if(!this.disable.colors){ + tb.add( + '-', { + id:editorcore.frameId +'-forecolor', + cls:'x-btn-icon x-edit-forecolor', + clickEvent:'mousedown', + tooltip: this.buttonTips['forecolor'] || undefined, + tabIndex:-1, + menu : new Roo.menu.ColorMenu({ + allowReselect: true, + focus: Roo.emptyFn, + value:'000000', + plain:true, + selectHandler: function(cp, color){ + editorcore.execCmd('forecolor', Roo.isSafari || Roo.isIE ? '#'+color : color); + editor.deferFocus(); + }, + scope: editorcore, + clickEvent:'mousedown' + }) + }, { + id:editorcore.frameId +'backcolor', + cls:'x-btn-icon x-edit-backcolor', + clickEvent:'mousedown', + tooltip: this.buttonTips['backcolor'] || undefined, + tabIndex:-1, + menu : new Roo.menu.ColorMenu({ + focus: Roo.emptyFn, + value:'FFFFFF', + plain:true, + allowReselect: true, + selectHandler: function(cp, color){ + if(Roo.isGecko){ + editorcore.execCmd('useCSS', false); + editorcore.execCmd('hilitecolor', color); + editorcore.execCmd('useCSS', true); + editor.deferFocus(); + }else{ + editorcore.execCmd(Roo.isOpera ? 'hilitecolor' : 'backcolor', + Roo.isSafari || Roo.isIE ? '#'+color : color); + editor.deferFocus(); + } + }, + scope:editorcore, + clickEvent:'mousedown' + }) + } + ); + }; + // now add all the items... + + + if(!this.disable.alignments){ + tb.add( + '-', + btn('justifyleft'), + btn('justifycenter'), + btn('justifyright') + ); + }; + + //if(!Roo.isSafari){ + if(!this.disable.links){ + tb.add( + '-', + btn('createlink', false, this.createLink) /// MOVE TO HERE?!!?!?!?! + ); + }; + + if(!this.disable.lists){ + tb.add( + '-', + btn('insertorderedlist'), + btn('insertunorderedlist') + ); + } + if(!this.disable.sourceEdit){ + tb.add( + '-', + btn('sourceedit', true, function(btn){ + this.toggleSourceEdit(btn.pressed); + }) + ); + } + //} + + var smenu = { }; + // special menu.. - needs to be tidied up.. + if (!this.disable.special) { + smenu = { + text: "&#169;", + cls: 'x-edit-none', + + menu : { + items : [] + } + }; + for (var i =0; i < this.specialChars.length; i++) { + smenu.menu.items.push({ + + html: this.specialChars[i], + handler: function(a,b) { + editorcore.insertAtCursor(String.fromCharCode(a.html.replace('&#','').replace(';', ''))); + //editor.insertAtCursor(a.html); + + }, + tabIndex:-1 + }); + } + + + tb.add(smenu); + + + } + + var cmenu = { }; + if (!this.disable.cleanStyles) { + cmenu = { + cls: 'x-btn-icon x-btn-clear', + + menu : { + items : [] + } + }; + for (var i =0; i < this.cleanStyles.length; i++) { + cmenu.menu.items.push({ + actiontype : this.cleanStyles[i], + html: 'Remove ' + this.cleanStyles[i], + handler: function(a,b) { +// Roo.log(a); +// Roo.log(b); + var c = Roo.get(editorcore.doc.body); + c.select('[style]').each(function(s) { + s.dom.style.removeProperty(a.actiontype); + }); + editorcore.syncValue(); + }, + tabIndex:-1 + }); + } + cmenu.menu.items.push({ + actiontype : 'tablewidths', + html: 'Remove Table Widths', + handler: function(a,b) { + editorcore.cleanTableWidths(); + editorcore.syncValue(); + }, + tabIndex:-1 + }); + cmenu.menu.items.push({ + actiontype : 'word', + html: 'Remove MS Word Formating', + handler: function(a,b) { + editorcore.cleanWord(); + editorcore.syncValue(); + }, + tabIndex:-1 + }); + + cmenu.menu.items.push({ + actiontype : 'all', + html: 'Remove All Styles', + handler: function(a,b) { + + var c = Roo.get(editorcore.doc.body); + c.select('[style]').each(function(s) { + s.dom.removeAttribute('style'); + }); + editorcore.syncValue(); + }, + tabIndex:-1 + }); + + cmenu.menu.items.push({ + actiontype : 'all', + html: 'Remove All CSS Classes', + handler: function(a,b) { + + var c = Roo.get(editorcore.doc.body); + c.select('[class]').each(function(s) { + s.dom.className = ''; + }); + editorcore.syncValue(); + }, + tabIndex:-1 + }); + + cmenu.menu.items.push({ + actiontype : 'tidy', + html: 'Tidy HTML Source', + handler: function(a,b) { + editorcore.doc.body.innerHTML = editorcore.domToHTML(); + editorcore.syncValue(); + }, + tabIndex:-1 + }); + + + tb.add(cmenu); + } + + if (!this.disable.specialElements) { + var semenu = { + text: "Other;", + cls: 'x-edit-none', + menu : { + items : [] + } + }; + for (var i =0; i < this.specialElements.length; i++) { + semenu.menu.items.push( + Roo.apply({ + handler: function(a,b) { + editor.insertAtCursor(this.ihtml); + } + }, this.specialElements[i]) + ); + + } + + tb.add(semenu); + + + } + + + if (this.btns) { + for(var i =0; i< this.btns.length;i++) { + var b = Roo.factory(this.btns[i],Roo.form); + b.cls = 'x-edit-none'; + + if(typeof(this.btns[i].cls) != 'undefined' && this.btns[i].cls.indexOf('x-init-enable') !== -1){ + b.cls += ' x-init-enable'; + } + + b.scope = editorcore; + tb.add(b); + } + + } + + + + // disable everything... + + this.tb.items.each(function(item){ + + if( + item.id != editorcore.frameId+ '-sourceedit' && + (typeof(item.cls) != 'undefined' && item.cls.indexOf('x-init-enable') === -1) + ){ + + item.disable(); + } + }); + this.rendered = true; + + // the all the btns; + editor.on('editorevent', this.updateToolbar, this); + // other toolbars need to implement this.. + //editor.on('editmodechange', this.updateToolbar, this); + }, + + + relayBtnCmd : function(btn) { + this.editorcore.relayCmd(btn.cmd); + }, + // private used internally + createLink : function(){ + Roo.log("create link?"); + var url = prompt(this.createLinkText, this.defaultLinkValue); + if(url && url != 'http:/'+'/'){ + this.editorcore.relayCmd('createlink', url); + } + }, + + + /** + * Protected method that will not generally be called directly. It triggers + * a toolbar update by reading the markup state of the current selection in the editor. + */ + updateToolbar: function(){ + + if(!this.editorcore.activated){ + this.editor.onFirstFocus(); + return; + } + + var btns = this.tb.items.map, + doc = this.editorcore.doc, + frameId = this.editorcore.frameId; + + if(!this.disable.font && !Roo.isSafari){ + /* + var name = (doc.queryCommandValue('FontName')||this.editor.defaultFont).toLowerCase(); + if(name != this.fontSelect.dom.value){ + this.fontSelect.dom.value = name; + } + */ + } + if(!this.disable.format){ + btns[frameId + '-bold'].toggle(doc.queryCommandState('bold')); + btns[frameId + '-italic'].toggle(doc.queryCommandState('italic')); + btns[frameId + '-underline'].toggle(doc.queryCommandState('underline')); + btns[frameId + '-strikethrough'].toggle(doc.queryCommandState('strikethrough')); + } + if(!this.disable.alignments){ + btns[frameId + '-justifyleft'].toggle(doc.queryCommandState('justifyleft')); + btns[frameId + '-justifycenter'].toggle(doc.queryCommandState('justifycenter')); + btns[frameId + '-justifyright'].toggle(doc.queryCommandState('justifyright')); + } + if(!Roo.isSafari && !this.disable.lists){ + btns[frameId + '-insertorderedlist'].toggle(doc.queryCommandState('insertorderedlist')); + btns[frameId + '-insertunorderedlist'].toggle(doc.queryCommandState('insertunorderedlist')); + } + + var ans = this.editorcore.getAllAncestors(); + if (this.formatCombo) { + + + var store = this.formatCombo.store; + this.formatCombo.setValue(""); + for (var i =0; i < ans.length;i++) { + if (ans[i] && store.query('tag',ans[i].tagName.toLowerCase(), false).length) { + // select it.. + this.formatCombo.setValue(ans[i].tagName.toLowerCase()); + break; + } + } + } + + + + // hides menus... - so this cant be on a menu... + Roo.menu.MenuMgr.hideAll(); + + //this.editorsyncValue(); + }, + + + createFontOptions : function(){ + var buf = [], fs = this.fontFamilies, ff, lc; + + + + for(var i = 0, len = fs.length; i< len; i++){ + ff = fs[i]; + lc = ff.toLowerCase(); + buf.push( + '<option value="',lc,'" style="font-family:',ff,';"', + (this.defaultFont == lc ? ' selected="true">' : '>'), + ff, + '</option>' + ); + } + return buf.join(''); + }, + + toggleSourceEdit : function(sourceEditMode){ + + Roo.log("toolbar toogle"); + if(sourceEditMode === undefined){ + sourceEditMode = !this.sourceEditMode; + } + this.sourceEditMode = sourceEditMode === true; + var btn = this.tb.items.get(this.editorcore.frameId +'-sourceedit'); + // just toggle the button? + if(btn.pressed !== this.sourceEditMode){ + btn.toggle(this.sourceEditMode); + return; + } + + if(sourceEditMode){ + Roo.log("disabling buttons"); + this.tb.items.each(function(item){ + if(item.cmd != 'sourceedit' && (typeof(item.cls) != 'undefined' && item.cls.indexOf('x-init-enable') === -1)){ + item.disable(); + } + }); + + }else{ + Roo.log("enabling buttons"); + if(this.editorcore.initialized){ + this.tb.items.each(function(item){ + item.enable(); + }); + } + + } + Roo.log("calling toggole on editor"); + // tell the editor that it's been pressed.. + this.editor.toggleSourceEdit(sourceEditMode); + + }, + /** + * Object collection of toolbar tooltips for the buttons in the editor. The key + * is the command id associated with that button and the value is a valid QuickTips object. + * For example: +<pre><code> +{ + bold : { + title: 'Bold (Ctrl+B)', + text: 'Make the selected text bold.', + cls: 'x-html-editor-tip' + }, + italic : { + title: 'Italic (Ctrl+I)', + text: 'Make the selected text italic.', + cls: 'x-html-editor-tip' + }, + ... +</code></pre> + * @type Object + */ + buttonTips : { + bold : { + title: 'Bold (Ctrl+B)', + text: 'Make the selected text bold.', + cls: 'x-html-editor-tip' + }, + italic : { + title: 'Italic (Ctrl+I)', + text: 'Make the selected text italic.', + cls: 'x-html-editor-tip' + }, + underline : { + title: 'Underline (Ctrl+U)', + text: 'Underline the selected text.', + cls: 'x-html-editor-tip' + }, + strikethrough : { + title: 'Strikethrough', + text: 'Strikethrough the selected text.', + cls: 'x-html-editor-tip' + }, + increasefontsize : { + title: 'Grow Text', + text: 'Increase the font size.', + cls: 'x-html-editor-tip' + }, + decreasefontsize : { + title: 'Shrink Text', + text: 'Decrease the font size.', + cls: 'x-html-editor-tip' + }, + backcolor : { + title: 'Text Highlight Color', + text: 'Change the background color of the selected text.', + cls: 'x-html-editor-tip' + }, + forecolor : { + title: 'Font Color', + text: 'Change the color of the selected text.', + cls: 'x-html-editor-tip' + }, + justifyleft : { + title: 'Align Text Left', + text: 'Align text to the left.', + cls: 'x-html-editor-tip' + }, + justifycenter : { + title: 'Center Text', + text: 'Center text in the editor.', + cls: 'x-html-editor-tip' + }, + justifyright : { + title: 'Align Text Right', + text: 'Align text to the right.', + cls: 'x-html-editor-tip' + }, + insertunorderedlist : { + title: 'Bullet List', + text: 'Start a bulleted list.', + cls: 'x-html-editor-tip' + }, + insertorderedlist : { + title: 'Numbered List', + text: 'Start a numbered list.', + cls: 'x-html-editor-tip' + }, + createlink : { + title: 'Hyperlink', + text: 'Make the selected text a hyperlink.', + cls: 'x-html-editor-tip' + }, + sourceedit : { + title: 'Source Edit', + text: 'Switch to source editing mode.', + cls: 'x-html-editor-tip' + } + }, + // private + onDestroy : function(){ + if(this.rendered){ + + this.tb.items.each(function(item){ + if(item.menu){ + item.menu.removeAll(); + if(item.menu.el){ + item.menu.el.destroy(); + } + } + item.destroy(); + }); + + } + }, + onFirstFocus: function() { + this.tb.items.each(function(item){ + item.enable(); + }); + } +}); + + + + + \ No newline at end of file diff --git a/docs2/src/Roo_form_Layout.js.html b/docs2/src/Roo_form_Layout.js.html new file mode 100644 index 0000000000..61594f6249 --- /dev/null +++ b/docs2/src/Roo_form_Layout.js.html @@ -0,0 +1,310 @@ +/home/alan/gitlive/roojs1/Roo/form/Layout.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.form.Layout + * @extends Roo.Component + * Creates a container for layout and rendering of fields in an {@link Roo.form.Form}. + * @constructor + * @param {Object} config Configuration options + */ +Roo.form.Layout = function(config){ + var xitems = []; + if (config.items) { + xitems = config.items; + delete config.items; + } + Roo.form.Layout.superclass.constructor.call(this, config); + this.stack = []; + Roo.each(xitems, this.addxtype, this); + +}; + +Roo.extend(Roo.form.Layout, Roo.Component, { + /** + * @cfg {String/Object} autoCreate + * A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'}) + */ + /** + * @cfg {String/Object/Function} style + * A style specification string, e.g. "width:100px", or object in the form {width:"100px"}, or + * a function which returns such a specification. + */ + /** + * @cfg {String} labelAlign + * Valid values are "left," "top" and "right" (defaults to "left") + */ + /** + * @cfg {Number} labelWidth + * Fixed width in pixels of all field labels (defaults to undefined) + */ + /** + * @cfg {Boolean} clear + * True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true) + */ + clear : true, + /** + * @cfg {String} labelSeparator + * The separator to use after field labels (defaults to ':') + */ + labelSeparator : ':', + /** + * @cfg {Boolean} hideLabels + * True to suppress the display of field labels in this layout (defaults to false) + */ + hideLabels : false, + + // private + defaultAutoCreate : {tag: 'div', cls: 'x-form-ct'}, + + isLayout : true, + + // private + onRender : function(ct, position){ + if(this.el){ // from markup + this.el = Roo.get(this.el); + }else { // generate + var cfg = this.getAutoCreate(); + this.el = ct.createChild(cfg, position); + } + if(this.style){ + this.el.applyStyles(this.style); + } + if(this.labelAlign){ + this.el.addClass('x-form-label-'+this.labelAlign); + } + if(this.hideLabels){ + this.labelStyle = "display:none"; + this.elementStyle = "padding-left:0;"; + }else{ + if(typeof this.labelWidth == 'number'){ + this.labelStyle = "width:"+this.labelWidth+"px;"; + this.elementStyle = "padding-left:"+((this.labelWidth+(typeof this.labelPad == 'number' ? this.labelPad : 5))+'px')+";"; + } + if(this.labelAlign == 'top'){ + this.labelStyle = "width:auto;"; + this.elementStyle = "padding-left:0;"; + } + } + var stack = this.stack; + var slen = stack.length; + if(slen > 0){ + if(!this.fieldTpl){ + var t = new Roo.Template( + '<div class="x-form-item {5}">', + '<label for="{0}" style="{2}">{1}{4}</label>', + '<div class="x-form-element" id="x-form-el-{0}" style="{3}">', + '</div>', + '</div><div class="x-form-clear-left"></div>' + ); + t.disableFormats = true; + t.compile(); + Roo.form.Layout.prototype.fieldTpl = t; + } + for(var i = 0; i < slen; i++) { + if(stack[i].isFormField){ + this.renderField(stack[i]); + }else{ + this.renderComponent(stack[i]); + } + } + } + if(this.clear){ + this.el.createChild({cls:'x-form-clear'}); + } + }, + + // private + renderField : function(f){ + f.fieldEl = Roo.get(this.fieldTpl.append(this.el, [ + f.id, //0 + f.fieldLabel, //1 + f.labelStyle||this.labelStyle||'', //2 + this.elementStyle||'', //3 + typeof f.labelSeparator == 'undefined' ? this.labelSeparator : f.labelSeparator, //4 + f.itemCls||this.itemCls||'' //5 + ], true).getPrevSibling()); + }, + + // private + renderComponent : function(c){ + c.render(c.isLayout ? this.el : this.el.createChild()); + }, + /** + * Adds a object form elements (using the xtype property as the factory method.) + * Valid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column + * @param {Object} config + */ + addxtype : function(o) + { + // create the lement. + o.form = this.form; + var fe = Roo.factory(o, Roo.form); + this.form.allItems.push(fe); + this.stack.push(fe); + + if (fe.isFormField) { + this.form.items.add(fe); + } + + return fe; + } +}); + +/** + * @class Roo.form.Column + * @extends Roo.form.Layout + * Creates a column container for layout and rendering of fields in an {@link Roo.form.Form}. + * @constructor + * @param {Object} config Configuration options + */ +Roo.form.Column = function(config){ + Roo.form.Column.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.form.Column, Roo.form.Layout, { + /** + * @cfg {Number/String} width + * The fixed width of the column in pixels or CSS value (defaults to "auto") + */ + /** + * @cfg {String/Object} autoCreate + * A DomHelper element spec used to autocreate the column (defaults to {tag: 'div', cls: 'x-form-ct x-form-column'}) + */ + + // private + defaultAutoCreate : {tag: 'div', cls: 'x-form-ct x-form-column'}, + + // private + onRender : function(ct, position){ + Roo.form.Column.superclass.onRender.call(this, ct, position); + if(this.width){ + this.el.setWidth(this.width); + } + } +}); + + +/** + * @class Roo.form.Row + * @extends Roo.form.Layout + * Creates a row container for layout and rendering of fields in an {@link Roo.form.Form}. + * @constructor + * @param {Object} config Configuration options + */ + + +Roo.form.Row = function(config){ + Roo.form.Row.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.form.Row, Roo.form.Layout, { + /** + * @cfg {Number/String} width + * The fixed width of the column in pixels or CSS value (defaults to "auto") + */ + /** + * @cfg {Number/String} height + * The fixed height of the column in pixels or CSS value (defaults to "auto") + */ + defaultAutoCreate : {tag: 'div', cls: 'x-form-ct x-form-row'}, + + padWidth : 20, + // private + onRender : function(ct, position){ + //console.log('row render'); + if(!this.rowTpl){ + var t = new Roo.Template( + '<div class="x-form-item {5}" style="float:left;width:{6}px">', + '<label for="{0}" style="{2}">{1}{4}</label>', + '<div class="x-form-element" id="x-form-el-{0}" style="{3}">', + '</div>', + '</div>' + ); + t.disableFormats = true; + t.compile(); + Roo.form.Layout.prototype.rowTpl = t; + } + this.fieldTpl = this.rowTpl; + + //console.log('lw' + this.labelWidth +', la:' + this.labelAlign); + var labelWidth = 100; + + if ((this.labelAlign != 'top')) { + if (typeof this.labelWidth == 'number') { + labelWidth = this.labelWidth + } + this.padWidth = 20 + labelWidth; + + } + + Roo.form.Column.superclass.onRender.call(this, ct, position); + if(this.width){ + this.el.setWidth(this.width); + } + if(this.height){ + this.el.setHeight(this.height); + } + }, + + // private + renderField : function(f){ + f.fieldEl = this.fieldTpl.append(this.el, [ + f.id, f.fieldLabel, + f.labelStyle||this.labelStyle||'', + this.elementStyle||'', + typeof f.labelSeparator == 'undefined' ? this.labelSeparator : f.labelSeparator, + f.itemCls||this.itemCls||'', + f.width ? f.width + this.padWidth : 160 + this.padWidth + ],true); + } +}); + + +/** + * @class Roo.form.FieldSet + * @extends Roo.form.Layout + * Creates a fieldset container for layout and rendering of fields in an {@link Roo.form.Form}. + * @constructor + * @param {Object} config Configuration options + */ +Roo.form.FieldSet = function(config){ + Roo.form.FieldSet.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.form.FieldSet, Roo.form.Layout, { + /** + * @cfg {String} legend + * The text to display as the legend for the FieldSet (defaults to '') + */ + /** + * @cfg {String/Object} autoCreate + * A DomHelper element spec used to autocreate the fieldset (defaults to {tag: 'fieldset', cn: {tag:'legend'}}) + */ + + // private + defaultAutoCreate : {tag: 'fieldset', cn: {tag:'legend'}}, + + // private + onRender : function(ct, position){ + Roo.form.FieldSet.superclass.onRender.call(this, ct, position); + if(this.legend){ + this.setLegend(this.legend); + } + }, + + // private + setLegend : function(text){ + if(this.rendered){ + this.el.child('legend').update(text); + } + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_form_MonthField.js.html b/docs2/src/Roo_form_MonthField.js.html new file mode 100644 index 0000000000..bfe380e4f2 --- /dev/null +++ b/docs2/src/Roo_form_MonthField.js.html @@ -0,0 +1,407 @@ +/home/alan/gitlive/roojs1/Roo/form/MonthField.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.form.MonthField + * @extends Roo.form.TriggerField + * Provides a date input field with a {@link Roo.DatePicker} dropdown and automatic date validation. +* @constructor +* Create a new MonthField +* @param {Object} config + */ +Roo.form.MonthField = function(config){ + + Roo.form.MonthField.superclass.constructor.call(this, config); + + this.addEvents({ + + /** + * @event select + * Fires when a date is selected + * @param {Roo.form.MonthFieeld} combo This combo box + * @param {Date} date The date selected + */ + 'select' : true + + }); + + + if(typeof this.minValue == "string") { + this.minValue = this.parseDate(this.minValue); + } + if(typeof this.maxValue == "string") { + this.maxValue = this.parseDate(this.maxValue); + } + this.ddMatch = null; + if(this.disabledDates){ + var dd = this.disabledDates; + var re = "(?:"; + for(var i = 0; i < dd.length; i++){ + re += dd[i]; + if(i != dd.length-1) { + re += "|"; + } + } + this.ddMatch = new RegExp(re + ")"); + } +}; + +Roo.extend(Roo.form.MonthField, Roo.form.TriggerField, { + /** + * @cfg {String} format + * The default date format string which can be overriden for localization support. The format must be + * valid according to {@link Date#parseDate} (defaults to 'm/d/y'). + */ + format : "M Y", + /** + * @cfg {String} altFormats + * Multiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined + * format (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d'). + */ + altFormats : "M Y|m/Y|m-y|m-Y|my|mY", + /** + * @cfg {Array} disabledDays + * An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null). + */ + disabledDays : [0,1,2,3,4,5,6], + /** + * @cfg {String} disabledDaysText + * The tooltip to display when the date falls on a disabled day (defaults to 'Disabled') + */ + disabledDaysText : "Disabled", + /** + * @cfg {Array} disabledDates + * An array of "dates" to disable, as strings. These strings will be used to build a dynamic regular + * expression so they are very powerful. Some examples: + * <ul> + * <li>["03/08/2003", "09/16/2003"] would disable those exact dates</li> + * <li>["03/08", "09/16"] would disable those days for every year</li> + * <li>["^03/08"] would only match the beginning (useful if you are using short years)</li> + * <li>["03/../2006"] would disable every day in March 2006</li> + * <li>["^03"] would disable every day in every March</li> + * </ul> + * In order to support regular expressions, if you are using a date format that has "." in it, you will have to + * escape the dot when restricting dates. For example: ["03\\.08\\.03"]. + */ + disabledDates : null, + /** + * @cfg {String} disabledDatesText + * The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled') + */ + disabledDatesText : "Disabled", + /** + * @cfg {Date/String} minValue + * The minimum allowed date. Can be either a Javascript date object or a string date in a + * valid format (defaults to null). + */ + minValue : null, + /** + * @cfg {Date/String} maxValue + * The maximum allowed date. Can be either a Javascript date object or a string date in a + * valid format (defaults to null). + */ + maxValue : null, + /** + * @cfg {String} minText + * The error text to display when the date in the cell is before minValue (defaults to + * 'The date in this field must be after {minValue}'). + */ + minText : "The date in this field must be equal to or after {0}", + /** + * @cfg {String} maxTextf + * The error text to display when the date in the cell is after maxValue (defaults to + * 'The date in this field must be before {maxValue}'). + */ + maxText : "The date in this field must be equal to or before {0}", + /** + * @cfg {String} invalidText + * The error text to display when the date in the field is invalid (defaults to + * '{value} is not a valid date - it must be in the format {format}'). + */ + invalidText : "{0} is not a valid date - it must be in the format {1}", + /** + * @cfg {String} triggerClass + * An additional CSS class used to style the trigger button. The trigger will always get the + * class 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-date-trigger' + * which displays a calendar icon). + */ + triggerClass : 'x-form-date-trigger', + + + /** + * @cfg {Boolean} useIso + * if enabled, then the date field will use a hidden field to store the + * real value as iso formated date. default (true) + */ + useIso : true, + /** + * @cfg {String/Object} autoCreate + * A DomHelper element spec, or true for a default element spec (defaults to + * {tag: "input", type: "text", size: "10", autocomplete: "off"}) + */ + // private + defaultAutoCreate : {tag: "input", type: "text", size: "10", autocomplete: "new-password"}, + + // private + hiddenField: false, + + hideMonthPicker : false, + + onRender : function(ct, position) + { + Roo.form.MonthField.superclass.onRender.call(this, ct, position); + if (this.useIso) { + this.el.dom.removeAttribute('name'); + this.hiddenField = this.el.insertSibling({ tag:'input', type:'hidden', name: this.name }, + 'before', true); + this.hiddenField.value = this.value ? this.formatDate(this.value, 'Y-m-d') : ''; + // prevent input submission + this.hiddenName = this.name; + } + + + }, + + // private + validateValue : function(value) + { + value = this.formatDate(value); + if(!Roo.form.MonthField.superclass.validateValue.call(this, value)){ + return false; + } + if(value.length < 1){ // if it's blank and textfield didn't flag it then it's valid + return true; + } + var svalue = value; + value = this.parseDate(value); + if(!value){ + this.markInvalid(String.format(this.invalidText, svalue, this.format)); + return false; + } + var time = value.getTime(); + if(this.minValue && time < this.minValue.getTime()){ + this.markInvalid(String.format(this.minText, this.formatDate(this.minValue))); + return false; + } + if(this.maxValue && time > this.maxValue.getTime()){ + this.markInvalid(String.format(this.maxText, this.formatDate(this.maxValue))); + return false; + } + /*if(this.disabledDays){ + var day = value.getDay(); + for(var i = 0; i < this.disabledDays.length; i++) { + if(day === this.disabledDays[i]){ + this.markInvalid(this.disabledDaysText); + return false; + } + } + } + */ + var fvalue = this.formatDate(value); + /*if(this.ddMatch && this.ddMatch.test(fvalue)){ + this.markInvalid(String.format(this.disabledDatesText, fvalue)); + return false; + } + */ + return true; + }, + + // private + // Provides logic to override the default TriggerField.validateBlur which just returns true + validateBlur : function(){ + return !this.menu || !this.menu.isVisible(); + }, + + /** + * Returns the current date value of the date field. + * @return {Date} The date value + */ + getValue : function(){ + + + + return this.hiddenField ? + this.hiddenField.value : + this.parseDate(Roo.form.MonthField.superclass.getValue.call(this)) || ""; + }, + + /** + * Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid + * date, using MonthField.format as the date format, according to the same rules as {@link Date#parseDate} + * (the default format used is "m/d/y"). + * <br />Usage: + * <pre><code> +//All of these calls set the same date value (May 4, 2006) + +//Pass a date object: +var dt = new Date('5/4/06'); +monthField.setValue(dt); + +//Pass a date string (default format): +monthField.setValue('5/4/06'); + +//Pass a date string (custom format): +monthField.format = 'Y-m-d'; +monthField.setValue('2006-5-4'); +</code></pre> + * @param {String/Date} date The date or valid date string + */ + setValue : function(date){ + Roo.log('month setValue' + date); + // can only be first of month.. + + var val = this.parseDate(date); + + if (this.hiddenField) { + this.hiddenField.value = this.formatDate(this.parseDate(date), 'Y-m-d'); + } + Roo.form.MonthField.superclass.setValue.call(this, this.formatDate(this.parseDate(date))); + this.value = this.parseDate(date); + }, + + // private + parseDate : function(value){ + if(!value || value instanceof Date){ + value = value ? Date.parseDate(value.format('Y-m') + '-01', 'Y-m-d') : null; + return value; + } + var v = Date.parseDate(value, this.format); + if (!v && this.useIso) { + v = Date.parseDate(value, 'Y-m-d'); + } + if (v) { + // + v = Date.parseDate(v.format('Y-m') +'-01', 'Y-m-d'); + } + + + if(!v && this.altFormats){ + if(!this.altFormatsArray){ + this.altFormatsArray = this.altFormats.split("|"); + } + for(var i = 0, len = this.altFormatsArray.length; i < len && !v; i++){ + v = Date.parseDate(value, this.altFormatsArray[i]); + } + } + return v; + }, + + // private + formatDate : function(date, fmt){ + return (!date || !(date instanceof Date)) ? + date : date.dateFormat(fmt || this.format); + }, + + // private + menuListeners : { + select: function(m, d){ + this.setValue(d); + this.fireEvent('select', this, d); + }, + show : function(){ // retain focus styling + this.onFocus(); + }, + hide : function(){ + this.focus.defer(10, this); + var ml = this.menuListeners; + this.menu.un("select", ml.select, this); + this.menu.un("show", ml.show, this); + this.menu.un("hide", ml.hide, this); + } + }, + // private + // Implements the default empty TriggerField.onTriggerClick function to display the DatePicker + onTriggerClick : function(){ + if(this.disabled){ + return; + } + if(this.menu == null){ + this.menu = new Roo.menu.DateMenu(); + + } + + Roo.apply(this.menu.picker, { + + showClear: this.allowBlank, + minDate : this.minValue, + maxDate : this.maxValue, + disabledDatesRE : this.ddMatch, + disabledDatesText : this.disabledDatesText, + + format : this.useIso ? 'Y-m-d' : this.format, + minText : String.format(this.minText, this.formatDate(this.minValue)), + maxText : String.format(this.maxText, this.formatDate(this.maxValue)) + + }); + this.menu.on(Roo.apply({}, this.menuListeners, { + scope:this + })); + + + var m = this.menu; + var p = m.picker; + + // hide month picker get's called when we called by 'before hide'; + + var ignorehide = true; + p.hideMonthPicker = function(disableAnim){ + if (ignorehide) { + return; + } + if(this.monthPicker){ + Roo.log("hideMonthPicker called"); + if(disableAnim === true){ + this.monthPicker.hide(); + }else{ + this.monthPicker.slideOut('t', {duration:.2}); + p.setValue(new Date(m.picker.mpSelYear, m.picker.mpSelMonth, 1)); + p.fireEvent("select", this, this.value); + m.hide(); + } + } + } + + Roo.log('picker set value'); + Roo.log(this.getValue()); + p.setValue(this.getValue() ? this.parseDate(this.getValue()) : new Date()); + m.show(this.el, 'tl-bl?'); + ignorehide = false; + // this will trigger hideMonthPicker.. + + + // hidden the day picker + Roo.select('.x-date-picker table', true).first().dom.style.visibility = "hidden"; + + + + + + p.showMonthPicker.defer(100, p); + + + + }, + + beforeBlur : function(){ + var v = this.parseDate(this.getRawValue()); + if(v){ + this.setValue(v); + } + } + + /** @cfg {Boolean} grow @hide */ + /** @cfg {Number} growMin @hide */ + /** @cfg {Number} growMax @hide */ + /** + * @hide + * @method autoSize + */ +}); \ No newline at end of file diff --git a/docs2/src/Roo_form_NumberField.js.html b/docs2/src/Roo_form_NumberField.js.html new file mode 100644 index 0000000000..634c7ec129 --- /dev/null +++ b/docs2/src/Roo_form_NumberField.js.html @@ -0,0 +1,151 @@ +/home/alan/gitlive/roojs1/Roo/form/NumberField.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.form.NumberField + * @extends Roo.form.TextField + * Numeric text field that provides automatic keystroke filtering and numeric validation. + * @constructor + * Creates a new NumberField + * @param {Object} config Configuration options + */ +Roo.form.NumberField = function(config){ + Roo.form.NumberField.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.form.NumberField, Roo.form.TextField, { + /** + * @cfg {String} fieldClass The default CSS class for the field (defaults to "x-form-field x-form-num-field") + */ + fieldClass: "x-form-field x-form-num-field", + /** + * @cfg {Boolean} allowDecimals False to disallow decimal values (defaults to true) + */ + allowDecimals : true, + /** + * @cfg {String} decimalSeparator Character(s) to allow as the decimal separator (defaults to '.') + */ + decimalSeparator : ".", + /** + * @cfg {Number} decimalPrecision The maximum precision to display after the decimal separator (defaults to 2) + */ + decimalPrecision : 2, + /** + * @cfg {Boolean} allowNegative False to prevent entering a negative sign (defaults to true) + */ + allowNegative : true, + /** + * @cfg {Number} minValue The minimum allowed value (defaults to Number.NEGATIVE_INFINITY) + */ + minValue : Number.NEGATIVE_INFINITY, + /** + * @cfg {Number} maxValue The maximum allowed value (defaults to Number.MAX_VALUE) + */ + maxValue : Number.MAX_VALUE, + /** + * @cfg {String} minText Error text to display if the minimum value validation fails (defaults to "The minimum value for this field is {minValue}") + */ + minText : "The minimum value for this field is {0}", + /** + * @cfg {String} maxText Error text to display if the maximum value validation fails (defaults to "The maximum value for this field is {maxValue}") + */ + maxText : "The maximum value for this field is {0}", + /** + * @cfg {String} nanText Error text to display if the value is not a valid number. For example, this can happen + * if a valid character like '.' or '-' is left in the field with no number (defaults to "{value} is not a valid number") + */ + nanText : "{0} is not a valid number", + + // private + initEvents : function(){ + Roo.form.NumberField.superclass.initEvents.call(this); + var allowed = "0123456789"; + if(this.allowDecimals){ + allowed += this.decimalSeparator; + } + if(this.allowNegative){ + allowed += "-"; + } + this.stripCharsRe = new RegExp('[^'+allowed+']', 'gi'); + var keyPress = function(e){ + var k = e.getKey(); + if(!Roo.isIE && (e.isSpecialKey() || k == e.BACKSPACE || k == e.DELETE)){ + return; + } + var c = e.getCharCode(); + if(allowed.indexOf(String.fromCharCode(c)) === -1){ + e.stopEvent(); + } + }; + this.el.on("keypress", keyPress, this); + }, + + // private + validateValue : function(value){ + if(!Roo.form.NumberField.superclass.validateValue.call(this, value)){ + return false; + } + if(value.length < 1){ // if it's blank and textfield didn't flag it then it's valid + return true; + } + var num = this.parseValue(value); + if(isNaN(num)){ + this.markInvalid(String.format(this.nanText, value)); + return false; + } + if(num < this.minValue){ + this.markInvalid(String.format(this.minText, this.minValue)); + return false; + } + if(num > this.maxValue){ + this.markInvalid(String.format(this.maxText, this.maxValue)); + return false; + } + return true; + }, + + getValue : function(){ + return this.fixPrecision(this.parseValue(Roo.form.NumberField.superclass.getValue.call(this))); + }, + + // private + parseValue : function(value){ + value = parseFloat(String(value).replace(this.decimalSeparator, ".")); + return isNaN(value) ? '' : value; + }, + + // private + fixPrecision : function(value){ + var nan = isNaN(value); + if(!this.allowDecimals || this.decimalPrecision == -1 || nan || !value){ + return nan ? '' : value; + } + return parseFloat(value).toFixed(this.decimalPrecision); + }, + + setValue : function(v){ + v = this.fixPrecision(v); + Roo.form.NumberField.superclass.setValue.call(this, String(v).replace(".", this.decimalSeparator)); + }, + + // private + decimalPrecisionFcn : function(v){ + return Math.floor(v); + }, + + beforeBlur : function(){ + var v = this.parseValue(this.getRawValue()); + if(v){ + this.setValue(v); + } + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_form_Radio.js.html b/docs2/src/Roo_form_Radio.js.html new file mode 100644 index 0000000000..4d5e519f95 --- /dev/null +++ b/docs2/src/Roo_form_Radio.js.html @@ -0,0 +1,66 @@ +/home/alan/gitlive/roojs1/Roo/form/Radio.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.form.Radio + * @extends Roo.form.Checkbox + * Single radio field. Same as Checkbox, but provided as a convenience for automatically setting the input type. + * Radio grouping is handled automatically by the browser if you give each radio in a group the same name. + * @constructor + * Creates a new Radio + * @param {Object} config Configuration options + */ +Roo.form.Radio = function(){ + Roo.form.Radio.superclass.constructor.apply(this, arguments); +}; +Roo.extend(Roo.form.Radio, Roo.form.Checkbox, { + inputType: 'radio', + + /** + * If this radio is part of a group, it will return the selected value + * @return {String} + */ + getGroupValue : function(){ + return this.el.up('form').child('input[name='+this.el.dom.name+']:checked', true).value; + }, + + + onRender : function(ct, position){ + Roo.form.Checkbox.superclass.onRender.call(this, ct, position); + + if(this.inputValue !== undefined){ + this.el.dom.value = this.inputValue; + } + + this.wrap = this.el.wrap({cls: "x-form-check-wrap"}); + //this.wrap = this.el.wrap({cls: 'x-menu-check-item '}); + //var viewEl = this.wrap.createChild({ + // tag: 'img', cls: 'x-menu-item-icon', style: 'margin: 0px;' ,src : Roo.BLANK_IMAGE_URL }); + //this.viewEl = viewEl; + //this.wrap.on('click', this.onClick, this); + + //this.el.on('DOMAttrModified', this.setFromHidden, this); //ff + //this.el.on('propertychange', this.setFromHidden, this); //ie + + + + if(this.boxLabel){ + this.wrap.createChild({tag: 'label', htmlFor: this.el.id, cls: 'x-form-cb-label', html: this.boxLabel}); + // viewEl.on('click', this.onClick, this); + } + if(this.checked){ + this.el.dom.checked = 'checked' ; + } + + } + + +}); \ No newline at end of file diff --git a/docs2/src/Roo_form_Select.js.html b/docs2/src/Roo_form_Select.js.html new file mode 100644 index 0000000000..bef7e02188 --- /dev/null +++ b/docs2/src/Roo_form_Select.js.html @@ -0,0 +1,615 @@ +/home/alan/gitlive/roojs1/Roo/form/Select.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.form.ComboBox + * @extends Roo.form.TriggerField + * A combobox control with support for autocomplete, remote-loading, paging and many other features. + * @constructor + * Create a new ComboBox. + * @param {Object} config Configuration options + */ +Roo.form.Select = function(config){ + Roo.form.Select.superclass.constructor.call(this, config); + +}; + +Roo.extend(Roo.form.Select , Roo.form.ComboBox, { + /** + * @cfg {String/HTMLElement/Element} transform The id, DOM node or element of an existing select to convert to a ComboBox + */ + /** + * @cfg {Boolean} lazyRender True to prevent the ComboBox from rendering until requested (should always be used when + * rendering into an Roo.Editor, defaults to false) + */ + /** + * @cfg {Boolean/Object} autoCreate A DomHelper element spec, or true for a default element spec (defaults to: + * {tag: "input", type: "text", size: "24", autocomplete: "off"}) + */ + /** + * @cfg {Roo.data.Store} store The data store to which this combo is bound (defaults to undefined) + */ + /** + * @cfg {String} title If supplied, a header element is created containing this text and added into the top of + * the dropdown list (defaults to undefined, with no header element) + */ + + /** + * @cfg {String/Roo.Template} tpl The template to use to render the output + */ + + // private + defaultAutoCreate : {tag: "select" }, + /** + * @cfg {Number} listWidth The width in pixels of the dropdown list (defaults to the width of the ComboBox field) + */ + listWidth: undefined, + /** + * @cfg {String} displayField The underlying data field name to bind to this CombBox (defaults to undefined if + * mode = 'remote' or 'text' if mode = 'local') + */ + displayField: undefined, + /** + * @cfg {String} valueField The underlying data value name to bind to this CombBox (defaults to undefined if + * mode = 'remote' or 'value' if mode = 'local'). + * Note: use of a valueField requires the user make a selection + * in order for a value to be mapped. + */ + valueField: undefined, + + + /** + * @cfg {String} hiddenName If specified, a hidden form field with this name is dynamically generated to store the + * field's data value (defaults to the underlying DOM element's name) + */ + hiddenName: undefined, + /** + * @cfg {String} listClass CSS class to apply to the dropdown list element (defaults to '') + */ + listClass: '', + /** + * @cfg {String} selectedClass CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected') + */ + selectedClass: 'x-combo-selected', + /** + * @cfg {String} triggerClass An additional CSS class used to style the trigger button. The trigger will always get the + * class 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger' + * which displays a downward arrow icon). + */ + triggerClass : 'x-form-arrow-trigger', + /** + * @cfg {Boolean/String} shadow True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right + */ + shadow:'sides', + /** + * @cfg {String} listAlign A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported + * anchor positions (defaults to 'tl-bl') + */ + listAlign: 'tl-bl?', + /** + * @cfg {Number} maxHeight The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300) + */ + maxHeight: 300, + /** + * @cfg {String} triggerAction The action to execute when the trigger field is activated. Use 'all' to run the + * query specified by the allQuery config option (defaults to 'query') + */ + triggerAction: 'query', + /** + * @cfg {Number} minChars The minimum number of characters the user must type before autocomplete and typeahead activate + * (defaults to 4, does not apply if editable = false) + */ + minChars : 4, + /** + * @cfg {Boolean} typeAhead True to populate and autoselect the remainder of the text being typed after a configurable + * delay (typeAheadDelay) if it matches a known value (defaults to false) + */ + typeAhead: false, + /** + * @cfg {Number} queryDelay The length of time in milliseconds to delay between the start of typing and sending the + * query to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local') + */ + queryDelay: 500, + /** + * @cfg {Number} pageSize If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the + * filter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0) + */ + pageSize: 0, + /** + * @cfg {Boolean} selectOnFocus True to select any existing text in the field immediately on focus. Only applies + * when editable = true (defaults to false) + */ + selectOnFocus:false, + /** + * @cfg {String} queryParam Name of the query as it will be passed on the querystring (defaults to 'query') + */ + queryParam: 'query', + /** + * @cfg {String} loadingText The text to display in the dropdown list while data is loading. Only applies + * when mode = 'remote' (defaults to 'Loading...') + */ + loadingText: 'Loading...', + /** + * @cfg {Boolean} resizable True to add a resize handle to the bottom of the dropdown list (defaults to false) + */ + resizable: false, + /** + * @cfg {Number} handleHeight The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8) + */ + handleHeight : 8, + /** + * @cfg {Boolean} editable False to prevent the user from typing text directly into the field, just like a + * traditional select (defaults to true) + */ + editable: true, + /** + * @cfg {String} allQuery The text query to send to the server to return all records for the list with no filtering (defaults to '') + */ + allQuery: '', + /** + * @cfg {String} mode Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server) + */ + mode: 'remote', + /** + * @cfg {Number} minListWidth The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if + * listWidth has a higher value) + */ + minListWidth : 70, + /** + * @cfg {Boolean} forceSelection True to restrict the selected value to one of the values in the list, false to + * allow the user to set arbitrary text into the field (defaults to false) + */ + forceSelection:false, + /** + * @cfg {Number} typeAheadDelay The length of time in milliseconds to wait until the typeahead text is displayed + * if typeAhead = true (defaults to 250) + */ + typeAheadDelay : 250, + /** + * @cfg {String} valueNotFoundText When using a name/value combo, if the value passed to setValue is not found in + * the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined) + */ + valueNotFoundText : undefined, + + /** + * @cfg {String} defaultValue The value displayed after loading the store. + */ + defaultValue: '', + + /** + * @cfg {Boolean} blockFocus Prevents all focus calls, so it can work with things like HTML edtor bar + */ + blockFocus : false, + + /** + * @cfg {Boolean} disableClear Disable showing of clear button. + */ + disableClear : false, + /** + * @cfg {Boolean} alwaysQuery Disable caching of results, and always send query + */ + alwaysQuery : false, + + //private + addicon : false, + editicon: false, + + // element that contains real text value.. (when hidden is used..) + + // private + onRender : function(ct, position){ + Roo.form.Field.prototype.onRender.call(this, ct, position); + + if(this.store){ + this.store.on('beforeload', this.onBeforeLoad, this); + this.store.on('load', this.onLoad, this); + this.store.on('loadexception', this.onLoadException, this); + this.store.load({}); + } + + + + }, + + // private + initEvents : function(){ + //Roo.form.ComboBox.superclass.initEvents.call(this); + + }, + + onDestroy : function(){ + + if(this.store){ + this.store.un('beforeload', this.onBeforeLoad, this); + this.store.un('load', this.onLoad, this); + this.store.un('loadexception', this.onLoadException, this); + } + //Roo.form.ComboBox.superclass.onDestroy.call(this); + }, + + // private + fireKey : function(e){ + if(e.isNavKeyPress() && !this.list.isVisible()){ + this.fireEvent("specialkey", this, e); + } + }, + + // private + onResize: function(w, h){ + + return; + + + }, + + /** + * Allow or prevent the user from directly editing the field text. If false is passed, + * the user will only be able to select from the items defined in the dropdown list. This method + * is the runtime equivalent of setting the 'editable' config option at config time. + * @param {Boolean} value True to allow the user to directly edit the field text + */ + setEditable : function(value){ + + }, + + // private + onBeforeLoad : function(){ + + Roo.log("Select before load"); + return; + + this.innerList.update(this.loadingText ? + '<div class="loading-indicator">'+this.loadingText+'</div>' : ''); + //this.restrictHeight(); + this.selectedIndex = -1; + }, + + // private + onLoad : function(){ + + + var dom = this.el.dom; + dom.innerHTML = ''; + var od = dom.ownerDocument; + + if (this.emptyText) { + var op = od.createElement('option'); + op.setAttribute('value', ''); + op.innerHTML = String.format('{0}', this.emptyText); + dom.appendChild(op); + } + if(this.store.getCount() > 0){ + + var vf = this.valueField; + var df = this.displayField; + this.store.data.each(function(r) { + // which colmsn to use... testing - cdoe / title.. + var op = od.createElement('option'); + op.setAttribute('value', r.data[vf]); + op.innerHTML = String.format('{0}', r.data[df]); + dom.appendChild(op); + }); + if (typeof(this.defaultValue != 'undefined')) { + this.setValue(this.defaultValue); + } + + + }else{ + //this.onEmptyResults(); + } + //this.el.focus(); + }, + // private + onLoadException : function() + { + dom.innerHTML = ''; + + Roo.log("Select on load exception"); + return; + + this.collapse(); + Roo.log(this.store.reader.jsonData); + if (this.store && typeof(this.store.reader.jsonData.errorMsg) != 'undefined') { + Roo.MessageBox.alert("Error loading",this.store.reader.jsonData.errorMsg); + } + + + }, + // private + onTypeAhead : function(){ + + }, + + // private + onSelect : function(record, index){ + Roo.log('on select?'); + return; + if(this.fireEvent('beforeselect', this, record, index) !== false){ + this.setFromData(index > -1 ? record.data : false); + this.collapse(); + this.fireEvent('select', this, record, index); + } + }, + + /** + * Returns the currently selected field value or empty string if no value is set. + * @return {String} value The selected value + */ + getValue : function(){ + var dom = this.el.dom; + this.value = dom.options[dom.selectedIndex].value; + return this.value; + + }, + + /** + * Clears any text/value currently set in the field + */ + clearValue : function(){ + this.value = ''; + this.el.dom.selectedIndex = this.emptyText ? 0 : -1; + + }, + + /** + * Sets the specified value into the field. If the value finds a match, the corresponding record text + * will be displayed in the field. If the value does not match the data value of an existing item, + * and the valueNotFoundText config option is defined, it will be displayed as the default field text. + * Otherwise the field will be blank (although the value will still be set). + * @param {String} value The value to match + */ + setValue : function(v){ + var d = this.el.dom; + for (var i =0; i < d.options.length;i++) { + if (v == d.options[i].value) { + d.selectedIndex = i; + this.value = v; + return; + } + } + this.clearValue(); + }, + /** + * @property {Object} the last set data for the element + */ + + lastData : false, + /** + * Sets the value of the field based on a object which is related to the record format for the store. + * @param {Object} value the value to set as. or false on reset? + */ + setFromData : function(o){ + Roo.log('setfrom data?'); + + + + }, + // private + reset : function(){ + this.clearValue(); + }, + // private + findRecord : function(prop, value){ + + return false; + + var record; + if(this.store.getCount() > 0){ + this.store.each(function(r){ + if(r.data[prop] == value){ + record = r; + return false; + } + return true; + }); + } + return record; + }, + + getName: function() + { + // returns hidden if it's set.. + if (!this.rendered) {return ''}; + return !this.hiddenName && this.el.dom.name ? this.el.dom.name : (this.hiddenName || ''); + + }, + + + + + // private + onEmptyResults : function(){ + Roo.log('empty results'); + //this.collapse(); + }, + + /** + * Returns true if the dropdown list is expanded, else false. + */ + isExpanded : function(){ + return false; + }, + + /** + * Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire. + * The store must be loaded and the list expanded for this function to work, otherwise use setValue. + * @param {String} value The data value of the item to select + * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the + * selected item if it is not currently in view (defaults to true) + * @return {Boolean} True if the value matched an item in the list, else false + */ + selectByValue : function(v, scrollIntoView){ + Roo.log('select By Value'); + return false; + + if(v !== undefined && v !== null){ + var r = this.findRecord(this.valueField || this.displayField, v); + if(r){ + this.select(this.store.indexOf(r), scrollIntoView); + return true; + } + } + return false; + }, + + /** + * Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire. + * The store must be loaded and the list expanded for this function to work, otherwise use setValue. + * @param {Number} index The zero-based index of the list item to select + * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the + * selected item if it is not currently in view (defaults to true) + */ + select : function(index, scrollIntoView){ + Roo.log('select '); + return ; + + this.selectedIndex = index; + this.view.select(index); + if(scrollIntoView !== false){ + var el = this.view.getNode(index); + if(el){ + this.innerList.scrollChildIntoView(el, false); + } + } + }, + + + + // private + validateBlur : function(){ + + return; + + }, + + // private + initQuery : function(){ + this.doQuery(this.getRawValue()); + }, + + // private + doForce : function(){ + if(this.el.dom.value.length > 0){ + this.el.dom.value = + this.lastSelectionText === undefined ? '' : this.lastSelectionText; + + } + }, + + /** + * Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the + * query allowing the query action to be canceled if needed. + * @param {String} query The SQL query to execute + * @param {Boolean} forceAll True to force the query to execute even if there are currently fewer characters + * in the field than the minimum specified by the minChars config option. It also clears any filter previously + * saved in the current store (defaults to false) + */ + doQuery : function(q, forceAll){ + + Roo.log('doQuery?'); + if(q === undefined || q === null){ + q = ''; + } + var qe = { + query: q, + forceAll: forceAll, + combo: this, + cancel:false + }; + if(this.fireEvent('beforequery', qe)===false || qe.cancel){ + return false; + } + q = qe.query; + forceAll = qe.forceAll; + if(forceAll === true || (q.length >= this.minChars)){ + if(this.lastQuery != q || this.alwaysQuery){ + this.lastQuery = q; + if(this.mode == 'local'){ + this.selectedIndex = -1; + if(forceAll){ + this.store.clearFilter(); + }else{ + this.store.filter(this.displayField, q); + } + this.onLoad(); + }else{ + this.store.baseParams[this.queryParam] = q; + this.store.load({ + params: this.getParams(q) + }); + this.expand(); + } + }else{ + this.selectedIndex = -1; + this.onLoad(); + } + } + }, + + // private + getParams : function(q){ + var p = {}; + //p[this.queryParam] = q; + if(this.pageSize){ + p.start = 0; + p.limit = this.pageSize; + } + return p; + }, + + /** + * Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion. + */ + collapse : function(){ + + }, + + // private + collapseIf : function(e){ + + }, + + /** + * Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion. + */ + expand : function(){ + + } , + + // private + + + /** + * @cfg {Boolean} grow + * @hide + */ + /** + * @cfg {Number} growMin + * @hide + */ + /** + * @cfg {Number} growMax + * @hide + */ + /** + * @hide + * @method autoSize + */ + + setWidth : function() + { + + }, + getResizeEl : function(){ + return this.el; + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_form_Signature.js.html b/docs2/src/Roo_form_Signature.js.html new file mode 100644 index 0000000000..652576bbe6 --- /dev/null +++ b/docs2/src/Roo_form_Signature.js.html @@ -0,0 +1,340 @@ +/home/alan/gitlive/roojs1/Roo/form/Signature.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.form.Signature + * @extends Roo.form.Field + * Signature field. + * @constructor + * + * @param {Object} config Configuration options + */ + +Roo.form.Signature = function(config){ + Roo.form.Signature.superclass.constructor.call(this, config); + + this.addEvents({// not in used?? + /** + * @event confirm + * Fires when the 'confirm' icon is pressed (add a listener to enable add button) + * @param {Roo.form.Signature} combo This combo box + */ + 'confirm' : true, + /** + * @event reset + * Fires when the 'edit' icon is pressed (add a listener to enable add button) + * @param {Roo.form.ComboBox} combo This combo box + * @param {Roo.data.Record|false} record The data record returned from the underlying store (or false on nothing selected) + */ + 'reset' : true + }); +}; + +Roo.extend(Roo.form.Signature, Roo.form.Field, { + /** + * @cfg {Object} labels Label to use when rendering a form. + * defaults to + * labels : { + * clear : "Clear", + * confirm : "Confirm" + * } + */ + labels : { + clear : "Clear", + confirm : "Confirm" + }, + /** + * @cfg {Number} width The signature panel width (defaults to 300) + */ + width: 300, + /** + * @cfg {Number} height The signature panel height (defaults to 100) + */ + height : 100, + /** + * @cfg {Boolean} allowBlank False to validate that the value length > 0 (defaults to false) + */ + allowBlank : false, + + //private + // {Object} signPanel The signature SVG panel element (defaults to {}) + signPanel : {}, + // {Boolean} isMouseDown False to validate that the mouse down event (defaults to false) + isMouseDown : false, + // {Boolean} isConfirmed validate the signature is confirmed or not for submitting form (defaults to false) + isConfirmed : false, + // {String} signatureTmp SVG mapping string (defaults to empty string) + signatureTmp : '', + + + defaultAutoCreate : { // modified by initCompnoent.. + tag: "input", + type:"hidden" + }, + + // private + onRender : function(ct, position){ + + Roo.form.Signature.superclass.onRender.call(this, ct, position); + + this.wrap = this.el.wrap({ + cls:'x-form-signature-wrap', style : 'width: ' + this.width + 'px', cn:{cls:'x-form-signature'} + }); + + this.createToolbar(this); + this.signPanel = this.wrap.createChild({ + tag: 'div', + style: 'width: ' + this.width + 'px; height: ' + this.height + 'px; border: 0;' + }, this.el + ); + + this.svgID = Roo.id(); + this.svgEl = this.signPanel.createChild({ + xmlns : 'http://www.w3.org/2000/svg', + tag : 'svg', + id : this.svgID + "-svg", + width: this.width, + height: this.height, + viewBox: '0 0 '+this.width+' '+this.height, + cn : [ + { + tag: "rect", + id: this.svgID + "-svg-r", + width: this.width, + height: this.height, + fill: "#ffa" + }, + { + tag: "line", + id: this.svgID + "-svg-l", + x1: "0", // start + y1: (this.height*0.8), // start set the line in 80% of height + x2: this.width, // end + y2: (this.height*0.8), // end set the line in 80% of height + 'stroke': "#666", + 'stroke-width': "1", + 'stroke-dasharray': "3", + 'shape-rendering': "crispEdges", + 'pointer-events': "none" + }, + { + tag: "path", + id: this.svgID + "-svg-p", + 'stroke': "navy", + 'stroke-width': "3", + 'fill': "none", + 'pointer-events': 'none' + } + ] + }); + this.createSVG(); + this.svgBox = this.svgEl.dom.getScreenCTM(); + }, + createSVG : function(){ + var svg = this.signPanel; + var r = svg.select('#'+ this.svgID + '-svg-r', true).first().dom; + var t = this; + + r.addEventListener('mousedown', function(e) { return t.down(e); }, false); + r.addEventListener('mousemove', function(e) { return t.move(e); }, false); + r.addEventListener('mouseup', function(e) { return t.up(e); }, false); + r.addEventListener('mouseout', function(e) { return t.up(e); }, false); + r.addEventListener('touchstart', function(e) { return t.down(e); }, false); + r.addEventListener('touchmove', function(e) { return t.move(e); }, false); + r.addEventListener('touchend', function(e) { return t.up(e); }, false); + + }, + isTouchEvent : function(e){ + return e.type.match(/^touch/); + }, + getCoords : function (e) { + var pt = this.svgEl.dom.createSVGPoint(); + pt.x = e.clientX; + pt.y = e.clientY; + if (this.isTouchEvent(e)) { + pt.x = e.targetTouches[0].clientX; + pt.y = e.targetTouches[0].clientY; + } + var a = this.svgEl.dom.getScreenCTM(); + var b = a.inverse(); + var mx = pt.matrixTransform(b); + return mx.x + ',' + mx.y; + }, + //mouse event headler + down : function (e) { + this.signatureTmp += 'M' + this.getCoords(e) + ' '; + this.signPanel.select('#'+ this.svgID + '-svg-p', true).first().attr('d', this.signatureTmp); + + this.isMouseDown = true; + + e.preventDefault(); + }, + move : function (e) { + if (this.isMouseDown) { + this.signatureTmp += 'L' + this.getCoords(e) + ' '; + this.signPanel.select('#'+ this.svgID + '-svg-p', true).first().attr( 'd', this.signatureTmp); + } + + e.preventDefault(); + }, + up : function (e) { + this.isMouseDown = false; + var sp = this.signatureTmp.split(' '); + + if(sp.length > 1){ + if(!sp[sp.length-2].match(/^L/)){ + sp.pop(); + sp.pop(); + sp.push(""); + this.signatureTmp = sp.join(" "); + } + } + if(this.getValue() != this.signatureTmp){ + this.signPanel.select('#'+ this.svgID + '-svg-r', true).first().attr('fill', '#ffa'); + this.isConfirmed = false; + } + e.preventDefault(); + }, + + /** + * Protected method that will not generally be called directly. It + * is called when the editor creates its toolbar. Override this method if you need to + * add custom toolbar buttons. + * @param {HtmlEditor} editor + */ + createToolbar : function(editor){ + function btn(id, toggle, handler){ + var xid = fid + '-'+ id ; + return { + id : xid, + cmd : id, + cls : 'x-btn-icon x-edit-'+id, + enableToggle:toggle !== false, + scope: editor, // was editor... + handler:handler||editor.relayBtnCmd, + clickEvent:'mousedown', + tooltip: etb.buttonTips[id] || undefined, ///tips ??? + tabIndex:-1 + }; + } + + + var tb = new Roo.Toolbar(editor.wrap.dom.firstChild); + this.tb = tb; + this.tb.add( + { + cls : ' x-signature-btn x-signature-'+id, + scope: editor, // was editor... + handler: this.reset, + clickEvent:'mousedown', + text: this.labels.clear + }, + { + xtype : 'Fill', + xns: Roo.Toolbar + }, + { + cls : ' x-signature-btn x-signature-'+id, + scope: editor, // was editor... + handler: this.confirmHandler, + clickEvent:'mousedown', + text: this.labels.confirm + } + ); + + }, + //public + /** + * when user is clicked confirm then show this image..... + * + * @return {String} Image Data URI + */ + getImageDataURI : function(){ + var svg = this.svgEl.dom.parentNode.innerHTML; + var src = 'data:image/svg+xml;base64,'+window.btoa(svg); + return src; + }, + /** + * + * @return {Boolean} this.isConfirmed + */ + getConfirmed : function(){ + return this.isConfirmed; + }, + /** + * + * @return {Number} this.width + */ + getWidth : function(){ + return this.width; + }, + /** + * + * @return {Number} this.height + */ + getHeight : function(){ + return this.height; + }, + // private + getSignature : function(){ + return this.signatureTmp; + }, + // private + reset : function(){ + this.signatureTmp = ''; + this.signPanel.select('#'+ this.svgID + '-svg-r', true).first().attr('fill', '#ffa'); + this.signPanel.select('#'+ this.svgID + '-svg-p', true).first().attr( 'd', ''); + this.isConfirmed = false; + Roo.form.Signature.superclass.reset.call(this); + }, + setSignature : function(s){ + this.signatureTmp = s; + this.signPanel.select('#'+ this.svgID + '-svg-r', true).first().attr('fill', '#ffa'); + this.signPanel.select('#'+ this.svgID + '-svg-p', true).first().attr( 'd', s); + this.setValue(s); + this.isConfirmed = false; + Roo.form.Signature.superclass.reset.call(this); + }, + test : function(){ +// Roo.log(this.signPanel.dom.contentWindow.up()) + }, + //private + setConfirmed : function(){ + + + +// Roo.log(Roo.get(this.signPanel.dom.contentWindow.r).attr('fill', '#cfc')); + }, + // private + confirmHandler : function(){ + if(!this.getSignature()){ + return; + } + + this.signPanel.select('#'+ this.svgID + '-svg-r', true).first().attr('fill', '#cfc'); + this.setValue(this.getSignature()); + this.isConfirmed = true; + + this.fireEvent('confirm', this); + }, + // private + // Subclasses should provide the validation implementation by overriding this + validateValue : function(value){ + if(this.allowBlank){ + return true; + } + + if(this.isConfirmed){ + return true; + } + return false; + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_form_TextArea.js.html b/docs2/src/Roo_form_TextArea.js.html new file mode 100644 index 0000000000..9d5f75cde3 --- /dev/null +++ b/docs2/src/Roo_form_TextArea.js.html @@ -0,0 +1,121 @@ +/home/alan/gitlive/roojs1/Roo/form/TextArea.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.form.TextArea + * @extends Roo.form.TextField + * Multiline text field. Can be used as a direct replacement for traditional textarea fields, plus adds + * support for auto-sizing. + * @constructor + * Creates a new TextArea + * @param {Object} config Configuration options + */ +Roo.form.TextArea = function(config){ + Roo.form.TextArea.superclass.constructor.call(this, config); + // these are provided exchanges for backwards compat + // minHeight/maxHeight were replaced by growMin/growMax to be + // compatible with TextField growing config values + if(this.minHeight !== undefined){ + this.growMin = this.minHeight; + } + if(this.maxHeight !== undefined){ + this.growMax = this.maxHeight; + } +}; + +Roo.extend(Roo.form.TextArea, Roo.form.TextField, { + /** + * @cfg {Number} growMin The minimum height to allow when grow = true (defaults to 60) + */ + growMin : 60, + /** + * @cfg {Number} growMax The maximum height to allow when grow = true (defaults to 1000) + */ + growMax: 1000, + /** + * @cfg {Boolean} preventScrollbars True to prevent scrollbars from appearing regardless of how much text is + * in the field (equivalent to setting overflow: hidden, defaults to false) + */ + preventScrollbars: false, + /** + * @cfg {String/Object} autoCreate A DomHelper element spec, or true for a default element spec (defaults to + * {tag: "textarea", style: "width:300px;height:60px;", autocomplete: "off"}) + */ + + // private + onRender : function(ct, position){ + if(!this.el){ + this.defaultAutoCreate = { + tag: "textarea", + style:"width:300px;height:60px;", + autocomplete: "new-password" + }; + } + Roo.form.TextArea.superclass.onRender.call(this, ct, position); + if(this.grow){ + this.textSizeEl = Roo.DomHelper.append(document.body, { + tag: "pre", cls: "x-form-grow-sizer" + }); + if(this.preventScrollbars){ + this.el.setStyle("overflow", "hidden"); + } + this.el.setHeight(this.growMin); + } + }, + + onDestroy : function(){ + if(this.textSizeEl){ + this.textSizeEl.parentNode.removeChild(this.textSizeEl); + } + Roo.form.TextArea.superclass.onDestroy.call(this); + }, + + // private + onKeyUp : function(e){ + if(!e.isNavKeyPress() || e.getKey() == e.ENTER){ + this.autoSize(); + } + }, + + /** + * Automatically grows the field to accomodate the height of the text up to the maximum field height allowed. + * This only takes effect if grow = true, and fires the autosize event if the height changes. + */ + autoSize : function(){ + if(!this.grow || !this.textSizeEl){ + return; + } + var el = this.el; + var v = el.dom.value; + var ts = this.textSizeEl; + + ts.innerHTML = ''; + ts.appendChild(document.createTextNode(v)); + v = ts.innerHTML; + + Roo.fly(ts).setWidth(this.el.getWidth()); + if(v.length < 1){ + v = "&#160;&#160;"; + }else{ + if(Roo.isIE){ + v = v.replace(/\n/g, '<p>&#160;</p>'); + } + v += "&#160;\n&#160;"; + } + ts.innerHTML = v; + var h = Math.min(this.growMax, Math.max(ts.offsetHeight, this.growMin)); + if(h != this.lastHeight){ + this.lastHeight = h; + this.el.setHeight(h); + this.fireEvent("autosize", this, h); + } + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_form_TextField.js.html b/docs2/src/Roo_form_TextField.js.html new file mode 100644 index 0000000000..57e3f7f50d --- /dev/null +++ b/docs2/src/Roo_form_TextField.js.html @@ -0,0 +1,329 @@ +/home/alan/gitlive/roojs1/Roo/form/TextField.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.form.TextField + * @extends Roo.form.Field + * Basic text field. Can be used as a direct replacement for traditional text inputs, or as the base + * class for more sophisticated input controls (like {@link Roo.form.TextArea} and {@link Roo.form.ComboBox}). + * @constructor + * Creates a new TextField + * @param {Object} config Configuration options + */ +Roo.form.TextField = function(config){ + Roo.form.TextField.superclass.constructor.call(this, config); + this.addEvents({ + /** + * @event autosize + * Fires when the autosize function is triggered. The field may or may not have actually changed size + * according to the default logic, but this event provides a hook for the developer to apply additional + * logic at runtime to resize the field if needed. + * @param {Roo.form.Field} this This text field + * @param {Number} width The new field width + */ + autosize : true + }); +}; + +Roo.extend(Roo.form.TextField, Roo.form.Field, { + /** + * @cfg {Boolean} grow True if this field should automatically grow and shrink to its content + */ + grow : false, + /** + * @cfg {Number} growMin The minimum width to allow when grow = true (defaults to 30) + */ + growMin : 30, + /** + * @cfg {Number} growMax The maximum width to allow when grow = true (defaults to 800) + */ + growMax : 800, + /** + * @cfg {String} vtype A validation type name as defined in {@link Roo.form.VTypes} (defaults to null) + */ + vtype : null, + /** + * @cfg {String} maskRe An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null) + */ + maskRe : null, + /** + * @cfg {Boolean} disableKeyFilter True to disable input keystroke filtering (defaults to false) + */ + disableKeyFilter : false, + /** + * @cfg {Boolean} allowBlank False to validate that the value length > 0 (defaults to true) + */ + allowBlank : true, + /** + * @cfg {Number} minLength Minimum input field length required (defaults to 0) + */ + minLength : 0, + /** + * @cfg {Number} maxLength Maximum input field length allowed (defaults to Number.MAX_VALUE) + */ + maxLength : Number.MAX_VALUE, + /** + * @cfg {String} minLengthText Error text to display if the minimum length validation fails (defaults to "The minimum length for this field is {minLength}") + */ + minLengthText : "The minimum length for this field is {0}", + /** + * @cfg {String} maxLengthText Error text to display if the maximum length validation fails (defaults to "The maximum length for this field is {maxLength}") + */ + maxLengthText : "The maximum length for this field is {0}", + /** + * @cfg {Boolean} selectOnFocus True to automatically select any existing field text when the field receives input focus (defaults to false) + */ + selectOnFocus : false, + /** + * @cfg {String} blankText Error text to display if the allow blank validation fails (defaults to "This field is required") + */ + blankText : "This field is required", + /** + * @cfg {Function} validator A custom validation function to be called during field validation (defaults to null). + * If available, this function will be called only after the basic validators all return true, and will be passed the + * current field value and expected to return boolean true if the value is valid or a string error message if invalid. + */ + validator : null, + /** + * @cfg {RegExp} regex A JavaScript RegExp object to be tested against the field value during validation (defaults to null). + * If available, this regex will be evaluated only after the basic validators all return true, and will be passed the + * current field value. If the test fails, the field will be marked invalid using {@link #regexText}. + */ + regex : null, + /** + * @cfg {String} regexText The error text to display if {@link #regex} is used and the test fails during validation (defaults to "") + */ + regexText : "", + /** + * @cfg {String} emptyText The default text to display in an empty field - placeholder... (defaults to null). + */ + emptyText : null, + + + // private + initEvents : function() + { + if (this.emptyText) { + this.el.attr('placeholder', this.emptyText); + } + + Roo.form.TextField.superclass.initEvents.call(this); + if(this.validationEvent == 'keyup'){ + this.validationTask = new Roo.util.DelayedTask(this.validate, this); + this.el.on('keyup', this.filterValidation, this); + } + else if(this.validationEvent !== false){ + this.el.on(this.validationEvent, this.validate, this, {buffer: this.validationDelay}); + } + + if(this.selectOnFocus){ + this.on("focus", this.preFocus, this); + + } + if(this.maskRe || (this.vtype && this.disableKeyFilter !== true && (this.maskRe = Roo.form.VTypes[this.vtype+'Mask']))){ + this.el.on("keypress", this.filterKeys, this); + } + if(this.grow){ + this.el.on("keyup", this.onKeyUp, this, {buffer:50}); + this.el.on("click", this.autoSize, this); + } + if(this.el.is('input[type=password]') && Roo.isSafari){ + this.el.on('keydown', this.SafariOnKeyDown, this); + } + }, + + processValue : function(value){ + if(this.stripCharsRe){ + var newValue = value.replace(this.stripCharsRe, ''); + if(newValue !== value){ + this.setRawValue(newValue); + return newValue; + } + } + return value; + }, + + filterValidation : function(e){ + if(!e.isNavKeyPress()){ + this.validationTask.delay(this.validationDelay); + } + }, + + // private + onKeyUp : function(e){ + if(!e.isNavKeyPress()){ + this.autoSize(); + } + }, + + /** + * Resets the current field value to the originally-loaded value and clears any validation messages. + * + */ + reset : function(){ + Roo.form.TextField.superclass.reset.call(this); + + }, + + + // private + preFocus : function(){ + + if(this.selectOnFocus){ + this.el.dom.select(); + } + }, + + + // private + filterKeys : function(e){ + var k = e.getKey(); + if(!Roo.isIE && (e.isNavKeyPress() || k == e.BACKSPACE || (k == e.DELETE && e.button == -1))){ + return; + } + var c = e.getCharCode(), cc = String.fromCharCode(c); + if(Roo.isIE && (e.isSpecialKey() || !cc)){ + return; + } + if(!this.maskRe.test(cc)){ + e.stopEvent(); + } + }, + + setValue : function(v){ + + Roo.form.TextField.superclass.setValue.apply(this, arguments); + + this.autoSize(); + }, + + /** + * Validates a value according to the field's validation rules and marks the field as invalid + * if the validation fails + * @param {Mixed} value The value to validate + * @return {Boolean} True if the value is valid, else false + */ + validateValue : function(value){ + if(value.length < 1) { // if it's blank + if(this.allowBlank){ + this.clearInvalid(); + return true; + }else{ + this.markInvalid(this.blankText); + return false; + } + } + if(value.length < this.minLength){ + this.markInvalid(String.format(this.minLengthText, this.minLength)); + return false; + } + if(value.length > this.maxLength){ + this.markInvalid(String.format(this.maxLengthText, this.maxLength)); + return false; + } + if(this.vtype){ + var vt = Roo.form.VTypes; + if(!vt[this.vtype](value, this)){ + this.markInvalid(this.vtypeText || vt[this.vtype +'Text']); + return false; + } + } + if(typeof this.validator == "function"){ + var msg = this.validator(value); + if(msg !== true){ + this.markInvalid(msg); + return false; + } + } + if(this.regex && !this.regex.test(value)){ + this.markInvalid(this.regexText); + return false; + } + return true; + }, + + /** + * Selects text in this field + * @param {Number} start (optional) The index where the selection should start (defaults to 0) + * @param {Number} end (optional) The index where the selection should end (defaults to the text length) + */ + selectText : function(start, end){ + var v = this.getRawValue(); + if(v.length > 0){ + start = start === undefined ? 0 : start; + end = end === undefined ? v.length : end; + var d = this.el.dom; + if(d.setSelectionRange){ + d.setSelectionRange(start, end); + }else if(d.createTextRange){ + var range = d.createTextRange(); + range.moveStart("character", start); + range.moveEnd("character", v.length-end); + range.select(); + } + } + }, + + /** + * Automatically grows the field to accomodate the width of the text up to the maximum field width allowed. + * This only takes effect if grow = true, and fires the autosize event. + */ + autoSize : function(){ + if(!this.grow || !this.rendered){ + return; + } + if(!this.metrics){ + this.metrics = Roo.util.TextMetrics.createInstance(this.el); + } + var el = this.el; + var v = el.dom.value; + var d = document.createElement('div'); + d.appendChild(document.createTextNode(v)); + v = d.innerHTML; + d = null; + v += "&#160;"; + var w = Math.min(this.growMax, Math.max(this.metrics.getWidth(v) + /* add extra padding */ 10, this.growMin)); + this.el.setWidth(w); + this.fireEvent("autosize", this, w); + }, + + // private + SafariOnKeyDown : function(event) + { + // this is a workaround for a password hang bug on chrome/ webkit. + + var isSelectAll = false; + + if(this.el.dom.selectionEnd > 0){ + isSelectAll = (this.el.dom.selectionEnd - this.el.dom.selectionStart - this.getValue().length == 0) ? true : false; + } + if(((event.getKey() == 8 || event.getKey() == 46) && this.getValue().length ==1)){ // backspace and delete key + event.preventDefault(); + this.setValue(''); + return; + } + + if(isSelectAll && event.getCharCode() > 31){ // backspace and delete key + + event.preventDefault(); + // this is very hacky as keydown always get's upper case. + + var cc = String.fromCharCode(event.getCharCode()); + + + this.setValue( event.shiftKey ? cc : cc.toLowerCase()); + + } + + + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_form_TriggerField.js.html b/docs2/src/Roo_form_TriggerField.js.html new file mode 100644 index 0000000000..9a4f14bac2 --- /dev/null +++ b/docs2/src/Roo_form_TriggerField.js.html @@ -0,0 +1,269 @@ +/home/alan/gitlive/roojs1/Roo/form/TriggerField.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.form.TriggerField + * @extends Roo.form.TextField + * Provides a convenient wrapper for TextFields that adds a clickable trigger button (looks like a combobox by default). + * The trigger has no default action, so you must assign a function to implement the trigger click handler by + * overriding {@link #onTriggerClick}. You can create a TriggerField directly, as it renders exactly like a combobox + * for which you can provide a custom implementation. For example: + * <pre><code> +var trigger = new Roo.form.TriggerField(); +trigger.onTriggerClick = myTriggerFn; +trigger.applyTo('my-field'); +</code></pre> + * + * However, in general you will most likely want to use TriggerField as the base class for a reusable component. + * {@link Roo.form.DateField} and {@link Roo.form.ComboBox} are perfect examples of this. + * @cfg {String} triggerClass An additional CSS class used to style the trigger button. The trigger will always get the + * class 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified. + * @constructor + * Create a new TriggerField. + * @param {Object} config Configuration options (valid {@Roo.form.TextField} config options will also be applied + * to the base TextField) + */ +Roo.form.TriggerField = function(config){ + this.mimicing = false; + Roo.form.TriggerField.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.form.TriggerField, Roo.form.TextField, { + /** + * @cfg {String} triggerClass A CSS class to apply to the trigger + */ + /** + * @cfg {String/Object} autoCreate A DomHelper element spec, or true for a default element spec (defaults to + * {tag: "input", type: "text", size: "16", autocomplete: "off"}) + */ + defaultAutoCreate : {tag: "input", type: "text", size: "16", autocomplete: "new-password"}, + /** + * @cfg {Boolean} hideTrigger True to hide the trigger element and display only the base text field (defaults to false) + */ + hideTrigger:false, + + /** @cfg {Boolean} grow @hide */ + /** @cfg {Number} growMin @hide */ + /** @cfg {Number} growMax @hide */ + + /** + * @hide + * @method + */ + autoSize: Roo.emptyFn, + // private + monitorTab : true, + // private + deferHeight : true, + + + actionMode : 'wrap', + // private + onResize : function(w, h){ + Roo.form.TriggerField.superclass.onResize.apply(this, arguments); + if(typeof w == 'number'){ + var x = w - this.trigger.getWidth(); + this.el.setWidth(this.adjustWidth('input', x)); + this.trigger.setStyle('left', x+'px'); + } + }, + + // private + adjustSize : Roo.BoxComponent.prototype.adjustSize, + + // private + getResizeEl : function(){ + return this.wrap; + }, + + // private + getPositionEl : function(){ + return this.wrap; + }, + + // private + alignErrorIcon : function(){ + this.errorIcon.alignTo(this.wrap, 'tl-tr', [2, 0]); + }, + + // private + onRender : function(ct, position){ + Roo.form.TriggerField.superclass.onRender.call(this, ct, position); + this.wrap = this.el.wrap({cls: "x-form-field-wrap"}); + this.trigger = this.wrap.createChild(this.triggerConfig || + {tag: "img", src: Roo.BLANK_IMAGE_URL, cls: "x-form-trigger " + this.triggerClass}); + if(this.hideTrigger){ + this.trigger.setDisplayed(false); + } + this.initTrigger(); + if(!this.width){ + this.wrap.setWidth(this.el.getWidth()+this.trigger.getWidth()); + } + }, + + // private + initTrigger : function(){ + this.trigger.on("click", this.onTriggerClick, this, {preventDefault:true}); + this.trigger.addClassOnOver('x-form-trigger-over'); + this.trigger.addClassOnClick('x-form-trigger-click'); + }, + + // private + onDestroy : function(){ + if(this.trigger){ + this.trigger.removeAllListeners(); + this.trigger.remove(); + } + if(this.wrap){ + this.wrap.remove(); + } + Roo.form.TriggerField.superclass.onDestroy.call(this); + }, + + // private + onFocus : function(){ + Roo.form.TriggerField.superclass.onFocus.call(this); + if(!this.mimicing){ + this.wrap.addClass('x-trigger-wrap-focus'); + this.mimicing = true; + Roo.get(Roo.isIE ? document.body : document).on("mousedown", this.mimicBlur, this); + if(this.monitorTab){ + this.el.on("keydown", this.checkTab, this); + } + } + }, + + // private + checkTab : function(e){ + if(e.getKey() == e.TAB){ + this.triggerBlur(); + } + }, + + // private + onBlur : function(){ + // do nothing + }, + + // private + mimicBlur : function(e, t){ + if(!this.wrap.contains(t) && this.validateBlur()){ + this.triggerBlur(); + } + }, + + // private + triggerBlur : function(){ + this.mimicing = false; + Roo.get(Roo.isIE ? document.body : document).un("mousedown", this.mimicBlur); + if(this.monitorTab){ + this.el.un("keydown", this.checkTab, this); + } + this.wrap.removeClass('x-trigger-wrap-focus'); + Roo.form.TriggerField.superclass.onBlur.call(this); + }, + + // private + // This should be overriden by any subclass that needs to check whether or not the field can be blurred. + validateBlur : function(e, t){ + return true; + }, + + // private + onDisable : function(){ + Roo.form.TriggerField.superclass.onDisable.call(this); + if(this.wrap){ + this.wrap.addClass('x-item-disabled'); + } + }, + + // private + onEnable : function(){ + Roo.form.TriggerField.superclass.onEnable.call(this); + if(this.wrap){ + this.wrap.removeClass('x-item-disabled'); + } + }, + + // private + onShow : function(){ + var ae = this.getActionEl(); + + if(ae){ + ae.dom.style.display = ''; + ae.dom.style.visibility = 'visible'; + } + }, + + // private + + onHide : function(){ + var ae = this.getActionEl(); + ae.dom.style.display = 'none'; + }, + + /** + * The function that should handle the trigger's click event. This method does nothing by default until overridden + * by an implementing function. + * @method + * @param {EventObject} e + */ + onTriggerClick : Roo.emptyFn +}); + +// TwinTriggerField is not a public class to be used directly. It is meant as an abstract base class +// to be extended by an implementing class. For an example of implementing this class, see the custom +// SearchField implementation here: http://extjs.com/deploy/ext/examples/form/custom.html +Roo.form.TwinTriggerField = Roo.extend(Roo.form.TriggerField, { + initComponent : function(){ + Roo.form.TwinTriggerField.superclass.initComponent.call(this); + + this.triggerConfig = { + tag:'span', cls:'x-form-twin-triggers', cn:[ + {tag: "img", src: Roo.BLANK_IMAGE_URL, cls: "x-form-trigger " + this.trigger1Class}, + {tag: "img", src: Roo.BLANK_IMAGE_URL, cls: "x-form-trigger " + this.trigger2Class} + ]}; + }, + + getTrigger : function(index){ + return this.triggers[index]; + }, + + initTrigger : function(){ + var ts = this.trigger.select('.x-form-trigger', true); + this.wrap.setStyle('overflow', 'hidden'); + var triggerField = this; + ts.each(function(t, all, index){ + t.hide = function(){ + var w = triggerField.wrap.getWidth(); + this.dom.style.display = 'none'; + triggerField.el.setWidth(w-triggerField.trigger.getWidth()); + }; + t.show = function(){ + var w = triggerField.wrap.getWidth(); + this.dom.style.display = ''; + triggerField.el.setWidth(w-triggerField.trigger.getWidth()); + }; + var triggerIndex = 'Trigger'+(index+1); + + if(this['hide'+triggerIndex]){ + t.dom.style.display = 'none'; + } + t.on("click", this['on'+triggerIndex+'Click'], this, {preventDefault:true}); + t.addClassOnOver('x-form-trigger-over'); + t.addClassOnClick('x-form-trigger-click'); + }, this); + this.triggers = ts.elements; + }, + + onTrigger1Click : Roo.emptyFn, + onTrigger2Click : Roo.emptyFn +}); \ No newline at end of file diff --git a/docs2/src/Roo_form_VTypes.js.html b/docs2/src/Roo_form_VTypes.js.html new file mode 100644 index 0000000000..644f1bfae7 --- /dev/null +++ b/docs2/src/Roo_form_VTypes.js.html @@ -0,0 +1,92 @@ +/home/alan/gitlive/roojs1/Roo/form/VTypes.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.form.VTypes + * Overridable validation definitions. The validations provided are basic and intended to be easily customizable and extended. + * @singleton + */ +Roo.form.VTypes = function(){ + // closure these in so they are only created once. + var alpha = /^[a-zA-Z_]+$/; + var alphanum = /^[a-zA-Z0-9_]+$/; + var email = /^([\w]+)(.[\w]+)*@([\w-]+\.){1,5}([A-Za-z]){2,24}$/; + var url = /(((https?)|(ftp)):\/\/([\-\w]+\.)+\w{2,3}(\/[%\-\w]+(\.\w{2,})?)*(([\w\-\.\?\\\/+@&#;`~=%!]*)(\.\w{2,})?)*\/?)/i; + + // All these messages and functions are configurable + return { + /** + * The function used to validate email addresses + * @param {String} value The email address + */ + 'email' : function(v){ + return email.test(v); + }, + /** + * The error text to display when the email validation function returns false + * @type String + */ + 'emailText' : 'This field should be an e-mail address in the format "user@domain.com"', + /** + * The keystroke filter mask to be applied on email input + * @type RegExp + */ + 'emailMask' : /[a-z0-9_\.\-@]/i, + + /** + * The function used to validate URLs + * @param {String} value The URL + */ + 'url' : function(v){ + return url.test(v); + }, + /** + * The error text to display when the url validation function returns false + * @type String + */ + 'urlText' : 'This field should be a URL in the format "http:/'+'/www.domain.com"', + + /** + * The function used to validate alpha values + * @param {String} value The value + */ + 'alpha' : function(v){ + return alpha.test(v); + }, + /** + * The error text to display when the alpha validation function returns false + * @type String + */ + 'alphaText' : 'This field should only contain letters and _', + /** + * The keystroke filter mask to be applied on alpha input + * @type RegExp + */ + 'alphaMask' : /[a-z_]/i, + + /** + * The function used to validate alphanumeric values + * @param {String} value The value + */ + 'alphanum' : function(v){ + return alphanum.test(v); + }, + /** + * The error text to display when the alphanumeric validation function returns false + * @type String + */ + 'alphanumText' : 'This field should only contain letters, numbers and _', + /** + * The keystroke filter mask to be applied on alphanumeric input + * @type RegExp + */ + 'alphanumMask' : /[a-z0-9_]/i + }; +}(); \ No newline at end of file diff --git a/docs2/src/Roo_grid_AbstractGridView.js.html b/docs2/src/Roo_grid_AbstractGridView.js.html new file mode 100644 index 0000000000..3d8a2c3f63 --- /dev/null +++ b/docs2/src/Roo_grid_AbstractGridView.js.html @@ -0,0 +1,100 @@ +/home/alan/gitlive/roojs1/Roo/grid/AbstractGridView.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +Roo.grid.AbstractGridView = function(){ + this.grid = null; + + this.events = { + "beforerowremoved" : true, + "beforerowsinserted" : true, + "beforerefresh" : true, + "rowremoved" : true, + "rowsinserted" : true, + "rowupdated" : true, + "refresh" : true + }; + Roo.grid.AbstractGridView.superclass.constructor.call(this); +}; + +Roo.extend(Roo.grid.AbstractGridView, Roo.util.Observable, { + rowClass : "x-grid-row", + cellClass : "x-grid-cell", + tdClass : "x-grid-td", + hdClass : "x-grid-hd", + splitClass : "x-grid-hd-split", + + init: function(grid){ + this.grid = grid; + var cid = this.grid.getGridEl().id; + this.colSelector = "#" + cid + " ." + this.cellClass + "-"; + this.tdSelector = "#" + cid + " ." + this.tdClass + "-"; + this.hdSelector = "#" + cid + " ." + this.hdClass + "-"; + this.splitSelector = "#" + cid + " ." + this.splitClass + "-"; + }, + + getColumnRenderers : function(){ + var renderers = []; + var cm = this.grid.colModel; + var colCount = cm.getColumnCount(); + for(var i = 0; i < colCount; i++){ + renderers[i] = cm.getRenderer(i); + } + return renderers; + }, + + getColumnIds : function(){ + var ids = []; + var cm = this.grid.colModel; + var colCount = cm.getColumnCount(); + for(var i = 0; i < colCount; i++){ + ids[i] = cm.getColumnId(i); + } + return ids; + }, + + getDataIndexes : function(){ + if(!this.indexMap){ + this.indexMap = this.buildIndexMap(); + } + return this.indexMap.colToData; + }, + + getColumnIndexByDataIndex : function(dataIndex){ + if(!this.indexMap){ + this.indexMap = this.buildIndexMap(); + } + return this.indexMap.dataToCol[dataIndex]; + }, + + /** + * Set a css style for a column dynamically. + * @param {Number} colIndex The index of the column + * @param {String} name The css property name + * @param {String} value The css value + */ + setCSSStyle : function(colIndex, name, value){ + var selector = "#" + this.grid.id + " .x-grid-col-" + colIndex; + Roo.util.CSS.updateRule(selector, name, value); + }, + + generateRules : function(cm){ + var ruleBuf = [], rulesId = this.grid.id + '-cssrules'; + Roo.util.CSS.removeStyleSheet(rulesId); + for(var i = 0, len = cm.getColumnCount(); i < len; i++){ + var cid = cm.getColumnId(i); + ruleBuf.push(this.colSelector, cid, " {\n", cm.config[i].css, "}\n", + this.tdSelector, cid, " {\n}\n", + this.hdSelector, cid, " {\n}\n", + this.splitSelector, cid, " {\n}\n"); + } + return Roo.util.CSS.createStyleSheet(ruleBuf.join(""), rulesId); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_grid_AbstractSelectionModel.js.html b/docs2/src/Roo_grid_AbstractSelectionModel.js.html new file mode 100644 index 0000000000..9d8f7c48d8 --- /dev/null +++ b/docs2/src/Roo_grid_AbstractSelectionModel.js.html @@ -0,0 +1,52 @@ +/home/alan/gitlive/roojs1/Roo/grid/AbstractSelectionModel.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.grid.AbstractSelectionModel + * @extends Roo.util.Observable + * Abstract base class for grid SelectionModels. It provides the interface that should be + * implemented by descendant classes. This class should not be directly instantiated. + * @constructor + */ +Roo.grid.AbstractSelectionModel = function(){ + this.locked = false; + Roo.grid.AbstractSelectionModel.superclass.constructor.call(this); +}; + +Roo.extend(Roo.grid.AbstractSelectionModel, Roo.util.Observable, { + /** @ignore Called by the grid automatically. Do not call directly. */ + init : function(grid){ + this.grid = grid; + this.initEvents(); + }, + + /** + * Locks the selections. + */ + lock : function(){ + this.locked = true; + }, + + /** + * Unlocks the selections. + */ + unlock : function(){ + this.locked = false; + }, + + /** + * Returns true if the selections are locked. + * @return {Boolean} + */ + isLocked : function(){ + return this.locked; + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_grid_Calendar.js.html b/docs2/src/Roo_grid_Calendar.js.html new file mode 100644 index 0000000000..091e79e080 --- /dev/null +++ b/docs2/src/Roo_grid_Calendar.js.html @@ -0,0 +1,1278 @@ +/home/alan/gitlive/roojs1/Roo/grid/Calendar.js/* + + * Licence LGPL + + */ + +/** + * @class Roo.grid.Calendar + * @extends Roo.util.Grid + * This class extends the Grid to provide a calendar widget + * <br><br>Usage:<pre><code> + var grid = new Roo.grid.Calendar("my-container-id", { + ds: myDataStore, + cm: myColModel, + selModel: mySelectionModel, + autoSizeColumns: true, + monitorWindowResize: false, + trackMouseOver: true + eventstore : real data store.. + }); + // set any options + grid.render(); + + * @constructor + * @param {String/HTMLElement/Roo.Element} container The element into which this grid will be rendered - + * The container MUST have some type of size defined for the grid to fill. The container will be + * automatically set to position relative if it isn't already. + * @param {Object} config A config object that sets properties on this grid. + */ +Roo.grid.Calendar = function(container, config){ + // initialize the container + this.container = Roo.get(container); + this.container.update(""); + this.container.setStyle("overflow", "hidden"); + this.container.addClass('x-grid-container'); + + this.id = this.container.id; + + Roo.apply(this, config); + // check and correct shorthanded configs + + var rows = []; + var d =1; + for (var r = 0;r < 6;r++) { + + rows[r]=[]; + for (var c =0;c < 7;c++) { + rows[r][c]= ''; + } + } + if (this.eventStore) { + this.eventStore= Roo.factory(this.eventStore, Roo.data); + this.eventStore.on('load',this.onLoad, this); + this.eventStore.on('beforeload',this.clearEvents, this); + + } + + this.dataSource = new Roo.data.Store({ + proxy: new Roo.data.MemoryProxy(rows), + reader: new Roo.data.ArrayReader({}, [ + 'weekday0', 'weekday1', 'weekday2', 'weekday3', 'weekday4', 'weekday5', 'weekday6' ]) + }); + + this.dataSource.load(); + this.ds = this.dataSource; + this.ds.xmodule = this.xmodule || false; + + + var cellRender = function(v,x,r) + { + return String.format( + '<div class="fc-day fc-widget-content"><div>' + + '<div class="fc-event-container"></div>' + + '<div class="fc-day-number">{0}</div>'+ + + '<div class="fc-day-content"><div style="position:relative"></div></div>' + + '</div></div>', v); + + } + + + this.colModel = new Roo.grid.ColumnModel( [ + { + xtype: 'ColumnModel', + xns: Roo.grid, + dataIndex : 'weekday0', + header : 'Sunday', + renderer : cellRender + }, + { + xtype: 'ColumnModel', + xns: Roo.grid, + dataIndex : 'weekday1', + header : 'Monday', + renderer : cellRender + }, + { + xtype: 'ColumnModel', + xns: Roo.grid, + dataIndex : 'weekday2', + header : 'Tuesday', + renderer : cellRender + }, + { + xtype: 'ColumnModel', + xns: Roo.grid, + dataIndex : 'weekday3', + header : 'Wednesday', + renderer : cellRender + }, + { + xtype: 'ColumnModel', + xns: Roo.grid, + dataIndex : 'weekday4', + header : 'Thursday', + renderer : cellRender + }, + { + xtype: 'ColumnModel', + xns: Roo.grid, + dataIndex : 'weekday5', + header : 'Friday', + renderer : cellRender + }, + { + xtype: 'ColumnModel', + xns: Roo.grid, + dataIndex : 'weekday6', + header : 'Saturday', + renderer : cellRender + } + ]); + this.cm = this.colModel; + this.cm.xmodule = this.xmodule || false; + + + + //this.selModel = new Roo.grid.CellSelectionModel(); + //this.sm = this.selModel; + //this.selModel.init(this); + + + if(this.width){ + this.container.setWidth(this.width); + } + + if(this.height){ + this.container.setHeight(this.height); + } + /** @private */ + this.addEvents({ + // raw events + /** + * @event click + * The raw click event for the entire grid. + * @param {Roo.EventObject} e + */ + "click" : true, + /** + * @event dblclick + * The raw dblclick event for the entire grid. + * @param {Roo.EventObject} e + */ + "dblclick" : true, + /** + * @event contextmenu + * The raw contextmenu event for the entire grid. + * @param {Roo.EventObject} e + */ + "contextmenu" : true, + /** + * @event mousedown + * The raw mousedown event for the entire grid. + * @param {Roo.EventObject} e + */ + "mousedown" : true, + /** + * @event mouseup + * The raw mouseup event for the entire grid. + * @param {Roo.EventObject} e + */ + "mouseup" : true, + /** + * @event mouseover + * The raw mouseover event for the entire grid. + * @param {Roo.EventObject} e + */ + "mouseover" : true, + /** + * @event mouseout + * The raw mouseout event for the entire grid. + * @param {Roo.EventObject} e + */ + "mouseout" : true, + /** + * @event keypress + * The raw keypress event for the entire grid. + * @param {Roo.EventObject} e + */ + "keypress" : true, + /** + * @event keydown + * The raw keydown event for the entire grid. + * @param {Roo.EventObject} e + */ + "keydown" : true, + + // custom events + + /** + * @event cellclick + * Fires when a cell is clicked + * @param {Grid} this + * @param {Number} rowIndex + * @param {Number} columnIndex + * @param {Roo.EventObject} e + */ + "cellclick" : true, + /** + * @event celldblclick + * Fires when a cell is double clicked + * @param {Grid} this + * @param {Number} rowIndex + * @param {Number} columnIndex + * @param {Roo.EventObject} e + */ + "celldblclick" : true, + /** + * @event rowclick + * Fires when a row is clicked + * @param {Grid} this + * @param {Number} rowIndex + * @param {Roo.EventObject} e + */ + "rowclick" : true, + /** + * @event rowdblclick + * Fires when a row is double clicked + * @param {Grid} this + * @param {Number} rowIndex + * @param {Roo.EventObject} e + */ + "rowdblclick" : true, + /** + * @event headerclick + * Fires when a header is clicked + * @param {Grid} this + * @param {Number} columnIndex + * @param {Roo.EventObject} e + */ + "headerclick" : true, + /** + * @event headerdblclick + * Fires when a header cell is double clicked + * @param {Grid} this + * @param {Number} columnIndex + * @param {Roo.EventObject} e + */ + "headerdblclick" : true, + /** + * @event rowcontextmenu + * Fires when a row is right clicked + * @param {Grid} this + * @param {Number} rowIndex + * @param {Roo.EventObject} e + */ + "rowcontextmenu" : true, + /** + * @event cellcontextmenu + * Fires when a cell is right clicked + * @param {Grid} this + * @param {Number} rowIndex + * @param {Number} cellIndex + * @param {Roo.EventObject} e + */ + "cellcontextmenu" : true, + /** + * @event headercontextmenu + * Fires when a header is right clicked + * @param {Grid} this + * @param {Number} columnIndex + * @param {Roo.EventObject} e + */ + "headercontextmenu" : true, + /** + * @event bodyscroll + * Fires when the body element is scrolled + * @param {Number} scrollLeft + * @param {Number} scrollTop + */ + "bodyscroll" : true, + /** + * @event columnresize + * Fires when the user resizes a column + * @param {Number} columnIndex + * @param {Number} newSize + */ + "columnresize" : true, + /** + * @event columnmove + * Fires when the user moves a column + * @param {Number} oldIndex + * @param {Number} newIndex + */ + "columnmove" : true, + /** + * @event startdrag + * Fires when row(s) start being dragged + * @param {Grid} this + * @param {Roo.GridDD} dd The drag drop object + * @param {event} e The raw browser event + */ + "startdrag" : true, + /** + * @event enddrag + * Fires when a drag operation is complete + * @param {Grid} this + * @param {Roo.GridDD} dd The drag drop object + * @param {event} e The raw browser event + */ + "enddrag" : true, + /** + * @event dragdrop + * Fires when dragged row(s) are dropped on a valid DD target + * @param {Grid} this + * @param {Roo.GridDD} dd The drag drop object + * @param {String} targetId The target drag drop object + * @param {event} e The raw browser event + */ + "dragdrop" : true, + /** + * @event dragover + * Fires while row(s) are being dragged. "targetId" is the id of the Yahoo.util.DD object the selected rows are being dragged over. + * @param {Grid} this + * @param {Roo.GridDD} dd The drag drop object + * @param {String} targetId The target drag drop object + * @param {event} e The raw browser event + */ + "dragover" : true, + /** + * @event dragenter + * Fires when the dragged row(s) first cross another DD target while being dragged + * @param {Grid} this + * @param {Roo.GridDD} dd The drag drop object + * @param {String} targetId The target drag drop object + * @param {event} e The raw browser event + */ + "dragenter" : true, + /** + * @event dragout + * Fires when the dragged row(s) leave another DD target while being dragged + * @param {Grid} this + * @param {Roo.GridDD} dd The drag drop object + * @param {String} targetId The target drag drop object + * @param {event} e The raw browser event + */ + "dragout" : true, + /** + * @event rowclass + * Fires when a row is rendered, so you can change add a style to it. + * @param {GridView} gridview The grid view + * @param {Object} rowcfg contains record rowIndex and rowClass - set rowClass to add a style. + */ + 'rowclass' : true, + + /** + * @event render + * Fires when the grid is rendered + * @param {Grid} grid + */ + 'render' : true, + /** + * @event select + * Fires when a date is selected + * @param {DatePicker} this + * @param {Date} date The selected date + */ + 'select': true, + /** + * @event monthchange + * Fires when the displayed month changes + * @param {DatePicker} this + * @param {Date} date The selected month + */ + 'monthchange': true, + /** + * @event evententer + * Fires when mouse over an event + * @param {Calendar} this + * @param {event} Event + */ + 'evententer': true, + /** + * @event eventleave + * Fires when the mouse leaves an + * @param {Calendar} this + * @param {event} + */ + 'eventleave': true, + /** + * @event eventclick + * Fires when the mouse click an + * @param {Calendar} this + * @param {event} + */ + 'eventclick': true, + /** + * @event eventrender + * Fires before each cell is rendered, so you can modify the contents, like cls / title / qtip + * @param {Calendar} this + * @param {data} data to be modified + */ + 'eventrender': true + + }); + + Roo.grid.Grid.superclass.constructor.call(this); + this.on('render', function() { + this.view.el.addClass('x-grid-cal'); + + (function() { this.setDate(new Date()); }).defer(100,this); //default today.. + + },this); + + if (!Roo.grid.Calendar.style) { + Roo.grid.Calendar.style = Roo.util.CSS.createStyleSheet({ + + + '.x-grid-cal .x-grid-col' : { + height: 'auto !important', + 'vertical-align': 'top' + }, + '.x-grid-cal .fc-event-hori' : { + height: '14px' + } + + + }, Roo.id()); + } + + + +}; +Roo.extend(Roo.grid.Calendar, Roo.grid.Grid, { + /** + * @cfg {Store} eventStore The store that loads events. + */ + eventStore : 25, + + + activeDate : false, + startDay : 0, + autoWidth : true, + monitorWindowResize : false, + + + resizeColumns : function() { + var col = (this.view.el.getWidth() / 7) - 3; + // loop through cols, and setWidth + for(var i =0 ; i < 7 ; i++){ + this.cm.setColumnWidth(i, col); + } + }, + setDate :function(date) { + + Roo.log('setDate?'); + + this.resizeColumns(); + var vd = this.activeDate; + this.activeDate = date; +// if(vd && this.el){ +// var t = date.getTime(); +// if(vd.getMonth() == date.getMonth() && vd.getFullYear() == date.getFullYear()){ +// Roo.log('using add remove'); +// +// this.fireEvent('monthchange', this, date); +// +// this.cells.removeClass("fc-state-highlight"); +// this.cells.each(function(c){ +// if(c.dateValue == t){ +// c.addClass("fc-state-highlight"); +// setTimeout(function(){ +// try{c.dom.firstChild.focus();}catch(e){} +// }, 50); +// return false; +// } +// return true; +// }); +// return; +// } +// } + + var days = date.getDaysInMonth(); + + var firstOfMonth = date.getFirstDateOfMonth(); + var startingPos = firstOfMonth.getDay()-this.startDay; + + if(startingPos < this.startDay){ + startingPos += 7; + } + + var pm = date.add(Date.MONTH, -1); + var prevStart = pm.getDaysInMonth()-startingPos; +// + + + this.cells = this.view.el.select('.x-grid-row .x-grid-col',true); + + this.textNodes = this.view.el.query('.x-grid-row .x-grid-col .x-grid-cell-text'); + //this.cells.addClassOnOver('fc-state-hover'); + + var cells = this.cells.elements; + var textEls = this.textNodes; + + //Roo.each(cells, function(cell){ + // cell.removeClass([ 'fc-past', 'fc-other-month', 'fc-future', 'fc-state-highlight', 'fc-state-disabled']); + //}); + + days += startingPos; + + // convert everything to numbers so it's fast + var day = 86400000; + var d = (new Date(pm.getFullYear(), pm.getMonth(), prevStart)).clearTime(); + //Roo.log(d); + //Roo.log(pm); + //Roo.log(prevStart); + + var today = new Date().clearTime().getTime(); + var sel = date.clearTime().getTime(); + var min = this.minDate ? this.minDate.clearTime() : Number.NEGATIVE_INFINITY; + var max = this.maxDate ? this.maxDate.clearTime() : Number.POSITIVE_INFINITY; + var ddMatch = this.disabledDatesRE; + var ddText = this.disabledDatesText; + var ddays = this.disabledDays ? this.disabledDays.join("") : false; + var ddaysText = this.disabledDaysText; + var format = this.format; + + var setCellClass = function(cal, cell){ + + //Roo.log('set Cell Class'); + cell.title = ""; + var t = d.getTime(); + + //Roo.log(d); + + + cell.dateValue = t; + if(t == today){ + cell.className += " fc-today"; + cell.className += " fc-state-highlight"; + cell.title = cal.todayText; + } + if(t == sel){ + // disable highlight in other month.. + cell.className += " fc-state-highlight"; + + } + // disabling + if(t < min) { + //cell.className = " fc-state-disabled"; + cell.title = cal.minText; + return; + } + if(t > max) { + //cell.className = " fc-state-disabled"; + cell.title = cal.maxText; + return; + } + if(ddays){ + if(ddays.indexOf(d.getDay()) != -1){ + // cell.title = ddaysText; + // cell.className = " fc-state-disabled"; + } + } + if(ddMatch && format){ + var fvalue = d.dateFormat(format); + if(ddMatch.test(fvalue)){ + cell.title = ddText.replace("%0", fvalue); + cell.className = " fc-state-disabled"; + } + } + + if (!cell.initialClassName) { + cell.initialClassName = cell.dom.className; + } + + cell.dom.className = cell.initialClassName + ' ' + cell.className; + }; + + var i = 0; + + for(; i < startingPos; i++) { + cells[i].dayName = (++prevStart); + Roo.log(textEls[i]); + d.setDate(d.getDate()+1); + + //cells[i].className = "fc-past fc-other-month"; + setCellClass(this, cells[i]); + } + + var intDay = 0; + + for(; i < days; i++){ + intDay = i - startingPos + 1; + cells[i].dayName = (intDay); + d.setDate(d.getDate()+1); + + cells[i].className = ''; // "x-date-active"; + setCellClass(this, cells[i]); + } + var extraDays = 0; + + for(; i < 42; i++) { + //textEls[i].innerHTML = (++extraDays); + + d.setDate(d.getDate()+1); + cells[i].dayName = (++extraDays); + cells[i].className = "fc-future fc-other-month"; + setCellClass(this, cells[i]); + } + + //this.el.select('.fc-header-title h2',true).update(Date.monthNames[date.getMonth()] + " " + date.getFullYear()); + + var totalRows = Math.ceil((date.getDaysInMonth() + date.getFirstDateOfMonth().getDay()) / 7); + + // this will cause all the cells to mis + var rows= []; + var i =0; + for (var r = 0;r < 6;r++) { + for (var c =0;c < 7;c++) { + this.ds.getAt(r).set('weekday' + c ,cells[i++].dayName ); + } + } + + this.cells = this.view.el.select('.x-grid-row .x-grid-col',true); + for(i=0;i<cells.length;i++) { + + this.cells.elements[i].dayName = cells[i].dayName ; + this.cells.elements[i].className = cells[i].className; + this.cells.elements[i].initialClassName = cells[i].initialClassName ; + this.cells.elements[i].title = cells[i].title ; + this.cells.elements[i].dateValue = cells[i].dateValue ; + } + + + + + //this.el.select('tr.fc-week.fc-prev-last',true).removeClass('fc-last'); + //this.el.select('tr.fc-week.fc-next-last',true).addClass('fc-last').show(); + + ////if(totalRows != 6){ + //this.el.select('tr.fc-week.fc-last',true).removeClass('fc-last').addClass('fc-next-last').hide(); + // this.el.select('tr.fc-week.fc-prev-last',true).addClass('fc-last'); + // } + + this.fireEvent('monthchange', this, date); + + + }, + /** + * Returns the grid's SelectionModel. + * @return {SelectionModel} + */ + getSelectionModel : function(){ + if(!this.selModel){ + this.selModel = new Roo.grid.CellSelectionModel(); + } + return this.selModel; + }, + + load: function() { + this.eventStore.load() + + + + }, + + findCell : function(dt) { + dt = dt.clearTime().getTime(); + var ret = false; + this.cells.each(function(c){ + //Roo.log("check " +c.dateValue + '?=' + dt); + if(c.dateValue == dt){ + ret = c; + return false; + } + return true; + }); + + return ret; + }, + + findCells : function(rec) { + var s = rec.data.start_dt.clone().clearTime().getTime(); + // Roo.log(s); + var e= rec.data.end_dt.clone().clearTime().getTime(); + // Roo.log(e); + var ret = []; + this.cells.each(function(c){ + ////Roo.log("check " +c.dateValue + '<' + e + ' > ' + s); + + if(c.dateValue > e){ + return ; + } + if(c.dateValue < s){ + return ; + } + ret.push(c); + }); + + return ret; + }, + + findBestRow: function(cells) + { + var ret = 0; + + for (var i =0 ; i < cells.length;i++) { + ret = Math.max(cells[i].rows || 0,ret); + } + return ret; + + }, + + + addItem : function(rec) + { + // look for vertical location slot in + var cells = this.findCells(rec); + + rec.row = this.findBestRow(cells); + + // work out the location. + + var crow = false; + var rows = []; + for(var i =0; i < cells.length; i++) { + if (!crow) { + crow = { + start : cells[i], + end : cells[i] + }; + continue; + } + if (crow.start.getY() == cells[i].getY()) { + // on same row. + crow.end = cells[i]; + continue; + } + // different row. + rows.push(crow); + crow = { + start: cells[i], + end : cells[i] + }; + + } + + rows.push(crow); + rec.els = []; + rec.rows = rows; + rec.cells = cells; + for (var i = 0; i < cells.length;i++) { + cells[i].rows = Math.max(cells[i].rows || 0 , rec.row + 1 ); + + } + + + }, + + clearEvents: function() { + + if (!this.eventStore.getCount()) { + return; + } + // reset number of rows in cells. + Roo.each(this.cells.elements, function(c){ + c.rows = 0; + }); + + this.eventStore.each(function(e) { + this.clearEvent(e); + },this); + + }, + + clearEvent : function(ev) + { + if (ev.els) { + Roo.each(ev.els, function(el) { + el.un('mouseenter' ,this.onEventEnter, this); + el.un('mouseleave' ,this.onEventLeave, this); + el.remove(); + },this); + ev.els = []; + } + }, + + + renderEvent : function(ev,ctr) { + if (!ctr) { + ctr = this.view.el.select('.fc-event-container',true).first(); + } + + + this.clearEvent(ev); + //code + + + + ev.els = []; + var cells = ev.cells; + var rows = ev.rows; + this.fireEvent('eventrender', this, ev); + + for(var i =0; i < rows.length; i++) { + + cls = ''; + if (i == 0) { + cls += ' fc-event-start'; + } + if ((i+1) == rows.length) { + cls += ' fc-event-end'; + } + + //Roo.log(ev.data); + // how many rows should it span.. + var cg = this.eventTmpl.append(ctr,Roo.apply({ + fccls : cls + + }, ev.data) , true); + + + cg.on('mouseenter' ,this.onEventEnter, this, ev); + cg.on('mouseleave' ,this.onEventLeave, this, ev); + cg.on('click', this.onEventClick, this, ev); + + ev.els.push(cg); + + var sbox = rows[i].start.select('.fc-day-content',true).first().getBox(); + var ebox = rows[i].end.select('.fc-day-content',true).first().getBox(); + //Roo.log(cg); + + cg.setXY([sbox.x +2, sbox.y +(ev.row * 20)]); + cg.setWidth(ebox.right - sbox.x -2); + } + }, + + renderEvents: function() + { + // first make sure there is enough space.. + + if (!this.eventTmpl) { + this.eventTmpl = new Roo.Template( + '<div class="roo-dynamic fc-event fc-event-hori fc-event-draggable ui-draggable {fccls} {cls}" style="position: absolute" unselectable="on">' + + '<div class="fc-event-inner">' + + '<span class="fc-event-time">{time}</span>' + + '<span class="fc-event-title" qtip="{qtip}">{title}</span>' + + '</div>' + + '<div class="ui-resizable-heandle ui-resizable-e">&nbsp;&nbsp;&nbsp;</div>' + + '</div>' + ); + + } + + + + this.cells.each(function(c) { + //Roo.log(c.select('.fc-day-content div',true).first()); + c.select('.fc-day-content div',true).first().setHeight(Math.max(34, (c.rows || 1) * 20)); + }); + + var ctr = this.view.el.select('.fc-event-container',true).first(); + + var cls; + this.eventStore.each(function(ev){ + + this.renderEvent(ev); + + + }, this); + this.view.layout(); + + }, + + onEventEnter: function (e, el,event,d) { + this.fireEvent('evententer', this, el, event); + }, + + onEventLeave: function (e, el,event,d) { + this.fireEvent('eventleave', this, el, event); + }, + + onEventClick: function (e, el,event,d) { + this.fireEvent('eventclick', this, el, event); + }, + + onMonthChange: function () { + this.store.load(); + }, + + onLoad: function () { + + //Roo.log('calendar onload'); +// + if(this.eventStore.getCount() > 0){ + + + + this.eventStore.each(function(d){ + + + // FIXME.. + var add = d.data; + if (typeof(add.end_dt) == 'undefined') { + Roo.log("Missing End time in calendar data: "); + Roo.log(d); + return; + } + if (typeof(add.start_dt) == 'undefined') { + Roo.log("Missing Start time in calendar data: "); + Roo.log(d); + return; + } + add.start_dt = typeof(add.start_dt) == 'string' ? Date.parseDate(add.start_dt,'Y-m-d H:i:s') : add.start_dt, + add.end_dt = typeof(add.end_dt) == 'string' ? Date.parseDate(add.end_dt,'Y-m-d H:i:s') : add.end_dt, + add.id = add.id || d.id; + add.title = add.title || '??'; + + this.addItem(d); + + + },this); + } + + this.renderEvents(); + } + + +}); +/* + grid : { + xtype: 'Grid', + xns: Roo.grid, + listeners : { + render : function () + { + _this.grid = this; + + if (!this.view.el.hasClass('course-timesheet')) { + this.view.el.addClass('course-timesheet'); + } + if (this.tsStyle) { + this.ds.load({}); + return; + } + Roo.log('width'); + Roo.log(_this.grid.view.el.getWidth()); + + + this.tsStyle = Roo.util.CSS.createStyleSheet({ + '.course-timesheet .x-grid-row' : { + height: '80px' + }, + '.x-grid-row td' : { + 'vertical-align' : 0 + }, + '.course-edit-link' : { + 'color' : 'blue', + 'text-overflow' : 'ellipsis', + 'overflow' : 'hidden', + 'white-space' : 'nowrap', + 'cursor' : 'pointer' + }, + '.sub-link' : { + 'color' : 'green' + }, + '.de-act-sup-link' : { + 'color' : 'purple', + 'text-decoration' : 'line-through' + }, + '.de-act-link' : { + 'color' : 'red', + 'text-decoration' : 'line-through' + }, + '.course-timesheet .course-highlight' : { + 'border-top-style': 'dashed !important', + 'border-bottom-bottom': 'dashed !important' + }, + '.course-timesheet .course-item' : { + 'font-family' : 'tahoma, arial, helvetica', + 'font-size' : '11px', + 'overflow' : 'hidden', + 'padding-left' : '10px', + 'padding-right' : '10px', + 'padding-top' : '10px' + } + + }, Roo.id()); + this.ds.load({}); + } + }, + autoWidth : true, + monitorWindowResize : false, + cellrenderer : function(v,x,r) + { + return v; + }, + sm : { + xtype: 'CellSelectionModel', + xns: Roo.grid + }, + dataSource : { + xtype: 'Store', + xns: Roo.data, + listeners : { + beforeload : function (_self, options) + { + options.params = options.params || {}; + options.params._month = _this.monthField.getValue(); + options.params.limit = 9999; + options.params['sort'] = 'when_dt'; + options.params['dir'] = 'ASC'; + this.proxy.loadResponse = this.loadResponse; + Roo.log("load?"); + //this.addColumns(); + }, + load : function (_self, records, options) + { + _this.grid.view.el.select('.course-edit-link', true).on('click', function() { + // if you click on the translation.. you can edit it... + var el = Roo.get(this); + var id = el.dom.getAttribute('data-id'); + var d = el.dom.getAttribute('data-date'); + var t = el.dom.getAttribute('data-time'); + //var id = this.child('span').dom.textContent; + + //Roo.log(this); + Pman.Dialog.CourseCalendar.show({ + id : id, + when_d : d, + when_t : t, + productitem_active : id ? 1 : 0 + }, function() { + _this.grid.ds.load({}); + }); + + }); + + _this.panel.fireEvent('resize', [ '', '' ]); + } + }, + loadResponse : function(o, success, response){ + // this is overridden on before load.. + + Roo.log("our code?"); + //Roo.log(success); + //Roo.log(response) + delete this.activeRequest; + if(!success){ + this.fireEvent("loadexception", this, o, response); + o.request.callback.call(o.request.scope, null, o.request.arg, false); + return; + } + var result; + try { + result = o.reader.read(response); + }catch(e){ + Roo.log("load exception?"); + this.fireEvent("loadexception", this, o, response, e); + o.request.callback.call(o.request.scope, null, o.request.arg, false); + return; + } + Roo.log("ready..."); + // loop through result.records; + // and set this.tdate[date] = [] << array of records.. + _this.tdata = {}; + Roo.each(result.records, function(r){ + //Roo.log(r.data); + if(typeof(_this.tdata[r.data.when_dt.format('j')]) == 'undefined'){ + _this.tdata[r.data.when_dt.format('j')] = []; + } + _this.tdata[r.data.when_dt.format('j')].push(r.data); + }); + + //Roo.log(_this.tdata); + + result.records = []; + result.totalRecords = 6; + + // let's generate some duumy records for the rows. + //var st = _this.dateField.getValue(); + + // work out monday.. + //st = st.add(Date.DAY, -1 * st.format('w')); + + var date = Date.parseDate(_this.monthField.getValue(), "Y-m-d"); + + var firstOfMonth = date.getFirstDayOfMonth(); + var days = date.getDaysInMonth(); + var d = 1; + var firstAdded = false; + for (var i = 0; i < result.totalRecords ; i++) { + //var d= st.add(Date.DAY, i); + var row = {}; + var added = 0; + for(var w = 0 ; w < 7 ; w++){ + if(!firstAdded && firstOfMonth != w){ + continue; + } + if(d > days){ + continue; + } + firstAdded = true; + var dd = (d > 0 && d < 10) ? "0"+d : d; + row['weekday'+w] = String.format( + '<span style="font-size: 16px;"><b>{0}</b></span>'+ + '<span class="course-edit-link" style="color:blue;" data-id="0" data-date="{1}"> Add New</span>', + d, + date.format('Y-m-')+dd + ); + added++; + if(typeof(_this.tdata[d]) != 'undefined'){ + Roo.each(_this.tdata[d], function(r){ + var is_sub = ''; + var deactive = ''; + var id = r.id; + var desc = (r.productitem_id_descrip) ? r.productitem_id_descrip : ''; + if(r.parent_id*1>0){ + is_sub = (r.productitem_id_visible*1 < 1) ? 'de-act-sup-link' :'sub-link'; + id = r.parent_id; + } + if(r.productitem_id_visible*1 < 1 && r.parent_id*1 < 1){ + deactive = 'de-act-link'; + } + + row['weekday'+w] += String.format( + '<br /><span class="course-edit-link {3} {4}" qtip="{5}" data-id="{0}">{2} - {1}</span>', + id, //0 + r.product_id_name, //1 + r.when_dt.format('h:ia'), //2 + is_sub, //3 + deactive, //4 + desc // 5 + ); + }); + } + d++; + } + + // only do this if something added.. + if(added > 0){ + result.records.push(_this.grid.dataSource.reader.newRow(row)); + } + + + // push it twice. (second one with an hour.. + + } + //Roo.log(result); + this.fireEvent("load", this, o, o.request.arg); + o.request.callback.call(o.request.scope, result, o.request.arg, true); + }, + sortInfo : {field: 'when_dt', direction : 'ASC' }, + proxy : { + xtype: 'HttpProxy', + xns: Roo.data, + method : 'GET', + url : baseURL + '/Roo/Shop_course.php' + }, + reader : { + xtype: 'JsonReader', + xns: Roo.data, + id : 'id', + fields : [ + { + 'name': 'id', + 'type': 'int' + }, + { + 'name': 'when_dt', + 'type': 'string' + }, + { + 'name': 'end_dt', + 'type': 'string' + }, + { + 'name': 'parent_id', + 'type': 'int' + }, + { + 'name': 'product_id', + 'type': 'int' + }, + { + 'name': 'productitem_id', + 'type': 'int' + }, + { + 'name': 'guid', + 'type': 'int' + } + ] + } + }, + toolbar : { + xtype: 'Toolbar', + xns: Roo, + items : [ + { + xtype: 'Button', + xns: Roo.Toolbar, + listeners : { + click : function (_self, e) + { + var sd = Date.parseDate(_this.monthField.getValue(), "Y-m-d"); + sd.setMonth(sd.getMonth()-1); + _this.monthField.setValue(sd.format('Y-m-d')); + _this.grid.ds.load({}); + } + }, + text : "Back" + }, + { + xtype: 'Separator', + xns: Roo.Toolbar + }, + { + xtype: 'MonthField', + xns: Roo.form, + listeners : { + render : function (_self) + { + _this.monthField = _self; + // _this.monthField.set today + }, + select : function (combo, date) + { + _this.grid.ds.load({}); + } + }, + value : (function() { return new Date(); })() + }, + { + xtype: 'Separator', + xns: Roo.Toolbar + }, + { + xtype: 'TextItem', + xns: Roo.Toolbar, + text : "Blue: in-active, green: in-active sup-event, red: de-active, purple: de-active sup-event" + }, + { + xtype: 'Fill', + xns: Roo.Toolbar + }, + { + xtype: 'Button', + xns: Roo.Toolbar, + listeners : { + click : function (_self, e) + { + var sd = Date.parseDate(_this.monthField.getValue(), "Y-m-d"); + sd.setMonth(sd.getMonth()+1); + _this.monthField.setValue(sd.format('Y-m-d')); + _this.grid.ds.load({}); + } + }, + text : "Next" + } + ] + }, + + } + }; + + */ \ No newline at end of file diff --git a/docs2/src/Roo_grid_CellSelectionModel.js.html b/docs2/src/Roo_grid_CellSelectionModel.js.html new file mode 100644 index 0000000000..79584b2fc5 --- /dev/null +++ b/docs2/src/Roo_grid_CellSelectionModel.js.html @@ -0,0 +1,312 @@ +/home/alan/gitlive/roojs1/Roo/grid/CellSelectionModel.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.grid.CellSelectionModel + * @extends Roo.grid.AbstractSelectionModel + * This class provides the basic implementation for cell selection in a grid. + * @constructor + * @param {Object} config The object containing the configuration of this model. + * @cfg {Boolean} enter_is_tab Enter behaves the same as tab. (eg. goes to next cell) default: false + */ +Roo.grid.CellSelectionModel = function(config){ + Roo.apply(this, config); + + this.selection = null; + + this.addEvents({ + /** + * @event beforerowselect + * Fires before a cell is selected. + * @param {SelectionModel} this + * @param {Number} rowIndex The selected row index + * @param {Number} colIndex The selected cell index + */ + "beforecellselect" : true, + /** + * @event cellselect + * Fires when a cell is selected. + * @param {SelectionModel} this + * @param {Number} rowIndex The selected row index + * @param {Number} colIndex The selected cell index + */ + "cellselect" : true, + /** + * @event selectionchange + * Fires when the active selection changes. + * @param {SelectionModel} this + * @param {Object} selection null for no selection or an object (o) with two properties + <ul> + <li>o.record: the record object for the row the selection is in</li> + <li>o.cell: An array of [rowIndex, columnIndex]</li> + </ul> + */ + "selectionchange" : true, + /** + * @event tabend + * Fires when the tab (or enter) was pressed on the last editable cell + * You can use this to trigger add new row. + * @param {SelectionModel} this + */ + "tabend" : true, + /** + * @event beforeeditnext + * Fires before the next editable sell is made active + * You can use this to skip to another cell or fire the tabend + * if you set cell to false + * @param {Object} eventdata object : { cell : [ row, col ] } + */ + "beforeeditnext" : true + }); + Roo.grid.CellSelectionModel.superclass.constructor.call(this); +}; + +Roo.extend(Roo.grid.CellSelectionModel, Roo.grid.AbstractSelectionModel, { + + enter_is_tab: false, + + /** @ignore */ + initEvents : function(){ + this.grid.on("mousedown", this.handleMouseDown, this); + this.grid.getGridEl().on(Roo.isIE ? "keydown" : "keypress", this.handleKeyDown, this); + var view = this.grid.view; + view.on("refresh", this.onViewChange, this); + view.on("rowupdated", this.onRowUpdated, this); + view.on("beforerowremoved", this.clearSelections, this); + view.on("beforerowsinserted", this.clearSelections, this); + if(this.grid.isEditor){ + this.grid.on("beforeedit", this.beforeEdit, this); + } + }, + + //private + beforeEdit : function(e){ + this.select(e.row, e.column, false, true, e.record); + }, + + //private + onRowUpdated : function(v, index, r){ + if(this.selection && this.selection.record == r){ + v.onCellSelect(index, this.selection.cell[1]); + } + }, + + //private + onViewChange : function(){ + this.clearSelections(true); + }, + + /** + * Returns the currently selected cell,. + * @return {Array} The selected cell (row, column) or null if none selected. + */ + getSelectedCell : function(){ + return this.selection ? this.selection.cell : null; + }, + + /** + * Clears all selections. + * @param {Boolean} true to prevent the gridview from being notified about the change. + */ + clearSelections : function(preventNotify){ + var s = this.selection; + if(s){ + if(preventNotify !== true){ + this.grid.view.onCellDeselect(s.cell[0], s.cell[1]); + } + this.selection = null; + this.fireEvent("selectionchange", this, null); + } + }, + + /** + * Returns true if there is a selection. + * @return {Boolean} + */ + hasSelection : function(){ + return this.selection ? true : false; + }, + + /** @ignore */ + handleMouseDown : function(e, t){ + var v = this.grid.getView(); + if(this.isLocked()){ + return; + }; + var row = v.findRowIndex(t); + var cell = v.findCellIndex(t); + if(row !== false && cell !== false){ + this.select(row, cell); + } + }, + + /** + * Selects a cell. + * @param {Number} rowIndex + * @param {Number} collIndex + */ + select : function(rowIndex, colIndex, preventViewNotify, preventFocus, /*internal*/ r){ + if(this.fireEvent("beforecellselect", this, rowIndex, colIndex) !== false){ + this.clearSelections(); + r = r || this.grid.dataSource.getAt(rowIndex); + this.selection = { + record : r, + cell : [rowIndex, colIndex] + }; + if(!preventViewNotify){ + var v = this.grid.getView(); + v.onCellSelect(rowIndex, colIndex); + if(preventFocus !== true){ + v.focusCell(rowIndex, colIndex); + } + } + this.fireEvent("cellselect", this, rowIndex, colIndex); + this.fireEvent("selectionchange", this, this.selection); + } + }, + + //private + isSelectable : function(rowIndex, colIndex, cm){ + return !cm.isHidden(colIndex); + }, + + /** @ignore */ + handleKeyDown : function(e){ + //Roo.log('Cell Sel Model handleKeyDown'); + if(!e.isNavKeyPress()){ + return; + } + var g = this.grid, s = this.selection; + if(!s){ + e.stopEvent(); + var cell = g.walkCells(0, 0, 1, this.isSelectable, this); + if(cell){ + this.select(cell[0], cell[1]); + } + return; + } + var sm = this; + var walk = function(row, col, step){ + return g.walkCells(row, col, step, sm.isSelectable, sm); + }; + var k = e.getKey(), r = s.cell[0], c = s.cell[1]; + var newCell; + + + + switch(k){ + case e.TAB: + // handled by onEditorKey + if (g.isEditor && g.editing) { + return; + } + if(e.shiftKey) { + newCell = walk(r, c-1, -1); + } else { + newCell = walk(r, c+1, 1); + } + break; + + case e.DOWN: + newCell = walk(r+1, c, 1); + break; + + case e.UP: + newCell = walk(r-1, c, -1); + break; + + case e.RIGHT: + newCell = walk(r, c+1, 1); + break; + + case e.LEFT: + newCell = walk(r, c-1, -1); + break; + + case e.ENTER: + + if(g.isEditor && !g.editing){ + g.startEditing(r, c); + e.stopEvent(); + return; + } + + + break; + }; + if(newCell){ + this.select(newCell[0], newCell[1]); + e.stopEvent(); + + } + }, + + acceptsNav : function(row, col, cm){ + return !cm.isHidden(col) && cm.isCellEditable(col, row); + }, + /** + * Selects a cell. + * @param {Number} field (not used) - as it's normally used as a listener + * @param {Number} e - event - fake it by using + * + * var e = Roo.EventObjectImpl.prototype; + * e.keyCode = e.TAB + * + * + */ + onEditorKey : function(field, e){ + + var k = e.getKey(), + newCell, + g = this.grid, + ed = g.activeEditor, + forward = false; + ///Roo.log('onEditorKey' + k); + + + if (this.enter_is_tab && k == e.ENTER) { + k = e.TAB; + } + + if(k == e.TAB){ + if(e.shiftKey){ + newCell = g.walkCells(ed.row, ed.col-1, -1, this.acceptsNav, this); + }else{ + newCell = g.walkCells(ed.row, ed.col+1, 1, this.acceptsNav, this); + forward = true; + } + + e.stopEvent(); + + } else if(k == e.ENTER && !e.ctrlKey){ + ed.completeEdit(); + e.stopEvent(); + newCell = g.walkCells(ed.row, ed.col+1, 1, this.acceptsNav, this); + + } else if(k == e.ESC){ + ed.cancelEdit(); + } + + if (newCell) { + var ecall = { cell : newCell, forward : forward }; + this.fireEvent('beforeeditnext', ecall ); + newCell = ecall.cell; + forward = ecall.forward; + } + + if(newCell){ + //Roo.log('next cell after edit'); + g.startEditing.defer(100, g, [newCell[0], newCell[1]]); + } else if (forward) { + // tabbed past last + this.fireEvent.defer(100, this, ['tabend',this]); + } + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_grid_ColumnModel.js.html b/docs2/src/Roo_grid_ColumnModel.js.html new file mode 100644 index 0000000000..965bb844d3 --- /dev/null +++ b/docs2/src/Roo_grid_ColumnModel.js.html @@ -0,0 +1,549 @@ +/home/alan/gitlive/roojs1/Roo/grid/ColumnModel.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.grid.ColumnModel + * @extends Roo.util.Observable + * This is the default implementation of a ColumnModel used by the Grid. It defines + * the columns in the grid. + * <br>Usage:<br> + <pre><code> + var colModel = new Roo.grid.ColumnModel([ + {header: "Ticker", width: 60, sortable: true, locked: true}, + {header: "Company Name", width: 150, sortable: true}, + {header: "Market Cap.", width: 100, sortable: true}, + {header: "$ Sales", width: 100, sortable: true, renderer: money}, + {header: "Employees", width: 100, sortable: true, resizable: false} + ]); + </code></pre> + * <p> + + * The config options listed for this class are options which may appear in each + * individual column definition. + * <br/>RooJS Fix - column id's are not sequential but use Roo.id() - fixes bugs with layouts. + * @constructor + * @param {Object} config An Array of column config objects. See this class's + * config objects for details. +*/ +Roo.grid.ColumnModel = function(config){ + /** + * The config passed into the constructor + */ + this.config = config; + this.lookup = {}; + + // if no id, create one + // if the column does not have a dataIndex mapping, + // map it to the order it is in the config + for(var i = 0, len = config.length; i < len; i++){ + var c = config[i]; + if(typeof c.dataIndex == "undefined"){ + c.dataIndex = i; + } + if(typeof c.renderer == "string"){ + c.renderer = Roo.util.Format[c.renderer]; + } + if(typeof c.id == "undefined"){ + c.id = Roo.id(); + } + if(c.editor && c.editor.xtype){ + c.editor = Roo.factory(c.editor, Roo.grid); + } + if(c.editor && c.editor.isFormField){ + c.editor = new Roo.grid.GridEditor(c.editor); + } + this.lookup[c.id] = c; + } + + /** + * The width of columns which have no width specified (defaults to 100) + * @type Number + */ + this.defaultWidth = 100; + + /** + * Default sortable of columns which have no sortable specified (defaults to false) + * @type Boolean + */ + this.defaultSortable = false; + + this.addEvents({ + /** + * @event widthchange + * Fires when the width of a column changes. + * @param {ColumnModel} this + * @param {Number} columnIndex The column index + * @param {Number} newWidth The new width + */ + "widthchange": true, + /** + * @event headerchange + * Fires when the text of a header changes. + * @param {ColumnModel} this + * @param {Number} columnIndex The column index + * @param {Number} newText The new header text + */ + "headerchange": true, + /** + * @event hiddenchange + * Fires when a column is hidden or "unhidden". + * @param {ColumnModel} this + * @param {Number} columnIndex The column index + * @param {Boolean} hidden true if hidden, false otherwise + */ + "hiddenchange": true, + /** + * @event columnmoved + * Fires when a column is moved. + * @param {ColumnModel} this + * @param {Number} oldIndex + * @param {Number} newIndex + */ + "columnmoved" : true, + /** + * @event columlockchange + * Fires when a column's locked state is changed + * @param {ColumnModel} this + * @param {Number} colIndex + * @param {Boolean} locked true if locked + */ + "columnlockchange" : true + }); + Roo.grid.ColumnModel.superclass.constructor.call(this); +}; +Roo.extend(Roo.grid.ColumnModel, Roo.util.Observable, { + /** + * @cfg {String} header The header text to display in the Grid view. + */ + /** + * @cfg {String} dataIndex (Optional) The name of the field in the grid's {@link Roo.data.Store}'s + * {@link Roo.data.Record} definition from which to draw the column's value. If not + * specified, the column's index is used as an index into the Record's data Array. + */ + /** + * @cfg {Number} width (Optional) The initial width in pixels of the column. Using this + * instead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient. + */ + /** + * @cfg {Boolean} sortable (Optional) True if sorting is to be allowed on this column. + * Defaults to the value of the {@link #defaultSortable} property. + * Whether local/remote sorting is used is specified in {@link Roo.data.Store#remoteSort}. + */ + /** + * @cfg {Boolean} locked (Optional) True to lock the column in place while scrolling the Grid. Defaults to false. + */ + /** + * @cfg {Boolean} fixed (Optional) True if the column width cannot be changed. Defaults to false. + */ + /** + * @cfg {Boolean} resizable (Optional) False to disable column resizing. Defaults to true. + */ + /** + * @cfg {Boolean} hidden (Optional) True to hide the column. Defaults to false. + */ + /** + * @cfg {Function} renderer (Optional) A function used to generate HTML markup for a cell + * given the cell's data value. See {@link #setRenderer}. If not specified, the + * default renderer returns the escaped data value. If an object is returned (bootstrap only) + * then it is treated as a Roo Component object instance, and it is rendered after the initial row is rendered + */ + /** + * @cfg {Roo.grid.GridEditor} editor (Optional) For grid editors - returns the grid editor + */ + /** + * @cfg {String} align (Optional) Set the CSS text-align property of the column. Defaults to undefined. + */ + /** + * @cfg {String} valign (Optional) Set the CSS vertical-align property of the column (eg. middle, top, bottom etc). Defaults to undefined. + */ + /** + * @cfg {String} cursor (Optional) + */ + /** + * @cfg {String} tooltip (Optional) + */ + /** + * @cfg {Number} xs (Optional) + */ + /** + * @cfg {Number} sm (Optional) + */ + /** + * @cfg {Number} md (Optional) + */ + /** + * @cfg {Number} lg (Optional) + */ + /** + * Returns the id of the column at the specified index. + * @param {Number} index The column index + * @return {String} the id + */ + getColumnId : function(index){ + return this.config[index].id; + }, + + /** + * Returns the column for a specified id. + * @param {String} id The column id + * @return {Object} the column + */ + getColumnById : function(id){ + return this.lookup[id]; + }, + + + /** + * Returns the column for a specified dataIndex. + * @param {String} dataIndex The column dataIndex + * @return {Object|Boolean} the column or false if not found + */ + getColumnByDataIndex: function(dataIndex){ + var index = this.findColumnIndex(dataIndex); + return index > -1 ? this.config[index] : false; + }, + + /** + * Returns the index for a specified column id. + * @param {String} id The column id + * @return {Number} the index, or -1 if not found + */ + getIndexById : function(id){ + for(var i = 0, len = this.config.length; i < len; i++){ + if(this.config[i].id == id){ + return i; + } + } + return -1; + }, + + /** + * Returns the index for a specified column dataIndex. + * @param {String} dataIndex The column dataIndex + * @return {Number} the index, or -1 if not found + */ + + findColumnIndex : function(dataIndex){ + for(var i = 0, len = this.config.length; i < len; i++){ + if(this.config[i].dataIndex == dataIndex){ + return i; + } + } + return -1; + }, + + + moveColumn : function(oldIndex, newIndex){ + var c = this.config[oldIndex]; + this.config.splice(oldIndex, 1); + this.config.splice(newIndex, 0, c); + this.dataMap = null; + this.fireEvent("columnmoved", this, oldIndex, newIndex); + }, + + isLocked : function(colIndex){ + return this.config[colIndex].locked === true; + }, + + setLocked : function(colIndex, value, suppressEvent){ + if(this.isLocked(colIndex) == value){ + return; + } + this.config[colIndex].locked = value; + if(!suppressEvent){ + this.fireEvent("columnlockchange", this, colIndex, value); + } + }, + + getTotalLockedWidth : function(){ + var totalWidth = 0; + for(var i = 0; i < this.config.length; i++){ + if(this.isLocked(i) && !this.isHidden(i)){ + this.totalWidth += this.getColumnWidth(i); + } + } + return totalWidth; + }, + + getLockedCount : function(){ + for(var i = 0, len = this.config.length; i < len; i++){ + if(!this.isLocked(i)){ + return i; + } + } + + return this.config.length; + }, + + /** + * Returns the number of columns. + * @return {Number} + */ + getColumnCount : function(visibleOnly){ + if(visibleOnly === true){ + var c = 0; + for(var i = 0, len = this.config.length; i < len; i++){ + if(!this.isHidden(i)){ + c++; + } + } + return c; + } + return this.config.length; + }, + + /** + * Returns the column configs that return true by the passed function that is called with (columnConfig, index) + * @param {Function} fn + * @param {Object} scope (optional) + * @return {Array} result + */ + getColumnsBy : function(fn, scope){ + var r = []; + for(var i = 0, len = this.config.length; i < len; i++){ + var c = this.config[i]; + if(fn.call(scope||this, c, i) === true){ + r[r.length] = c; + } + } + return r; + }, + + /** + * Returns true if the specified column is sortable. + * @param {Number} col The column index + * @return {Boolean} + */ + isSortable : function(col){ + if(typeof this.config[col].sortable == "undefined"){ + return this.defaultSortable; + } + return this.config[col].sortable; + }, + + /** + * Returns the rendering (formatting) function defined for the column. + * @param {Number} col The column index. + * @return {Function} The function used to render the cell. See {@link #setRenderer}. + */ + getRenderer : function(col){ + if(!this.config[col].renderer){ + return Roo.grid.ColumnModel.defaultRenderer; + } + return this.config[col].renderer; + }, + + /** + * Sets the rendering (formatting) function for a column. + * @param {Number} col The column index + * @param {Function} fn The function to use to process the cell's raw data + * to return HTML markup for the grid view. The render function is called with + * the following parameters:<ul> + * <li>Data value.</li> + * <li>Cell metadata. An object in which you may set the following attributes:<ul> + * <li>css A CSS style string to apply to the table cell.</li> + * <li>attr An HTML attribute definition string to apply to the data container element <i>within</i> the table cell.</li></ul> + * <li>The {@link Roo.data.Record} from which the data was extracted.</li> + * <li>Row index</li> + * <li>Column index</li> + * <li>The {@link Roo.data.Store} object from which the Record was extracted</li></ul> + */ + setRenderer : function(col, fn){ + this.config[col].renderer = fn; + }, + + /** + * Returns the width for the specified column. + * @param {Number} col The column index + * @return {Number} + */ + getColumnWidth : function(col){ + return this.config[col].width * 1 || this.defaultWidth; + }, + + /** + * Sets the width for a column. + * @param {Number} col The column index + * @param {Number} width The new width + */ + setColumnWidth : function(col, width, suppressEvent){ + this.config[col].width = width; + this.totalWidth = null; + if(!suppressEvent){ + this.fireEvent("widthchange", this, col, width); + } + }, + + /** + * Returns the total width of all columns. + * @param {Boolean} includeHidden True to include hidden column widths + * @return {Number} + */ + getTotalWidth : function(includeHidden){ + if(!this.totalWidth){ + this.totalWidth = 0; + for(var i = 0, len = this.config.length; i < len; i++){ + if(includeHidden || !this.isHidden(i)){ + this.totalWidth += this.getColumnWidth(i); + } + } + } + return this.totalWidth; + }, + + /** + * Returns the header for the specified column. + * @param {Number} col The column index + * @return {String} + */ + getColumnHeader : function(col){ + return this.config[col].header; + }, + + /** + * Sets the header for a column. + * @param {Number} col The column index + * @param {String} header The new header + */ + setColumnHeader : function(col, header){ + this.config[col].header = header; + this.fireEvent("headerchange", this, col, header); + }, + + /** + * Returns the tooltip for the specified column. + * @param {Number} col The column index + * @return {String} + */ + getColumnTooltip : function(col){ + return this.config[col].tooltip; + }, + /** + * Sets the tooltip for a column. + * @param {Number} col The column index + * @param {String} tooltip The new tooltip + */ + setColumnTooltip : function(col, tooltip){ + this.config[col].tooltip = tooltip; + }, + + /** + * Returns the dataIndex for the specified column. + * @param {Number} col The column index + * @return {Number} + */ + getDataIndex : function(col){ + return this.config[col].dataIndex; + }, + + /** + * Sets the dataIndex for a column. + * @param {Number} col The column index + * @param {Number} dataIndex The new dataIndex + */ + setDataIndex : function(col, dataIndex){ + this.config[col].dataIndex = dataIndex; + }, + + + + /** + * Returns true if the cell is editable. + * @param {Number} colIndex The column index + * @param {Number} rowIndex The row index - this is nto actually used..? + * @return {Boolean} + */ + isCellEditable : function(colIndex, rowIndex){ + return (this.config[colIndex].editable || (typeof this.config[colIndex].editable == "undefined" && this.config[colIndex].editor)) ? true : false; + }, + + /** + * Returns the editor defined for the cell/column. + * return false or null to disable editing. + * @param {Number} colIndex The column index + * @param {Number} rowIndex The row index + * @return {Object} + */ + getCellEditor : function(colIndex, rowIndex){ + return this.config[colIndex].editor; + }, + + /** + * Sets if a column is editable. + * @param {Number} col The column index + * @param {Boolean} editable True if the column is editable + */ + setEditable : function(col, editable){ + this.config[col].editable = editable; + }, + + + /** + * Returns true if the column is hidden. + * @param {Number} colIndex The column index + * @return {Boolean} + */ + isHidden : function(colIndex){ + return this.config[colIndex].hidden; + }, + + + /** + * Returns true if the column width cannot be changed + */ + isFixed : function(colIndex){ + return this.config[colIndex].fixed; + }, + + /** + * Returns true if the column can be resized + * @return {Boolean} + */ + isResizable : function(colIndex){ + return colIndex >= 0 && this.config[colIndex].resizable !== false && this.config[colIndex].fixed !== true; + }, + /** + * Sets if a column is hidden. + * @param {Number} colIndex The column index + * @param {Boolean} hidden True if the column is hidden + */ + setHidden : function(colIndex, hidden){ + this.config[colIndex].hidden = hidden; + this.totalWidth = null; + this.fireEvent("hiddenchange", this, colIndex, hidden); + }, + + /** + * Sets the editor for a column. + * @param {Number} col The column index + * @param {Object} editor The editor object + */ + setEditor : function(col, editor){ + this.config[col].editor = editor; + } +}); + +Roo.grid.ColumnModel.defaultRenderer = function(value) +{ + if(typeof value == "object") { + return value; + } + if(typeof value == "string" && value.length < 1){ + return "&#160;"; + } + + return String.format("{0}", value); +}; + +// Alias for backwards compatibility +Roo.grid.DefaultColumnModel = Roo.grid.ColumnModel; + \ No newline at end of file diff --git a/docs2/src/Roo_grid_EditorGrid.js.html b/docs2/src/Roo_grid_EditorGrid.js.html new file mode 100644 index 0000000000..fcbe78770f --- /dev/null +++ b/docs2/src/Roo_grid_EditorGrid.js.html @@ -0,0 +1,217 @@ +/home/alan/gitlive/roojs1/Roo/grid/EditorGrid.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.grid.EditorGrid + * @extends Roo.grid.Grid + * Class for creating and editable grid. + * @param {String/HTMLElement/Roo.Element} container The element into which this grid will be rendered - + * The container MUST have some type of size defined for the grid to fill. The container will be + * automatically set to position relative if it isn't already. + * @param {Object} dataSource The data model to bind to + * @param {Object} colModel The column model with info about this grid's columns + */ +Roo.grid.EditorGrid = function(container, config){ + Roo.grid.EditorGrid.superclass.constructor.call(this, container, config); + this.getGridEl().addClass("xedit-grid"); + + if(!this.selModel){ + this.selModel = new Roo.grid.CellSelectionModel(); + } + + this.activeEditor = null; + + this.addEvents({ + /** + * @event beforeedit + * Fires before cell editing is triggered. The edit event object has the following properties <br /> + * <ul style="padding:5px;padding-left:16px;"> + * <li>grid - This grid</li> + * <li>record - The record being edited</li> + * <li>field - The field name being edited</li> + * <li>value - The value for the field being edited.</li> + * <li>row - The grid row index</li> + * <li>column - The grid column index</li> + * <li>cancel - Set this to true to cancel the edit or return false from your handler.</li> + * </ul> + * @param {Object} e An edit event (see above for description) + */ + "beforeedit" : true, + /** + * @event afteredit + * Fires after a cell is edited. <br /> + * <ul style="padding:5px;padding-left:16px;"> + * <li>grid - This grid</li> + * <li>record - The record being edited</li> + * <li>field - The field name being edited</li> + * <li>value - The value being set</li> + * <li>originalValue - The original value for the field, before the edit.</li> + * <li>row - The grid row index</li> + * <li>column - The grid column index</li> + * </ul> + * @param {Object} e An edit event (see above for description) + */ + "afteredit" : true, + /** + * @event validateedit + * Fires after a cell is edited, but before the value is set in the record. + * You can use this to modify the value being set in the field, Return false + * to cancel the change. The edit event object has the following properties <br /> + * <ul style="padding:5px;padding-left:16px;"> + * <li>editor - This editor</li> + * <li>grid - This grid</li> + * <li>record - The record being edited</li> + * <li>field - The field name being edited</li> + * <li>value - The value being set</li> + * <li>originalValue - The original value for the field, before the edit.</li> + * <li>row - The grid row index</li> + * <li>column - The grid column index</li> + * <li>cancel - Set this to true to cancel the edit or return false from your handler.</li> + * </ul> + * @param {Object} e An edit event (see above for description) + */ + "validateedit" : true + }); + this.on("bodyscroll", this.stopEditing, this); + this.on(this.clicksToEdit == 1 ? "cellclick" : "celldblclick", this.onCellDblClick, this); +}; + +Roo.extend(Roo.grid.EditorGrid, Roo.grid.Grid, { + /** + * @cfg {Number} clicksToEdit + * The number of clicks on a cell required to display the cell's editor (defaults to 2) + */ + clicksToEdit: 2, + + // private + isEditor : true, + // private + trackMouseOver: false, // causes very odd FF errors + + onCellDblClick : function(g, row, col){ + this.startEditing(row, col); + }, + + onEditComplete : function(ed, value, startValue){ + this.editing = false; + this.activeEditor = null; + ed.un("specialkey", this.selModel.onEditorKey, this.selModel); + var r = ed.record; + var field = this.colModel.getDataIndex(ed.col); + var e = { + grid: this, + record: r, + field: field, + originalValue: startValue, + value: value, + row: ed.row, + column: ed.col, + cancel:false, + editor: ed + }; + var cell = Roo.get(this.view.getCell(ed.row,ed.col)); + cell.show(); + + if(String(value) !== String(startValue)){ + + if(this.fireEvent("validateedit", e) !== false && !e.cancel){ + r.set(field, e.value); + // if we are dealing with a combo box.. + // then we also set the 'name' colum to be the displayField + if (ed.field.displayField && ed.field.name) { + r.set(ed.field.name, ed.field.el.dom.value); + } + + delete e.cancel; //?? why!!! + this.fireEvent("afteredit", e); + } + } else { + this.fireEvent("afteredit", e); // always fire it! + } + this.view.focusCell(ed.row, ed.col); + }, + + /** + * Starts editing the specified for the specified row/column + * @param {Number} rowIndex + * @param {Number} colIndex + */ + startEditing : function(row, col){ + this.stopEditing(); + if(this.colModel.isCellEditable(col, row)){ + this.view.ensureVisible(row, col, true); + + var r = this.dataSource.getAt(row); + var field = this.colModel.getDataIndex(col); + var cell = Roo.get(this.view.getCell(row,col)); + var e = { + grid: this, + record: r, + field: field, + value: r.data[field], + row: row, + column: col, + cancel:false + }; + if(this.fireEvent("beforeedit", e) !== false && !e.cancel){ + this.editing = true; + var ed = this.colModel.getCellEditor(col, row); + + if (!ed) { + return; + } + if(!ed.rendered){ + ed.render(ed.parentEl || document.body); + } + ed.field.reset(); + + cell.hide(); + + (function(){ // complex but required for focus issues in safari, ie and opera + ed.row = row; + ed.col = col; + ed.record = r; + ed.on("complete", this.onEditComplete, this, {single: true}); + ed.on("specialkey", this.selModel.onEditorKey, this.selModel); + this.activeEditor = ed; + var v = r.data[field]; + ed.startEdit(this.view.getCell(row, col), v); + // combo's with 'displayField and name set + if (ed.field.displayField && ed.field.name) { + ed.field.el.dom.value = r.data[ed.field.name]; + } + + + }).defer(50, this); + } + } + }, + + /** + * Stops any active editing + */ + stopEditing : function(){ + if(this.activeEditor){ + this.activeEditor.completeEdit(); + } + this.activeEditor = null; + }, + + /** + * Called to get grid's drag proxy text, by default returns this.ddText. + * @return {String} + */ + getDragDropText : function(){ + var count = this.selModel.getSelectedCell() ? 1 : 0; + return String.format(this.ddText, count, count == 1 ? '' : 's'); + } + +}); \ No newline at end of file diff --git a/docs2/src/Roo_grid_Grid.js.html b/docs2/src/Roo_grid_Grid.js.html new file mode 100644 index 0000000000..67159f3193 --- /dev/null +++ b/docs2/src/Roo_grid_Grid.js.html @@ -0,0 +1,726 @@ +/home/alan/gitlive/roojs1/Roo/grid/Grid.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.grid.Grid + * @extends Roo.util.Observable + * This class represents the primary interface of a component based grid control. + * <br><br>Usage:<pre><code> + var grid = new Roo.grid.Grid("my-container-id", { + ds: myDataStore, + cm: myColModel, + selModel: mySelectionModel, + autoSizeColumns: true, + monitorWindowResize: false, + trackMouseOver: true + }); + // set any options + grid.render(); + * </code></pre> + * <b>Common Problems:</b><br/> + * - Grid does not resize properly when going smaller: Setting overflow hidden on the container + * element will correct this<br/> + * - If you get el.style[camel]= NaNpx or -2px or something related, be certain you have given your container element + * dimensions. The grid adapts to your container's size, if your container has no size defined then the results + * are unpredictable.<br/> + * - Do not render the grid into an element with display:none. Try using visibility:hidden. Otherwise there is no way for the + * grid to calculate dimensions/offsets.<br/> + * @constructor + * @param {String/HTMLElement/Roo.Element} container The element into which this grid will be rendered - + * The container MUST have some type of size defined for the grid to fill. The container will be + * automatically set to position relative if it isn't already. + * @param {Object} config A config object that sets properties on this grid. + */ +Roo.grid.Grid = function(container, config){ + // initialize the container + this.container = Roo.get(container); + this.container.update(""); + this.container.setStyle("overflow", "hidden"); + this.container.addClass('x-grid-container'); + + this.id = this.container.id; + + Roo.apply(this, config); + // check and correct shorthanded configs + if(this.ds){ + this.dataSource = this.ds; + delete this.ds; + } + if(this.cm){ + this.colModel = this.cm; + delete this.cm; + } + if(this.sm){ + this.selModel = this.sm; + delete this.sm; + } + + if (this.selModel) { + this.selModel = Roo.factory(this.selModel, Roo.grid); + this.sm = this.selModel; + this.sm.xmodule = this.xmodule || false; + } + if (typeof(this.colModel.config) == 'undefined') { + this.colModel = new Roo.grid.ColumnModel(this.colModel); + this.cm = this.colModel; + this.cm.xmodule = this.xmodule || false; + } + if (this.dataSource) { + this.dataSource= Roo.factory(this.dataSource, Roo.data); + this.ds = this.dataSource; + this.ds.xmodule = this.xmodule || false; + + } + + + + if(this.width){ + this.container.setWidth(this.width); + } + + if(this.height){ + this.container.setHeight(this.height); + } + /** @private */ + this.addEvents({ + // raw events + /** + * @event click + * The raw click event for the entire grid. + * @param {Roo.EventObject} e + */ + "click" : true, + /** + * @event dblclick + * The raw dblclick event for the entire grid. + * @param {Roo.EventObject} e + */ + "dblclick" : true, + /** + * @event contextmenu + * The raw contextmenu event for the entire grid. + * @param {Roo.EventObject} e + */ + "contextmenu" : true, + /** + * @event mousedown + * The raw mousedown event for the entire grid. + * @param {Roo.EventObject} e + */ + "mousedown" : true, + /** + * @event mouseup + * The raw mouseup event for the entire grid. + * @param {Roo.EventObject} e + */ + "mouseup" : true, + /** + * @event mouseover + * The raw mouseover event for the entire grid. + * @param {Roo.EventObject} e + */ + "mouseover" : true, + /** + * @event mouseout + * The raw mouseout event for the entire grid. + * @param {Roo.EventObject} e + */ + "mouseout" : true, + /** + * @event keypress + * The raw keypress event for the entire grid. + * @param {Roo.EventObject} e + */ + "keypress" : true, + /** + * @event keydown + * The raw keydown event for the entire grid. + * @param {Roo.EventObject} e + */ + "keydown" : true, + + // custom events + + /** + * @event cellclick + * Fires when a cell is clicked + * @param {Grid} this + * @param {Number} rowIndex + * @param {Number} columnIndex + * @param {Roo.EventObject} e + */ + "cellclick" : true, + /** + * @event celldblclick + * Fires when a cell is double clicked + * @param {Grid} this + * @param {Number} rowIndex + * @param {Number} columnIndex + * @param {Roo.EventObject} e + */ + "celldblclick" : true, + /** + * @event rowclick + * Fires when a row is clicked + * @param {Grid} this + * @param {Number} rowIndex + * @param {Roo.EventObject} e + */ + "rowclick" : true, + /** + * @event rowdblclick + * Fires when a row is double clicked + * @param {Grid} this + * @param {Number} rowIndex + * @param {Roo.EventObject} e + */ + "rowdblclick" : true, + /** + * @event headerclick + * Fires when a header is clicked + * @param {Grid} this + * @param {Number} columnIndex + * @param {Roo.EventObject} e + */ + "headerclick" : true, + /** + * @event headerdblclick + * Fires when a header cell is double clicked + * @param {Grid} this + * @param {Number} columnIndex + * @param {Roo.EventObject} e + */ + "headerdblclick" : true, + /** + * @event rowcontextmenu + * Fires when a row is right clicked + * @param {Grid} this + * @param {Number} rowIndex + * @param {Roo.EventObject} e + */ + "rowcontextmenu" : true, + /** + * @event cellcontextmenu + * Fires when a cell is right clicked + * @param {Grid} this + * @param {Number} rowIndex + * @param {Number} cellIndex + * @param {Roo.EventObject} e + */ + "cellcontextmenu" : true, + /** + * @event headercontextmenu + * Fires when a header is right clicked + * @param {Grid} this + * @param {Number} columnIndex + * @param {Roo.EventObject} e + */ + "headercontextmenu" : true, + /** + * @event bodyscroll + * Fires when the body element is scrolled + * @param {Number} scrollLeft + * @param {Number} scrollTop + */ + "bodyscroll" : true, + /** + * @event columnresize + * Fires when the user resizes a column + * @param {Number} columnIndex + * @param {Number} newSize + */ + "columnresize" : true, + /** + * @event columnmove + * Fires when the user moves a column + * @param {Number} oldIndex + * @param {Number} newIndex + */ + "columnmove" : true, + /** + * @event startdrag + * Fires when row(s) start being dragged + * @param {Grid} this + * @param {Roo.GridDD} dd The drag drop object + * @param {event} e The raw browser event + */ + "startdrag" : true, + /** + * @event enddrag + * Fires when a drag operation is complete + * @param {Grid} this + * @param {Roo.GridDD} dd The drag drop object + * @param {event} e The raw browser event + */ + "enddrag" : true, + /** + * @event dragdrop + * Fires when dragged row(s) are dropped on a valid DD target + * @param {Grid} this + * @param {Roo.GridDD} dd The drag drop object + * @param {String} targetId The target drag drop object + * @param {event} e The raw browser event + */ + "dragdrop" : true, + /** + * @event dragover + * Fires while row(s) are being dragged. "targetId" is the id of the Yahoo.util.DD object the selected rows are being dragged over. + * @param {Grid} this + * @param {Roo.GridDD} dd The drag drop object + * @param {String} targetId The target drag drop object + * @param {event} e The raw browser event + */ + "dragover" : true, + /** + * @event dragenter + * Fires when the dragged row(s) first cross another DD target while being dragged + * @param {Grid} this + * @param {Roo.GridDD} dd The drag drop object + * @param {String} targetId The target drag drop object + * @param {event} e The raw browser event + */ + "dragenter" : true, + /** + * @event dragout + * Fires when the dragged row(s) leave another DD target while being dragged + * @param {Grid} this + * @param {Roo.GridDD} dd The drag drop object + * @param {String} targetId The target drag drop object + * @param {event} e The raw browser event + */ + "dragout" : true, + /** + * @event rowclass + * Fires when a row is rendered, so you can change add a style to it. + * @param {GridView} gridview The grid view + * @param {Object} rowcfg contains record rowIndex and rowClass - set rowClass to add a style. + */ + 'rowclass' : true, + + /** + * @event render + * Fires when the grid is rendered + * @param {Grid} grid + */ + 'render' : true + }); + + Roo.grid.Grid.superclass.constructor.call(this); +}; +Roo.extend(Roo.grid.Grid, Roo.util.Observable, { + + /** + * @cfg {String} ddGroup - drag drop group. + */ + + /** + * @cfg {Number} minColumnWidth The minimum width a column can be resized to. Default is 25. + */ + minColumnWidth : 25, + + /** + * @cfg {Boolean} autoSizeColumns True to automatically resize the columns to fit their content + * <b>on initial render.</b> It is more efficient to explicitly size the columns + * through the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false. + */ + autoSizeColumns : false, + + /** + * @cfg {Boolean} autoSizeHeaders True to measure headers with column data when auto sizing columns. Default is true. + */ + autoSizeHeaders : true, + + /** + * @cfg {Boolean} monitorWindowResize True to autoSize the grid when the window resizes. Default is true. + */ + monitorWindowResize : true, + + /** + * @cfg {Boolean} maxRowsToMeasure If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of + * rows measured to get a columns size. Default is 0 (all rows). + */ + maxRowsToMeasure : 0, + + /** + * @cfg {Boolean} trackMouseOver True to highlight rows when the mouse is over. Default is true. + */ + trackMouseOver : true, + + /** + * @cfg {Boolean} enableDrag True to enable drag of rows. Default is false. (double check if this is needed?) + */ + + /** + * @cfg {Boolean} enableDragDrop True to enable drag and drop of rows. Default is false. + */ + enableDragDrop : false, + + /** + * @cfg {Boolean} enableColumnMove True to enable drag and drop reorder of columns. Default is true. + */ + enableColumnMove : true, + + /** + * @cfg {Boolean} enableColumnHide True to enable hiding of columns with the header context menu. Default is true. + */ + enableColumnHide : true, + + /** + * @cfg {Boolean} enableRowHeightSync True to manually sync row heights across locked and not locked rows. Default is false. + */ + enableRowHeightSync : false, + + /** + * @cfg {Boolean} stripeRows True to stripe the rows. Default is true. + */ + stripeRows : true, + + /** + * @cfg {Boolean} autoHeight True to fit the height of the grid container to the height of the data. Default is false. + */ + autoHeight : false, + + /** + * @cfg {String} autoExpandColumn The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false. + */ + autoExpandColumn : false, + + /** + * @cfg {Number} autoExpandMin The minimum width the autoExpandColumn can have (if enabled). + * Default is 50. + */ + autoExpandMin : 50, + + /** + * @cfg {Number} autoExpandMax The maximum width the autoExpandColumn can have (if enabled). Default is 1000. + */ + autoExpandMax : 1000, + + /** + * @cfg {Object} view The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render(). + */ + view : null, + + /** + * @cfg {Object} loadMask An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false. + */ + loadMask : false, + /** + * @cfg {Roo.dd.DropTarget} dropTarget An {@link Roo.dd.DropTarget} config + */ + dropTarget: false, + + + + // private + rendered : false, + + /** + * @cfg {Boolean} autoWidth True to set the grid's width to the default total width of the grid's columns instead + * of a fixed width. Default is false. + */ + /** + * @cfg {Number} maxHeight Sets the maximum height of the grid - ignored if autoHeight is not on. + */ + /** + * Called once after all setup has been completed and the grid is ready to be rendered. + * @return {Roo.grid.Grid} this + */ + render : function() + { + var c = this.container; + // try to detect autoHeight/width mode + if((!c.dom.offsetHeight || c.dom.offsetHeight < 20) || c.getStyle("height") == "auto"){ + this.autoHeight = true; + } + var view = this.getView(); + view.init(this); + + c.on("click", this.onClick, this); + c.on("dblclick", this.onDblClick, this); + c.on("contextmenu", this.onContextMenu, this); + c.on("keydown", this.onKeyDown, this); + if (Roo.isTouch) { + c.on("touchstart", this.onTouchStart, this); + } + + this.relayEvents(c, ["mousedown","mouseup","mouseover","mouseout","keypress"]); + + this.getSelectionModel().init(this); + + view.render(); + + if(this.loadMask){ + this.loadMask = new Roo.LoadMask(this.container, + Roo.apply({store:this.dataSource}, this.loadMask)); + } + + + if (this.toolbar && this.toolbar.xtype) { + this.toolbar.container = this.getView().getHeaderPanel(true); + this.toolbar = new Roo.Toolbar(this.toolbar); + } + if (this.footer && this.footer.xtype) { + this.footer.dataSource = this.getDataSource(); + this.footer.container = this.getView().getFooterPanel(true); + this.footer = Roo.factory(this.footer, Roo); + } + if (this.dropTarget && this.dropTarget.xtype) { + delete this.dropTarget.xtype; + this.dropTarget = new Roo.dd.DropTarget(this.getView().mainBody, this.dropTarget); + } + + + this.rendered = true; + this.fireEvent('render', this); + return this; + }, + + /** + * Reconfigures the grid to use a different Store and Column Model. + * The View will be bound to the new objects and refreshed. + * @param {Roo.data.Store} dataSource The new {@link Roo.data.Store} object + * @param {Roo.grid.ColumnModel} The new {@link Roo.grid.ColumnModel} object + */ + reconfigure : function(dataSource, colModel){ + if(this.loadMask){ + this.loadMask.destroy(); + this.loadMask = new Roo.LoadMask(this.container, + Roo.apply({store:dataSource}, this.loadMask)); + } + this.view.bind(dataSource, colModel); + this.dataSource = dataSource; + this.colModel = colModel; + this.view.refresh(true); + }, + + // private + onKeyDown : function(e){ + this.fireEvent("keydown", e); + }, + + /** + * Destroy this grid. + * @param {Boolean} removeEl True to remove the element + */ + destroy : function(removeEl, keepListeners){ + if(this.loadMask){ + this.loadMask.destroy(); + } + var c = this.container; + c.removeAllListeners(); + this.view.destroy(); + this.colModel.purgeListeners(); + if(!keepListeners){ + this.purgeListeners(); + } + c.update(""); + if(removeEl === true){ + c.remove(); + } + }, + + // private + processEvent : function(name, e){ + // does this fire select??? + //Roo.log('grid:processEvent ' + name); + + if (name != 'touchstart' ) { + this.fireEvent(name, e); + } + + var t = e.getTarget(); + var v = this.view; + var header = v.findHeaderIndex(t); + if(header !== false){ + var ename = name == 'touchstart' ? 'click' : name; + + this.fireEvent("header" + ename, this, header, e); + }else{ + var row = v.findRowIndex(t); + var cell = v.findCellIndex(t); + if (name == 'touchstart') { + // first touch is always a click. + // hopefull this happens after selection is updated.? + name = false; + + if (typeof(this.selModel.getSelectedCell) != 'undefined') { + var cs = this.selModel.getSelectedCell(); + if (row == cs[0] && cell == cs[1]){ + name = 'dblclick'; + } + } + if (typeof(this.selModel.getSelections) != 'undefined') { + var cs = this.selModel.getSelections(); + var ds = this.dataSource; + if (cs.length == 1 && ds.getAt(row) == cs[0]){ + name = 'dblclick'; + } + } + if (!name) { + return; + } + } + + + if(row !== false){ + this.fireEvent("row" + name, this, row, e); + if(cell !== false){ + this.fireEvent("cell" + name, this, row, cell, e); + } + } + } + }, + + // private + onClick : function(e){ + this.processEvent("click", e); + }, + // private + onTouchStart : function(e){ + this.processEvent("touchstart", e); + }, + + // private + onContextMenu : function(e, t){ + this.processEvent("contextmenu", e); + }, + + // private + onDblClick : function(e){ + this.processEvent("dblclick", e); + }, + + // private + walkCells : function(row, col, step, fn, scope){ + var cm = this.colModel, clen = cm.getColumnCount(); + var ds = this.dataSource, rlen = ds.getCount(), first = true; + if(step < 0){ + if(col < 0){ + row--; + first = false; + } + while(row >= 0){ + if(!first){ + col = clen-1; + } + first = false; + while(col >= 0){ + if(fn.call(scope || this, row, col, cm) === true){ + return [row, col]; + } + col--; + } + row--; + } + } else { + if(col >= clen){ + row++; + first = false; + } + while(row < rlen){ + if(!first){ + col = 0; + } + first = false; + while(col < clen){ + if(fn.call(scope || this, row, col, cm) === true){ + return [row, col]; + } + col++; + } + row++; + } + } + return null; + }, + + // private + getSelections : function(){ + return this.selModel.getSelections(); + }, + + /** + * Causes the grid to manually recalculate its dimensions. Generally this is done automatically, + * but if manual update is required this method will initiate it. + */ + autoSize : function(){ + if(this.rendered){ + this.view.layout(); + if(this.view.adjustForScroll){ + this.view.adjustForScroll(); + } + } + }, + + /** + * Returns the grid's underlying element. + * @return {Element} The element + */ + getGridEl : function(){ + return this.container; + }, + + // private for compatibility, overridden by editor grid + stopEditing : function(){}, + + /** + * Returns the grid's SelectionModel. + * @return {SelectionModel} + */ + getSelectionModel : function(){ + if(!this.selModel){ + this.selModel = new Roo.grid.RowSelectionModel(); + } + return this.selModel; + }, + + /** + * Returns the grid's DataSource. + * @return {DataSource} + */ + getDataSource : function(){ + return this.dataSource; + }, + + /** + * Returns the grid's ColumnModel. + * @return {ColumnModel} + */ + getColumnModel : function(){ + return this.colModel; + }, + + /** + * Returns the grid's GridView object. + * @return {GridView} + */ + getView : function(){ + if(!this.view){ + this.view = new Roo.grid.GridView(this.viewConfig); + } + return this.view; + }, + /** + * Called to get grid's drag proxy text, by default returns this.ddText. + * @return {String} + */ + getDragDropText : function(){ + var count = this.selModel.getCount(); + return String.format(this.ddText, count, count == 1 ? '' : 's'); + } +}); +/** + * Configures the text is the drag proxy (defaults to "%0 selected row(s)"). + * %0 is replaced with the number of selected rows. + * @type String + */ +Roo.grid.Grid.prototype.ddText = "{0} selected row{1}"; \ No newline at end of file diff --git a/docs2/src/Roo_grid_GridDragZone.js.html b/docs2/src/Roo_grid_GridDragZone.js.html new file mode 100644 index 0000000000..d76436d1f2 --- /dev/null +++ b/docs2/src/Roo_grid_GridDragZone.js.html @@ -0,0 +1,103 @@ +/home/alan/gitlive/roojs1/Roo/grid/GridDragZone.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +// private +// This is a support class used internally by the Grid components +Roo.grid.GridDragZone = function(grid, config){ + this.view = grid.getView(); + Roo.grid.GridDragZone.superclass.constructor.call(this, this.view.mainBody.dom, config); + if(this.view.lockedBody){ + this.setHandleElId(Roo.id(this.view.mainBody.dom)); + this.setOuterHandleElId(Roo.id(this.view.lockedBody.dom)); + } + this.scroll = false; + this.grid = grid; + this.ddel = document.createElement('div'); + this.ddel.className = 'x-grid-dd-wrap'; +}; + +Roo.extend(Roo.grid.GridDragZone, Roo.dd.DragZone, { + ddGroup : "GridDD", + + getDragData : function(e){ + var t = Roo.lib.Event.getTarget(e); + var rowIndex = this.view.findRowIndex(t); + var sm = this.grid.selModel; + + //Roo.log(rowIndex); + + if (sm.getSelectedCell) { + // cell selection.. + if (!sm.getSelectedCell()) { + return false; + } + if (rowIndex != sm.getSelectedCell()[0]) { + return false; + } + + } + + if(rowIndex !== false){ + + // if editorgrid.. + + + //Roo.log([ sm.getSelectedCell() ? sm.getSelectedCell()[0] : 'NO' , rowIndex ]); + + //if(!sm.isSelected(rowIndex) || e.hasModifier()){ + // + //} + if (e.hasModifier()){ + sm.handleMouseDown(e, t); // non modifier buttons are handled by row select. + } + + Roo.log("getDragData"); + + return { + grid: this.grid, + ddel: this.ddel, + rowIndex: rowIndex, + selections:sm.getSelections ? sm.getSelections() : ( + sm.getSelectedCell() ? [ this.grid.ds.getAt(sm.getSelectedCell()[0]) ] : [] + ) + }; + } + return false; + }, + + onInitDrag : function(e){ + var data = this.dragData; + this.ddel.innerHTML = this.grid.getDragDropText(); + this.proxy.update(this.ddel); + // fire start drag? + }, + + afterRepair : function(){ + this.dragging = false; + }, + + getRepairXY : function(e, data){ + return false; + }, + + onEndDrag : function(data, e){ + // fire end drag? + }, + + onValidDrop : function(dd, e, id){ + // fire drag drop? + this.hideProxy(); + }, + + beforeInvalidDrop : function(e, id){ + + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_grid_GridEditor.js.html b/docs2/src/Roo_grid_GridEditor.js.html new file mode 100644 index 0000000000..e360b585e3 --- /dev/null +++ b/docs2/src/Roo_grid_GridEditor.js.html @@ -0,0 +1,42 @@ +/home/alan/gitlive/roojs1/Roo/grid/GridEditor.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +// private - not really -- you end up using it ! +// This is a support class used internally by the Grid components + +/** + * @class Roo.grid.GridEditor + * @extends Roo.Editor + * Class for creating and editable grid elements. + * @param {Object} config any settings (must include field) + */ +Roo.grid.GridEditor = function(field, config){ + if (!config && field.field) { + config = field; + field = Roo.factory(config.field, Roo.form); + } + Roo.grid.GridEditor.superclass.constructor.call(this, field, config); + field.monitorTab = false; +}; + +Roo.extend(Roo.grid.GridEditor, Roo.Editor, { + + /** + * @cfg {Roo.form.Field} field Field to wrap (or xtyped) + */ + + alignment: "tl-tl", + autoSize: "width", + hideEl : false, + cls: "x-small-editor x-grid-editor", + shim:false, + shadow:"frame" +}); \ No newline at end of file diff --git a/docs2/src/Roo_grid_GridView.js.html b/docs2/src/Roo_grid_GridView.js.html new file mode 100644 index 0000000000..ae4daed395 --- /dev/null +++ b/docs2/src/Roo_grid_GridView.js.html @@ -0,0 +1,1743 @@ +/home/alan/gitlive/roojs1/Roo/grid/GridView.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.grid.GridView + * @extends Roo.util.Observable + * + * @constructor + * @param {Object} config + */ +Roo.grid.GridView = function(config){ + Roo.grid.GridView.superclass.constructor.call(this); + this.el = null; + + Roo.apply(this, config); +}; + +Roo.extend(Roo.grid.GridView, Roo.grid.AbstractGridView, { + + unselectable : 'unselectable="on"', + unselectableCls : 'x-unselectable', + + + rowClass : "x-grid-row", + + cellClass : "x-grid-col", + + tdClass : "x-grid-td", + + hdClass : "x-grid-hd", + + splitClass : "x-grid-split", + + sortClasses : ["sort-asc", "sort-desc"], + + enableMoveAnim : false, + + hlColor: "C3DAF9", + + dh : Roo.DomHelper, + + fly : Roo.Element.fly, + + css : Roo.util.CSS, + + borderWidth: 1, + + splitOffset: 3, + + scrollIncrement : 22, + + cellRE: /(?:.*?)x-grid-(?:hd|cell|csplit)-(?:[\d]+)-([\d]+)(?:.*?)/, + + findRE: /\s?(?:x-grid-hd|x-grid-col|x-grid-csplit)\s/, + + bind : function(ds, cm){ + if(this.ds){ + this.ds.un("load", this.onLoad, this); + this.ds.un("datachanged", this.onDataChange, this); + this.ds.un("add", this.onAdd, this); + this.ds.un("remove", this.onRemove, this); + this.ds.un("update", this.onUpdate, this); + this.ds.un("clear", this.onClear, this); + } + if(ds){ + ds.on("load", this.onLoad, this); + ds.on("datachanged", this.onDataChange, this); + ds.on("add", this.onAdd, this); + ds.on("remove", this.onRemove, this); + ds.on("update", this.onUpdate, this); + ds.on("clear", this.onClear, this); + } + this.ds = ds; + + if(this.cm){ + this.cm.un("widthchange", this.onColWidthChange, this); + this.cm.un("headerchange", this.onHeaderChange, this); + this.cm.un("hiddenchange", this.onHiddenChange, this); + this.cm.un("columnmoved", this.onColumnMove, this); + this.cm.un("columnlockchange", this.onColumnLock, this); + } + if(cm){ + this.generateRules(cm); + cm.on("widthchange", this.onColWidthChange, this); + cm.on("headerchange", this.onHeaderChange, this); + cm.on("hiddenchange", this.onHiddenChange, this); + cm.on("columnmoved", this.onColumnMove, this); + cm.on("columnlockchange", this.onColumnLock, this); + } + this.cm = cm; + }, + + init: function(grid){ + Roo.grid.GridView.superclass.init.call(this, grid); + + this.bind(grid.dataSource, grid.colModel); + + grid.on("headerclick", this.handleHeaderClick, this); + + if(grid.trackMouseOver){ + grid.on("mouseover", this.onRowOver, this); + grid.on("mouseout", this.onRowOut, this); + } + grid.cancelTextSelection = function(){}; + this.gridId = grid.id; + + var tpls = this.templates || {}; + + if(!tpls.master){ + tpls.master = new Roo.Template( + '<div class="x-grid" hidefocus="true">', + '<a href="#" class="x-grid-focus" tabIndex="-1"></a>', + '<div class="x-grid-topbar"></div>', + '<div class="x-grid-scroller"><div></div></div>', + '<div class="x-grid-locked">', + '<div class="x-grid-header">{lockedHeader}</div>', + '<div class="x-grid-body">{lockedBody}</div>', + "</div>", + '<div class="x-grid-viewport">', + '<div class="x-grid-header">{header}</div>', + '<div class="x-grid-body">{body}</div>', + "</div>", + '<div class="x-grid-bottombar"></div>', + + '<div class="x-grid-resize-proxy">&#160;</div>', + "</div>" + ); + tpls.master.disableformats = true; + } + + if(!tpls.header){ + tpls.header = new Roo.Template( + '<table border="0" cellspacing="0" cellpadding="0">', + '<tbody><tr class="x-grid-hd-row">{cells}</tr></tbody>', + "</table>{splits}" + ); + tpls.header.disableformats = true; + } + tpls.header.compile(); + + if(!tpls.hcell){ + tpls.hcell = new Roo.Template( + '<td class="x-grid-hd x-grid-td-{id} {cellId}"><div title="{title}" class="x-grid-hd-inner x-grid-hd-{id}">', + '<div class="x-grid-hd-text ' + this.unselectableCls + '" ' + this.unselectable +'>{value}<img class="x-grid-sort-icon" src="', Roo.BLANK_IMAGE_URL, '" /></div>', + "</div></td>" + ); + tpls.hcell.disableFormats = true; + } + tpls.hcell.compile(); + + if(!tpls.hsplit){ + tpls.hsplit = new Roo.Template('<div class="x-grid-split {splitId} x-grid-split-{id}" style="{style} ' + + this.unselectableCls + '" ' + this.unselectable +'>&#160;</div>'); + tpls.hsplit.disableFormats = true; + } + tpls.hsplit.compile(); + + if(!tpls.body){ + tpls.body = new Roo.Template( + '<table border="0" cellspacing="0" cellpadding="0">', + "<tbody>{rows}</tbody>", + "</table>" + ); + tpls.body.disableFormats = true; + } + tpls.body.compile(); + + if(!tpls.row){ + tpls.row = new Roo.Template('<tr class="x-grid-row {alt}">{cells}</tr>'); + tpls.row.disableFormats = true; + } + tpls.row.compile(); + + if(!tpls.cell){ + tpls.cell = new Roo.Template( + '<td class="x-grid-col x-grid-td-{id} {cellId} {css}" tabIndex="0">', + '<div class="x-grid-col-{id} x-grid-cell-inner"><div class="x-grid-cell-text ' + + this.unselectableCls + '" ' + this.unselectable +'" {attr}>{value}</div></div>', + "</td>" + ); + tpls.cell.disableFormats = true; + } + tpls.cell.compile(); + + this.templates = tpls; + }, + + // remap these for backwards compat + onColWidthChange : function(){ + this.updateColumns.apply(this, arguments); + }, + onHeaderChange : function(){ + this.updateHeaders.apply(this, arguments); + }, + onHiddenChange : function(){ + this.handleHiddenChange.apply(this, arguments); + }, + onColumnMove : function(){ + this.handleColumnMove.apply(this, arguments); + }, + onColumnLock : function(){ + this.handleLockChange.apply(this, arguments); + }, + + onDataChange : function(){ + this.refresh(); + this.updateHeaderSortState(); + }, + + onClear : function(){ + this.refresh(); + }, + + onUpdate : function(ds, record){ + this.refreshRow(record); + }, + + refreshRow : function(record){ + var ds = this.ds, index; + if(typeof record == 'number'){ + index = record; + record = ds.getAt(index); + }else{ + index = ds.indexOf(record); + } + this.insertRows(ds, index, index, true); + this.onRemove(ds, record, index+1, true); + this.syncRowHeights(index, index); + this.layout(); + this.fireEvent("rowupdated", this, index, record); + }, + + onAdd : function(ds, records, index){ + this.insertRows(ds, index, index + (records.length-1)); + }, + + onRemove : function(ds, record, index, isUpdate){ + if(isUpdate !== true){ + this.fireEvent("beforerowremoved", this, index, record); + } + var bt = this.getBodyTable(), lt = this.getLockedTable(); + if(bt.rows[index]){ + bt.firstChild.removeChild(bt.rows[index]); + } + if(lt.rows[index]){ + lt.firstChild.removeChild(lt.rows[index]); + } + if(isUpdate !== true){ + this.stripeRows(index); + this.syncRowHeights(index, index); + this.layout(); + this.fireEvent("rowremoved", this, index, record); + } + }, + + onLoad : function(){ + this.scrollToTop(); + }, + + /** + * Scrolls the grid to the top + */ + scrollToTop : function(){ + if(this.scroller){ + this.scroller.dom.scrollTop = 0; + this.syncScroll(); + } + }, + + /** + * Gets a panel in the header of the grid that can be used for toolbars etc. + * After modifying the contents of this panel a call to grid.autoSize() may be + * required to register any changes in size. + * @param {Boolean} doShow By default the header is hidden. Pass true to show the panel + * @return Roo.Element + */ + getHeaderPanel : function(doShow){ + if(doShow){ + this.headerPanel.show(); + } + return this.headerPanel; + }, + + /** + * Gets a panel in the footer of the grid that can be used for toolbars etc. + * After modifying the contents of this panel a call to grid.autoSize() may be + * required to register any changes in size. + * @param {Boolean} doShow By default the footer is hidden. Pass true to show the panel + * @return Roo.Element + */ + getFooterPanel : function(doShow){ + if(doShow){ + this.footerPanel.show(); + } + return this.footerPanel; + }, + + initElements : function(){ + var E = Roo.Element; + var el = this.grid.getGridEl().dom.firstChild; + var cs = el.childNodes; + + this.el = new E(el); + + this.focusEl = new E(el.firstChild); + this.focusEl.swallowEvent("click", true); + + this.headerPanel = new E(cs[1]); + this.headerPanel.enableDisplayMode("block"); + + this.scroller = new E(cs[2]); + this.scrollSizer = new E(this.scroller.dom.firstChild); + + this.lockedWrap = new E(cs[3]); + this.lockedHd = new E(this.lockedWrap.dom.firstChild); + this.lockedBody = new E(this.lockedWrap.dom.childNodes[1]); + + this.mainWrap = new E(cs[4]); + this.mainHd = new E(this.mainWrap.dom.firstChild); + this.mainBody = new E(this.mainWrap.dom.childNodes[1]); + + this.footerPanel = new E(cs[5]); + this.footerPanel.enableDisplayMode("block"); + + this.resizeProxy = new E(cs[6]); + + this.headerSelector = String.format( + '#{0} td.x-grid-hd, #{1} td.x-grid-hd', + this.lockedHd.id, this.mainHd.id + ); + + this.splitterSelector = String.format( + '#{0} div.x-grid-split, #{1} div.x-grid-split', + this.idToCssName(this.lockedHd.id), this.idToCssName(this.mainHd.id) + ); + }, + idToCssName : function(s) + { + return s.replace(/[^a-z0-9]+/ig, '-'); + }, + + getHeaderCell : function(index){ + return Roo.DomQuery.select(this.headerSelector)[index]; + }, + + getHeaderCellMeasure : function(index){ + return this.getHeaderCell(index).firstChild; + }, + + getHeaderCellText : function(index){ + return this.getHeaderCell(index).firstChild.firstChild; + }, + + getLockedTable : function(){ + return this.lockedBody.dom.firstChild; + }, + + getBodyTable : function(){ + return this.mainBody.dom.firstChild; + }, + + getLockedRow : function(index){ + return this.getLockedTable().rows[index]; + }, + + getRow : function(index){ + return this.getBodyTable().rows[index]; + }, + + getRowComposite : function(index){ + if(!this.rowEl){ + this.rowEl = new Roo.CompositeElementLite(); + } + var els = [], lrow, mrow; + if(lrow = this.getLockedRow(index)){ + els.push(lrow); + } + if(mrow = this.getRow(index)){ + els.push(mrow); + } + this.rowEl.elements = els; + return this.rowEl; + }, + /** + * Gets the 'td' of the cell + * + * @param {Integer} rowIndex row to select + * @param {Integer} colIndex column to select + * + * @return {Object} + */ + getCell : function(rowIndex, colIndex){ + var locked = this.cm.getLockedCount(); + var source; + if(colIndex < locked){ + source = this.lockedBody.dom.firstChild; + }else{ + source = this.mainBody.dom.firstChild; + colIndex -= locked; + } + return source.rows[rowIndex].childNodes[colIndex]; + }, + + getCellText : function(rowIndex, colIndex){ + return this.getCell(rowIndex, colIndex).firstChild.firstChild; + }, + + getCellBox : function(cell){ + var b = this.fly(cell).getBox(); + if(Roo.isOpera){ // opera fails to report the Y + b.y = cell.offsetTop + this.mainBody.getY(); + } + return b; + }, + + getCellIndex : function(cell){ + var id = String(cell.className).match(this.cellRE); + if(id){ + return parseInt(id[1], 10); + } + return 0; + }, + + findHeaderIndex : function(n){ + var r = Roo.fly(n).findParent("td." + this.hdClass, 6); + return r ? this.getCellIndex(r) : false; + }, + + findHeaderCell : function(n){ + var r = Roo.fly(n).findParent("td." + this.hdClass, 6); + return r ? r : false; + }, + + findRowIndex : function(n){ + if(!n){ + return false; + } + var r = Roo.fly(n).findParent("tr." + this.rowClass, 6); + return r ? r.rowIndex : false; + }, + + findCellIndex : function(node){ + var stop = this.el.dom; + while(node && node != stop){ + if(this.findRE.test(node.className)){ + return this.getCellIndex(node); + } + node = node.parentNode; + } + return false; + }, + + getColumnId : function(index){ + return this.cm.getColumnId(index); + }, + + getSplitters : function() + { + if(this.splitterSelector){ + return Roo.DomQuery.select(this.splitterSelector); + }else{ + return null; + } + }, + + getSplitter : function(index){ + return this.getSplitters()[index]; + }, + + onRowOver : function(e, t){ + var row; + if((row = this.findRowIndex(t)) !== false){ + this.getRowComposite(row).addClass("x-grid-row-over"); + } + }, + + onRowOut : function(e, t){ + var row; + if((row = this.findRowIndex(t)) !== false && row !== this.findRowIndex(e.getRelatedTarget())){ + this.getRowComposite(row).removeClass("x-grid-row-over"); + } + }, + + renderHeaders : function(){ + var cm = this.cm; + var ct = this.templates.hcell, ht = this.templates.header, st = this.templates.hsplit; + var cb = [], lb = [], sb = [], lsb = [], p = {}; + for(var i = 0, len = cm.getColumnCount(); i < len; i++){ + p.cellId = "x-grid-hd-0-" + i; + p.splitId = "x-grid-csplit-0-" + i; + p.id = cm.getColumnId(i); + p.value = cm.getColumnHeader(i) || ""; + p.title = cm.getColumnTooltip(i) || (''+p.value).match(/\</) ? '' : p.value || ""; + p.style = (this.grid.enableColumnResize === false || !cm.isResizable(i) || cm.isFixed(i)) ? 'cursor:default' : ''; + if(!cm.isLocked(i)){ + cb[cb.length] = ct.apply(p); + sb[sb.length] = st.apply(p); + }else{ + lb[lb.length] = ct.apply(p); + lsb[lsb.length] = st.apply(p); + } + } + return [ht.apply({cells: lb.join(""), splits:lsb.join("")}), + ht.apply({cells: cb.join(""), splits:sb.join("")})]; + }, + + updateHeaders : function(){ + var html = this.renderHeaders(); + this.lockedHd.update(html[0]); + this.mainHd.update(html[1]); + }, + + /** + * Focuses the specified row. + * @param {Number} row The row index + */ + focusRow : function(row) + { + //Roo.log('GridView.focusRow'); + var x = this.scroller.dom.scrollLeft; + this.focusCell(row, 0, false); + this.scroller.dom.scrollLeft = x; + }, + + /** + * Focuses the specified cell. + * @param {Number} row The row index + * @param {Number} col The column index + * @param {Boolean} hscroll false to disable horizontal scrolling + */ + focusCell : function(row, col, hscroll) + { + //Roo.log('GridView.focusCell'); + var el = this.ensureVisible(row, col, hscroll); + this.focusEl.alignTo(el, "tl-tl"); + if(Roo.isGecko){ + this.focusEl.focus(); + }else{ + this.focusEl.focus.defer(1, this.focusEl); + } + }, + + /** + * Scrolls the specified cell into view + * @param {Number} row The row index + * @param {Number} col The column index + * @param {Boolean} hscroll false to disable horizontal scrolling + */ + ensureVisible : function(row, col, hscroll) + { + //Roo.log('GridView.ensureVisible,' + row + ',' + col); + //return null; //disable for testing. + if(typeof row != "number"){ + row = row.rowIndex; + } + if(row < 0 && row >= this.ds.getCount()){ + return null; + } + col = (col !== undefined ? col : 0); + var cm = this.grid.colModel; + while(cm.isHidden(col)){ + col++; + } + + var el = this.getCell(row, col); + if(!el){ + return null; + } + var c = this.scroller.dom; + + var ctop = parseInt(el.offsetTop, 10); + var cleft = parseInt(el.offsetLeft, 10); + var cbot = ctop + el.offsetHeight; + var cright = cleft + el.offsetWidth; + + var ch = c.clientHeight - this.mainHd.dom.offsetHeight; + var stop = parseInt(c.scrollTop, 10); + var sleft = parseInt(c.scrollLeft, 10); + var sbot = stop + ch; + var sright = sleft + c.clientWidth; + /* + Roo.log('GridView.ensureVisible:' + + ' ctop:' + ctop + + ' c.clientHeight:' + c.clientHeight + + ' this.mainHd.dom.offsetHeight:' + this.mainHd.dom.offsetHeight + + ' stop:' + stop + + ' cbot:' + cbot + + ' sbot:' + sbot + + ' ch:' + ch + ); + */ + if(ctop < stop){ + c.scrollTop = ctop; + //Roo.log("set scrolltop to ctop DISABLE?"); + }else if(cbot > sbot){ + //Roo.log("set scrolltop to cbot-ch"); + c.scrollTop = cbot-ch; + } + + if(hscroll !== false){ + if(cleft < sleft){ + c.scrollLeft = cleft; + }else if(cright > sright){ + c.scrollLeft = cright-c.clientWidth; + } + } + + return el; + }, + + updateColumns : function(){ + this.grid.stopEditing(); + var cm = this.grid.colModel, colIds = this.getColumnIds(); + //var totalWidth = cm.getTotalWidth(); + var pos = 0; + for(var i = 0, len = cm.getColumnCount(); i < len; i++){ + //if(cm.isHidden(i)) continue; + var w = cm.getColumnWidth(i); + this.css.updateRule(this.colSelector+this.idToCssName(colIds[i]), "width", (w - this.borderWidth) + "px"); + this.css.updateRule(this.hdSelector+this.idToCssName(colIds[i]), "width", (w - this.borderWidth) + "px"); + } + this.updateSplitters(); + }, + + generateRules : function(cm){ + var ruleBuf = [], rulesId = this.idToCssName(this.grid.id)+ '-cssrules'; + Roo.util.CSS.removeStyleSheet(rulesId); + for(var i = 0, len = cm.getColumnCount(); i < len; i++){ + var cid = cm.getColumnId(i); + var align = ''; + if(cm.config[i].align){ + align = 'text-align:'+cm.config[i].align+';'; + } + var hidden = ''; + if(cm.isHidden(i)){ + hidden = 'display:none;'; + } + var width = "width:" + (cm.getColumnWidth(i) - this.borderWidth) + "px;"; + ruleBuf.push( + this.colSelector, cid, " {\n", cm.config[i].css, align, width, "\n}\n", + this.hdSelector, cid, " {\n", align, width, "}\n", + this.tdSelector, cid, " {\n",hidden,"\n}\n", + this.splitSelector, cid, " {\n", hidden , "\n}\n"); + } + return Roo.util.CSS.createStyleSheet(ruleBuf.join(""), rulesId); + }, + + updateSplitters : function(){ + var cm = this.cm, s = this.getSplitters(); + if(s){ // splitters not created yet + var pos = 0, locked = true; + for(var i = 0, len = cm.getColumnCount(); i < len; i++){ + if(cm.isHidden(i)) { + continue; + } + var w = cm.getColumnWidth(i); // make sure it's a number + if(!cm.isLocked(i) && locked){ + pos = 0; + locked = false; + } + pos += w; + s[i].style.left = (pos-this.splitOffset) + "px"; + } + } + }, + + handleHiddenChange : function(colModel, colIndex, hidden){ + if(hidden){ + this.hideColumn(colIndex); + }else{ + this.unhideColumn(colIndex); + } + }, + + hideColumn : function(colIndex){ + var cid = this.getColumnId(colIndex); + this.css.updateRule(this.tdSelector+this.idToCssName(cid), "display", "none"); + this.css.updateRule(this.splitSelector+this.idToCssName(cid), "display", "none"); + if(Roo.isSafari){ + this.updateHeaders(); + } + this.updateSplitters(); + this.layout(); + }, + + unhideColumn : function(colIndex){ + var cid = this.getColumnId(colIndex); + this.css.updateRule(this.tdSelector+this.idToCssName(cid), "display", ""); + this.css.updateRule(this.splitSelector+this.idToCssName(cid), "display", ""); + + if(Roo.isSafari){ + this.updateHeaders(); + } + this.updateSplitters(); + this.layout(); + }, + + insertRows : function(dm, firstRow, lastRow, isUpdate){ + if(firstRow == 0 && lastRow == dm.getCount()-1){ + this.refresh(); + }else{ + if(!isUpdate){ + this.fireEvent("beforerowsinserted", this, firstRow, lastRow); + } + var s = this.getScrollState(); + var markup = this.renderRows(firstRow, lastRow); + this.bufferRows(markup[0], this.getLockedTable(), firstRow); + this.bufferRows(markup[1], this.getBodyTable(), firstRow); + this.restoreScroll(s); + if(!isUpdate){ + this.fireEvent("rowsinserted", this, firstRow, lastRow); + this.syncRowHeights(firstRow, lastRow); + this.stripeRows(firstRow); + this.layout(); + } + } + }, + + bufferRows : function(markup, target, index){ + var before = null, trows = target.rows, tbody = target.tBodies[0]; + if(index < trows.length){ + before = trows[index]; + } + var b = document.createElement("div"); + b.innerHTML = "<table><tbody>"+markup+"</tbody></table>"; + var rows = b.firstChild.rows; + for(var i = 0, len = rows.length; i < len; i++){ + if(before){ + tbody.insertBefore(rows[0], before); + }else{ + tbody.appendChild(rows[0]); + } + } + b.innerHTML = ""; + b = null; + }, + + deleteRows : function(dm, firstRow, lastRow){ + if(dm.getRowCount()<1){ + this.fireEvent("beforerefresh", this); + this.mainBody.update(""); + this.lockedBody.update(""); + this.fireEvent("refresh", this); + }else{ + this.fireEvent("beforerowsdeleted", this, firstRow, lastRow); + var bt = this.getBodyTable(); + var tbody = bt.firstChild; + var rows = bt.rows; + for(var rowIndex = firstRow; rowIndex <= lastRow; rowIndex++){ + tbody.removeChild(rows[firstRow]); + } + this.stripeRows(firstRow); + this.fireEvent("rowsdeleted", this, firstRow, lastRow); + } + }, + + updateRows : function(dataSource, firstRow, lastRow){ + var s = this.getScrollState(); + this.refresh(); + this.restoreScroll(s); + }, + + handleSort : function(dataSource, sortColumnIndex, sortDir, noRefresh){ + if(!noRefresh){ + this.refresh(); + } + this.updateHeaderSortState(); + }, + + getScrollState : function(){ + + var sb = this.scroller.dom; + return {left: sb.scrollLeft, top: sb.scrollTop}; + }, + + stripeRows : function(startRow){ + if(!this.grid.stripeRows || this.ds.getCount() < 1){ + return; + } + startRow = startRow || 0; + var rows = this.getBodyTable().rows; + var lrows = this.getLockedTable().rows; + var cls = ' x-grid-row-alt '; + for(var i = startRow, len = rows.length; i < len; i++){ + var row = rows[i], lrow = lrows[i]; + var isAlt = ((i+1) % 2 == 0); + var hasAlt = (' '+row.className + ' ').indexOf(cls) != -1; + if(isAlt == hasAlt){ + continue; + } + if(isAlt){ + row.className += " x-grid-row-alt"; + }else{ + row.className = row.className.replace("x-grid-row-alt", ""); + } + if(lrow){ + lrow.className = row.className; + } + } + }, + + restoreScroll : function(state){ + //Roo.log('GridView.restoreScroll'); + var sb = this.scroller.dom; + sb.scrollLeft = state.left; + sb.scrollTop = state.top; + this.syncScroll(); + }, + + syncScroll : function(){ + //Roo.log('GridView.syncScroll'); + var sb = this.scroller.dom; + var sh = this.mainHd.dom; + var bs = this.mainBody.dom; + var lv = this.lockedBody.dom; + sh.scrollLeft = bs.scrollLeft = sb.scrollLeft; + lv.scrollTop = bs.scrollTop = sb.scrollTop; + }, + + handleScroll : function(e){ + this.syncScroll(); + var sb = this.scroller.dom; + this.grid.fireEvent("bodyscroll", sb.scrollLeft, sb.scrollTop); + e.stopEvent(); + }, + + handleWheel : function(e){ + var d = e.getWheelDelta(); + this.scroller.dom.scrollTop -= d*22; + // set this here to prevent jumpy scrolling on large tables + this.lockedBody.dom.scrollTop = this.mainBody.dom.scrollTop = this.scroller.dom.scrollTop; + e.stopEvent(); + }, + + renderRows : function(startRow, endRow){ + // pull in all the crap needed to render rows + var g = this.grid, cm = g.colModel, ds = g.dataSource, stripe = g.stripeRows; + var colCount = cm.getColumnCount(); + + if(ds.getCount() < 1){ + return ["", ""]; + } + + // build a map for all the columns + var cs = []; + for(var i = 0; i < colCount; i++){ + var name = cm.getDataIndex(i); + cs[i] = { + name : typeof name == 'undefined' ? ds.fields.get(i).name : name, + renderer : cm.getRenderer(i), + id : cm.getColumnId(i), + locked : cm.isLocked(i), + has_editor : cm.isCellEditable(i) + }; + } + + startRow = startRow || 0; + endRow = typeof endRow == "undefined"? ds.getCount()-1 : endRow; + + // records to render + var rs = ds.getRange(startRow, endRow); + + return this.doRender(cs, rs, ds, startRow, colCount, stripe); + }, + + // As much as I hate to duplicate code, this was branched because FireFox really hates + // [].join("") on strings. The performance difference was substantial enough to + // branch this function + doRender : Roo.isGecko ? + function(cs, rs, ds, startRow, colCount, stripe){ + var ts = this.templates, ct = ts.cell, rt = ts.row; + // buffers + var buf = "", lbuf = "", cb, lcb, c, p = {}, rp = {}, r, rowIndex; + + var hasListener = this.grid.hasListener('rowclass'); + var rowcfg = {}; + for(var j = 0, len = rs.length; j < len; j++){ + r = rs[j]; cb = ""; lcb = ""; rowIndex = (j+startRow); + for(var i = 0; i < colCount; i++){ + c = cs[i]; + p.cellId = "x-grid-cell-" + rowIndex + "-" + i; + p.id = c.id; + p.css = p.attr = ""; + p.value = c.renderer(r.data[c.name], p, r, rowIndex, i, ds); + if(p.value == undefined || p.value === "") { + p.value = "&#160;"; + } + if(c.has_editor){ + p.css += ' x-grid-editable-cell'; + } + if(c.dirty && typeof r.modified[c.name] !== 'undefined'){ + p.css += ' x-grid-dirty-cell'; + } + var markup = ct.apply(p); + if(!c.locked){ + cb+= markup; + }else{ + lcb+= markup; + } + } + var alt = []; + if(stripe && ((rowIndex+1) % 2 == 0)){ + alt.push("x-grid-row-alt") + } + if(r.dirty){ + alt.push( " x-grid-dirty-row"); + } + rp.cells = lcb; + if(this.getRowClass){ + alt.push(this.getRowClass(r, rowIndex)); + } + if (hasListener) { + rowcfg = { + + record: r, + rowIndex : rowIndex, + rowClass : '' + }; + this.grid.fireEvent('rowclass', this, rowcfg); + alt.push(rowcfg.rowClass); + } + rp.alt = alt.join(" "); + lbuf+= rt.apply(rp); + rp.cells = cb; + buf+= rt.apply(rp); + } + return [lbuf, buf]; + } : + function(cs, rs, ds, startRow, colCount, stripe){ + var ts = this.templates, ct = ts.cell, rt = ts.row; + // buffers + var buf = [], lbuf = [], cb, lcb, c, p = {}, rp = {}, r, rowIndex; + var hasListener = this.grid.hasListener('rowclass'); + + var rowcfg = {}; + for(var j = 0, len = rs.length; j < len; j++){ + r = rs[j]; cb = []; lcb = []; rowIndex = (j+startRow); + for(var i = 0; i < colCount; i++){ + c = cs[i]; + p.cellId = "x-grid-cell-" + rowIndex + "-" + i; + p.id = c.id; + p.css = p.attr = ""; + p.value = c.renderer(r.data[c.name], p, r, rowIndex, i, ds); + if(p.value == undefined || p.value === "") { + p.value = "&#160;"; + } + //Roo.log(c); + if(c.has_editor){ + p.css += ' x-grid-editable-cell'; + } + if(r.dirty && typeof r.modified[c.name] !== 'undefined'){ + p.css += ' x-grid-dirty-cell' + } + + var markup = ct.apply(p); + if(!c.locked){ + cb[cb.length] = markup; + }else{ + lcb[lcb.length] = markup; + } + } + var alt = []; + if(stripe && ((rowIndex+1) % 2 == 0)){ + alt.push( "x-grid-row-alt"); + } + if(r.dirty){ + alt.push(" x-grid-dirty-row"); + } + rp.cells = lcb; + if(this.getRowClass){ + alt.push( this.getRowClass(r, rowIndex)); + } + if (hasListener) { + rowcfg = { + + record: r, + rowIndex : rowIndex, + rowClass : '' + }; + this.grid.fireEvent('rowclass', this, rowcfg); + alt.push(rowcfg.rowClass); + } + + rp.alt = alt.join(" "); + rp.cells = lcb.join(""); + lbuf[lbuf.length] = rt.apply(rp); + rp.cells = cb.join(""); + buf[buf.length] = rt.apply(rp); + } + return [lbuf.join(""), buf.join("")]; + }, + + renderBody : function(){ + var markup = this.renderRows(); + var bt = this.templates.body; + return [bt.apply({rows: markup[0]}), bt.apply({rows: markup[1]})]; + }, + + /** + * Refreshes the grid + * @param {Boolean} headersToo + */ + refresh : function(headersToo){ + this.fireEvent("beforerefresh", this); + this.grid.stopEditing(); + var result = this.renderBody(); + this.lockedBody.update(result[0]); + this.mainBody.update(result[1]); + if(headersToo === true){ + this.updateHeaders(); + this.updateColumns(); + this.updateSplitters(); + this.updateHeaderSortState(); + } + this.syncRowHeights(); + this.layout(); + this.fireEvent("refresh", this); + }, + + handleColumnMove : function(cm, oldIndex, newIndex){ + this.indexMap = null; + var s = this.getScrollState(); + this.refresh(true); + this.restoreScroll(s); + this.afterMove(newIndex); + }, + + afterMove : function(colIndex){ + if(this.enableMoveAnim && Roo.enableFx){ + this.fly(this.getHeaderCell(colIndex).firstChild).highlight(this.hlColor); + } + // if multisort - fix sortOrder, and reload.. + if (this.grid.dataSource.multiSort) { + // the we can call sort again.. + var dm = this.grid.dataSource; + var cm = this.grid.colModel; + var so = []; + for(var i = 0; i < cm.config.length; i++ ) { + + if ((typeof(dm.sortToggle[cm.config[i].dataIndex]) == 'undefined')) { + continue; // dont' bother, it's not in sort list or being set. + } + + so.push(cm.config[i].dataIndex); + }; + dm.sortOrder = so; + dm.load(dm.lastOptions); + + + } + + }, + + updateCell : function(dm, rowIndex, dataIndex){ + var colIndex = this.getColumnIndexByDataIndex(dataIndex); + if(typeof colIndex == "undefined"){ // not present in grid + return; + } + var cm = this.grid.colModel; + var cell = this.getCell(rowIndex, colIndex); + var cellText = this.getCellText(rowIndex, colIndex); + + var p = { + cellId : "x-grid-cell-" + rowIndex + "-" + colIndex, + id : cm.getColumnId(colIndex), + css: colIndex == cm.getColumnCount()-1 ? "x-grid-col-last" : "" + }; + var renderer = cm.getRenderer(colIndex); + var val = renderer(dm.getValueAt(rowIndex, dataIndex), p, rowIndex, colIndex, dm); + if(typeof val == "undefined" || val === "") { + val = "&#160;"; + } + cellText.innerHTML = val; + cell.className = this.cellClass + " " + this.idToCssName(p.cellId) + " " + p.css; + this.syncRowHeights(rowIndex, rowIndex); + }, + + calcColumnWidth : function(colIndex, maxRowsToMeasure){ + var maxWidth = 0; + if(this.grid.autoSizeHeaders){ + var h = this.getHeaderCellMeasure(colIndex); + maxWidth = Math.max(maxWidth, h.scrollWidth); + } + var tb, index; + if(this.cm.isLocked(colIndex)){ + tb = this.getLockedTable(); + index = colIndex; + }else{ + tb = this.getBodyTable(); + index = colIndex - this.cm.getLockedCount(); + } + if(tb && tb.rows){ + var rows = tb.rows; + var stopIndex = Math.min(maxRowsToMeasure || rows.length, rows.length); + for(var i = 0; i < stopIndex; i++){ + var cell = rows[i].childNodes[index].firstChild; + maxWidth = Math.max(maxWidth, cell.scrollWidth); + } + } + return maxWidth + /*margin for error in IE*/ 5; + }, + /** + * Autofit a column to its content. + * @param {Number} colIndex + * @param {Boolean} forceMinSize true to force the column to go smaller if possible + */ + autoSizeColumn : function(colIndex, forceMinSize, suppressEvent){ + if(this.cm.isHidden(colIndex)){ + return; // can't calc a hidden column + } + if(forceMinSize){ + var cid = this.cm.getColumnId(colIndex); + this.css.updateRule(this.colSelector +this.idToCssName( cid), "width", this.grid.minColumnWidth + "px"); + if(this.grid.autoSizeHeaders){ + this.css.updateRule(this.hdSelector + this.idToCssName(cid), "width", this.grid.minColumnWidth + "px"); + } + } + var newWidth = this.calcColumnWidth(colIndex); + this.cm.setColumnWidth(colIndex, + Math.max(this.grid.minColumnWidth, newWidth), suppressEvent); + if(!suppressEvent){ + this.grid.fireEvent("columnresize", colIndex, newWidth); + } + }, + + /** + * Autofits all columns to their content and then expands to fit any extra space in the grid + */ + autoSizeColumns : function(){ + var cm = this.grid.colModel; + var colCount = cm.getColumnCount(); + for(var i = 0; i < colCount; i++){ + this.autoSizeColumn(i, true, true); + } + if(cm.getTotalWidth() < this.scroller.dom.clientWidth){ + this.fitColumns(); + }else{ + this.updateColumns(); + this.layout(); + } + }, + + /** + * Autofits all columns to the grid's width proportionate with their current size + * @param {Boolean} reserveScrollSpace Reserve space for a scrollbar + */ + fitColumns : function(reserveScrollSpace){ + var cm = this.grid.colModel; + var colCount = cm.getColumnCount(); + var cols = []; + var width = 0; + var i, w; + for (i = 0; i < colCount; i++){ + if(!cm.isHidden(i) && !cm.isFixed(i)){ + w = cm.getColumnWidth(i); + cols.push(i); + cols.push(w); + width += w; + } + } + var avail = Math.min(this.scroller.dom.clientWidth, this.el.getWidth()); + if(reserveScrollSpace){ + avail -= 17; + } + var frac = (avail - cm.getTotalWidth())/width; + while (cols.length){ + w = cols.pop(); + i = cols.pop(); + cm.setColumnWidth(i, Math.floor(w + w*frac), true); + } + this.updateColumns(); + this.layout(); + }, + + onRowSelect : function(rowIndex){ + var row = this.getRowComposite(rowIndex); + row.addClass("x-grid-row-selected"); + }, + + onRowDeselect : function(rowIndex){ + var row = this.getRowComposite(rowIndex); + row.removeClass("x-grid-row-selected"); + }, + + onCellSelect : function(row, col){ + var cell = this.getCell(row, col); + if(cell){ + Roo.fly(cell).addClass("x-grid-cell-selected"); + } + }, + + onCellDeselect : function(row, col){ + var cell = this.getCell(row, col); + if(cell){ + Roo.fly(cell).removeClass("x-grid-cell-selected"); + } + }, + + updateHeaderSortState : function(){ + + // sort state can be single { field: xxx, direction : yyy} + // or { xxx=>ASC , yyy : DESC ..... } + + var mstate = {}; + if (!this.ds.multiSort) { + var state = this.ds.getSortState(); + if(!state){ + return; + } + mstate[state.field] = state.direction; + // FIXME... - this is not used here.. but might be elsewhere.. + this.sortState = state; + + } else { + mstate = this.ds.sortToggle; + } + //remove existing sort classes.. + + var sc = this.sortClasses; + var hds = this.el.select(this.headerSelector).removeClass(sc); + + for(var f in mstate) { + + var sortColumn = this.cm.findColumnIndex(f); + + if(sortColumn != -1){ + var sortDir = mstate[f]; + hds.item(sortColumn).addClass(sc[sortDir == "DESC" ? 1 : 0]); + } + } + + + + }, + + + handleHeaderClick : function(g, index,e){ + + Roo.log("header click"); + + if (Roo.isTouch) { + // touch events on header are handled by context + this.handleHdCtx(g,index,e); + return; + } + + + if(this.headersDisabled){ + return; + } + var dm = g.dataSource, cm = g.colModel; + if(!cm.isSortable(index)){ + return; + } + g.stopEditing(); + + if (dm.multiSort) { + // update the sortOrder + var so = []; + for(var i = 0; i < cm.config.length; i++ ) { + + if ((typeof(dm.sortToggle[cm.config[i].dataIndex]) == 'undefined') && (index != i)) { + continue; // dont' bother, it's not in sort list or being set. + } + + so.push(cm.config[i].dataIndex); + }; + dm.sortOrder = so; + } + + + dm.sort(cm.getDataIndex(index)); + }, + + + destroy : function(){ + if(this.colMenu){ + this.colMenu.removeAll(); + Roo.menu.MenuMgr.unregister(this.colMenu); + this.colMenu.getEl().remove(); + delete this.colMenu; + } + if(this.hmenu){ + this.hmenu.removeAll(); + Roo.menu.MenuMgr.unregister(this.hmenu); + this.hmenu.getEl().remove(); + delete this.hmenu; + } + if(this.grid.enableColumnMove){ + var dds = Roo.dd.DDM.ids['gridHeader' + this.grid.getGridEl().id]; + if(dds){ + for(var dd in dds){ + if(!dds[dd].config.isTarget && dds[dd].dragElId){ + var elid = dds[dd].dragElId; + dds[dd].unreg(); + Roo.get(elid).remove(); + } else if(dds[dd].config.isTarget){ + dds[dd].proxyTop.remove(); + dds[dd].proxyBottom.remove(); + dds[dd].unreg(); + } + if(Roo.dd.DDM.locationCache[dd]){ + delete Roo.dd.DDM.locationCache[dd]; + } + } + delete Roo.dd.DDM.ids['gridHeader' + this.grid.getGridEl().id]; + } + } + Roo.util.CSS.removeStyleSheet(this.idToCssName(this.grid.id) + '-cssrules'); + this.bind(null, null); + Roo.EventManager.removeResizeListener(this.onWindowResize, this); + }, + + handleLockChange : function(){ + this.refresh(true); + }, + + onDenyColumnLock : function(){ + + }, + + onDenyColumnHide : function(){ + + }, + + handleHdMenuClick : function(item){ + var index = this.hdCtxIndex; + var cm = this.cm, ds = this.ds; + switch(item.id){ + case "asc": + ds.sort(cm.getDataIndex(index), "ASC"); + break; + case "desc": + ds.sort(cm.getDataIndex(index), "DESC"); + break; + case "lock": + var lc = cm.getLockedCount(); + if(cm.getColumnCount(true) <= lc+1){ + this.onDenyColumnLock(); + return; + } + if(lc != index){ + cm.setLocked(index, true, true); + cm.moveColumn(index, lc); + this.grid.fireEvent("columnmove", index, lc); + }else{ + cm.setLocked(index, true); + } + break; + case "unlock": + var lc = cm.getLockedCount(); + if((lc-1) != index){ + cm.setLocked(index, false, true); + cm.moveColumn(index, lc-1); + this.grid.fireEvent("columnmove", index, lc-1); + }else{ + cm.setLocked(index, false); + } + break; + case 'wider': // used to expand cols on touch.. + case 'narrow': + var cw = cm.getColumnWidth(index); + cw += (item.id == 'wider' ? 1 : -1) * 50; + cw = Math.max(0, cw); + cw = Math.min(cw,4000); + cm.setColumnWidth(index, cw); + break; + + default: + index = cm.getIndexById(item.id.substr(4)); + if(index != -1){ + if(item.checked && cm.getColumnCount(true) <= 1){ + this.onDenyColumnHide(); + return false; + } + cm.setHidden(index, item.checked); + } + } + return true; + }, + + beforeColMenuShow : function(){ + var cm = this.cm, colCount = cm.getColumnCount(); + this.colMenu.removeAll(); + for(var i = 0; i < colCount; i++){ + this.colMenu.add(new Roo.menu.CheckItem({ + id: "col-"+cm.getColumnId(i), + text: cm.getColumnHeader(i), + checked: !cm.isHidden(i), + hideOnClick:false + })); + } + }, + + handleHdCtx : function(g, index, e){ + e.stopEvent(); + var hd = this.getHeaderCell(index); + this.hdCtxIndex = index; + var ms = this.hmenu.items, cm = this.cm; + ms.get("asc").setDisabled(!cm.isSortable(index)); + ms.get("desc").setDisabled(!cm.isSortable(index)); + if(this.grid.enableColLock !== false){ + ms.get("lock").setDisabled(cm.isLocked(index)); + ms.get("unlock").setDisabled(!cm.isLocked(index)); + } + this.hmenu.show(hd, "tl-bl"); + }, + + handleHdOver : function(e){ + var hd = this.findHeaderCell(e.getTarget()); + if(hd && !this.headersDisabled){ + if(this.grid.colModel.isSortable(this.getCellIndex(hd))){ + this.fly(hd).addClass("x-grid-hd-over"); + } + } + }, + + handleHdOut : function(e){ + var hd = this.findHeaderCell(e.getTarget()); + if(hd){ + this.fly(hd).removeClass("x-grid-hd-over"); + } + }, + + handleSplitDblClick : function(e, t){ + var i = this.getCellIndex(t); + if(this.grid.enableColumnResize !== false && this.cm.isResizable(i) && !this.cm.isFixed(i)){ + this.autoSizeColumn(i, true); + this.layout(); + } + }, + + render : function(){ + + var cm = this.cm; + var colCount = cm.getColumnCount(); + + if(this.grid.monitorWindowResize === true){ + Roo.EventManager.onWindowResize(this.onWindowResize, this, true); + } + var header = this.renderHeaders(); + var body = this.templates.body.apply({rows:""}); + var html = this.templates.master.apply({ + lockedBody: body, + body: body, + lockedHeader: header[0], + header: header[1] + }); + + //this.updateColumns(); + + this.grid.getGridEl().dom.innerHTML = html; + + this.initElements(); + + // a kludge to fix the random scolling effect in webkit + this.el.on("scroll", function() { + this.el.dom.scrollTop=0; // hopefully not recursive.. + },this); + + this.scroller.on("scroll", this.handleScroll, this); + this.lockedBody.on("mousewheel", this.handleWheel, this); + this.mainBody.on("mousewheel", this.handleWheel, this); + + this.mainHd.on("mouseover", this.handleHdOver, this); + this.mainHd.on("mouseout", this.handleHdOut, this); + this.mainHd.on("dblclick", this.handleSplitDblClick, this, + {delegate: "."+this.splitClass}); + + this.lockedHd.on("mouseover", this.handleHdOver, this); + this.lockedHd.on("mouseout", this.handleHdOut, this); + this.lockedHd.on("dblclick", this.handleSplitDblClick, this, + {delegate: "."+this.splitClass}); + + if(this.grid.enableColumnResize !== false && Roo.grid.SplitDragZone){ + new Roo.grid.SplitDragZone(this.grid, this.lockedHd.dom, this.mainHd.dom); + } + + this.updateSplitters(); + + if(this.grid.enableColumnMove && Roo.grid.HeaderDragZone){ + new Roo.grid.HeaderDragZone(this.grid, this.lockedHd.dom, this.mainHd.dom); + new Roo.grid.HeaderDropZone(this.grid, this.lockedHd.dom, this.mainHd.dom); + } + + if(this.grid.enableCtxMenu !== false && Roo.menu.Menu){ + this.hmenu = new Roo.menu.Menu({id: this.grid.id + "-hctx"}); + this.hmenu.add( + {id:"asc", text: this.sortAscText, cls: "xg-hmenu-sort-asc"}, + {id:"desc", text: this.sortDescText, cls: "xg-hmenu-sort-desc"} + ); + if(this.grid.enableColLock !== false){ + this.hmenu.add('-', + {id:"lock", text: this.lockText, cls: "xg-hmenu-lock"}, + {id:"unlock", text: this.unlockText, cls: "xg-hmenu-unlock"} + ); + } + if (Roo.isTouch) { + this.hmenu.add('-', + {id:"wider", text: this.columnsWiderText}, + {id:"narrow", text: this.columnsNarrowText } + ); + + + } + + if(this.grid.enableColumnHide !== false){ + + this.colMenu = new Roo.menu.Menu({id:this.grid.id + "-hcols-menu"}); + this.colMenu.on("beforeshow", this.beforeColMenuShow, this); + this.colMenu.on("itemclick", this.handleHdMenuClick, this); + + this.hmenu.add('-', + {id:"columns", text: this.columnsText, menu: this.colMenu} + ); + } + this.hmenu.on("itemclick", this.handleHdMenuClick, this); + + this.grid.on("headercontextmenu", this.handleHdCtx, this); + } + + if((this.grid.enableDragDrop || this.grid.enableDrag) && Roo.grid.GridDragZone){ + this.dd = new Roo.grid.GridDragZone(this.grid, { + ddGroup : this.grid.ddGroup || 'GridDD' + }); + + } + + /* + for(var i = 0; i < colCount; i++){ + if(cm.isHidden(i)){ + this.hideColumn(i); + } + if(cm.config[i].align){ + this.css.updateRule(this.colSelector + i, "textAlign", cm.config[i].align); + this.css.updateRule(this.hdSelector + i, "textAlign", cm.config[i].align); + } + }*/ + + this.updateHeaderSortState(); + + this.beforeInitialResize(); + this.layout(true); + + // two part rendering gives faster view to the user + this.renderPhase2.defer(1, this); + }, + + renderPhase2 : function(){ + // render the rows now + this.refresh(); + if(this.grid.autoSizeColumns){ + this.autoSizeColumns(); + } + }, + + beforeInitialResize : function(){ + + }, + + onColumnSplitterMoved : function(i, w){ + this.userResized = true; + var cm = this.grid.colModel; + cm.setColumnWidth(i, w, true); + var cid = cm.getColumnId(i); + this.css.updateRule(this.colSelector + this.idToCssName(cid), "width", (w-this.borderWidth) + "px"); + this.css.updateRule(this.hdSelector + this.idToCssName(cid), "width", (w-this.borderWidth) + "px"); + this.updateSplitters(); + this.layout(); + this.grid.fireEvent("columnresize", i, w); + }, + + syncRowHeights : function(startIndex, endIndex){ + if(this.grid.enableRowHeightSync === true && this.cm.getLockedCount() > 0){ + startIndex = startIndex || 0; + var mrows = this.getBodyTable().rows; + var lrows = this.getLockedTable().rows; + var len = mrows.length-1; + endIndex = Math.min(endIndex || len, len); + for(var i = startIndex; i <= endIndex; i++){ + var m = mrows[i], l = lrows[i]; + var h = Math.max(m.offsetHeight, l.offsetHeight); + m.style.height = l.style.height = h + "px"; + } + } + }, + + layout : function(initialRender, is2ndPass){ + var g = this.grid; + var auto = g.autoHeight; + var scrollOffset = 16; + var c = g.getGridEl(), cm = this.cm, + expandCol = g.autoExpandColumn, + gv = this; + //c.beginMeasure(); + + if(!c.dom.offsetWidth){ // display:none? + if(initialRender){ + this.lockedWrap.show(); + this.mainWrap.show(); + } + return; + } + + var hasLock = this.cm.isLocked(0); + + var tbh = this.headerPanel.getHeight(); + var bbh = this.footerPanel.getHeight(); + + if(auto){ + var ch = this.getBodyTable().offsetHeight + tbh + bbh + this.mainHd.getHeight(); + var newHeight = ch + c.getBorderWidth("tb"); + if(g.maxHeight){ + newHeight = Math.min(g.maxHeight, newHeight); + } + c.setHeight(newHeight); + } + + if(g.autoWidth){ + c.setWidth(cm.getTotalWidth()+c.getBorderWidth('lr')); + } + + var s = this.scroller; + + var csize = c.getSize(true); + + this.el.setSize(csize.width, csize.height); + + this.headerPanel.setWidth(csize.width); + this.footerPanel.setWidth(csize.width); + + var hdHeight = this.mainHd.getHeight(); + var vw = csize.width; + var vh = csize.height - (tbh + bbh); + + s.setSize(vw, vh); + + var bt = this.getBodyTable(); + + if(cm.getLockedCount() == cm.config.length){ + bt = this.getLockedTable(); + } + + var ltWidth = hasLock ? + Math.max(this.getLockedTable().offsetWidth, this.lockedHd.dom.firstChild.offsetWidth) : 0; + + var scrollHeight = bt.offsetHeight; + var scrollWidth = ltWidth + bt.offsetWidth; + var vscroll = false, hscroll = false; + + this.scrollSizer.setSize(scrollWidth, scrollHeight+hdHeight); + + var lw = this.lockedWrap, mw = this.mainWrap; + var lb = this.lockedBody, mb = this.mainBody; + + setTimeout(function(){ + var t = s.dom.offsetTop; + var w = s.dom.clientWidth, + h = s.dom.clientHeight; + + lw.setTop(t); + lw.setSize(ltWidth, h); + + mw.setLeftTop(ltWidth, t); + mw.setSize(w-ltWidth, h); + + lb.setHeight(h-hdHeight); + mb.setHeight(h-hdHeight); + + if(is2ndPass !== true && !gv.userResized && expandCol){ + // high speed resize without full column calculation + + var ci = cm.getIndexById(expandCol); + if (ci < 0) { + ci = cm.findColumnIndex(expandCol); + } + ci = Math.max(0, ci); // make sure it's got at least the first col. + var expandId = cm.getColumnId(ci); + var tw = cm.getTotalWidth(false); + var currentWidth = cm.getColumnWidth(ci); + var cw = Math.min(Math.max(((w-tw)+currentWidth-2)-/*scrollbar*/(w <= s.dom.offsetWidth ? 0 : 18), g.autoExpandMin), g.autoExpandMax); + if(currentWidth != cw){ + cm.setColumnWidth(ci, cw, true); + gv.css.updateRule(gv.colSelector+gv.idToCssName(expandId), "width", (cw - gv.borderWidth) + "px"); + gv.css.updateRule(gv.hdSelector+gv.idToCssName(expandId), "width", (cw - gv.borderWidth) + "px"); + gv.updateSplitters(); + gv.layout(false, true); + } + } + + if(initialRender){ + lw.show(); + mw.show(); + } + //c.endMeasure(); + }, 10); + }, + + onWindowResize : function(){ + if(!this.grid.monitorWindowResize || this.grid.autoHeight){ + return; + } + this.layout(); + }, + + appendFooter : function(parentEl){ + return null; + }, + + sortAscText : "Sort Ascending", + sortDescText : "Sort Descending", + lockText : "Lock Column", + unlockText : "Unlock Column", + columnsText : "Columns", + + columnsWiderText : "Wider", + columnsNarrowText : "Thinner" +}); + + +Roo.grid.GridView.ColumnDragZone = function(grid, hd){ + Roo.grid.GridView.ColumnDragZone.superclass.constructor.call(this, grid, hd, null); + this.proxy.el.addClass('x-grid3-col-dd'); +}; + +Roo.extend(Roo.grid.GridView.ColumnDragZone, Roo.grid.HeaderDragZone, { + handleMouseDown : function(e){ + + }, + + callHandleMouseDown : function(e){ + Roo.grid.GridView.ColumnDragZone.superclass.handleMouseDown.call(this, e); + } +}); + \ No newline at end of file diff --git a/docs2/src/Roo_grid_HeaderDragZone.js.html b/docs2/src/Roo_grid_HeaderDragZone.js.html new file mode 100644 index 0000000000..bd69831394 --- /dev/null +++ b/docs2/src/Roo_grid_HeaderDragZone.js.html @@ -0,0 +1,59 @@ +/home/alan/gitlive/roojs1/Roo/grid/HeaderDragZone.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +// private +// This is a support class used internally by the Grid components +Roo.grid.HeaderDragZone = function(grid, hd, hd2){ + this.grid = grid; + this.view = grid.getView(); + this.ddGroup = "gridHeader" + this.grid.getGridEl().id; + Roo.grid.HeaderDragZone.superclass.constructor.call(this, hd); + if(hd2){ + this.setHandleElId(Roo.id(hd)); + this.setOuterHandleElId(Roo.id(hd2)); + } + this.scroll = false; +}; +Roo.extend(Roo.grid.HeaderDragZone, Roo.dd.DragZone, { + maxDragWidth: 120, + getDragData : function(e){ + var t = Roo.lib.Event.getTarget(e); + var h = this.view.findHeaderCell(t); + if(h){ + return {ddel: h.firstChild, header:h}; + } + return false; + }, + + onInitDrag : function(e){ + this.view.headersDisabled = true; + var clone = this.dragData.ddel.cloneNode(true); + clone.id = Roo.id(); + clone.style.width = Math.min(this.dragData.header.offsetWidth,this.maxDragWidth) + "px"; + this.proxy.update(clone); + return true; + }, + + afterValidDrop : function(){ + var v = this.view; + setTimeout(function(){ + v.headersDisabled = false; + }, 50); + }, + + afterInvalidDrop : function(){ + var v = this.view; + setTimeout(function(){ + v.headersDisabled = false; + }, 50); + } +}); + \ No newline at end of file diff --git a/docs2/src/Roo_grid_HeaderDropZone.js.html b/docs2/src/Roo_grid_HeaderDropZone.js.html new file mode 100644 index 0000000000..fa89bef80c --- /dev/null +++ b/docs2/src/Roo_grid_HeaderDropZone.js.html @@ -0,0 +1,159 @@ +/home/alan/gitlive/roojs1/Roo/grid/HeaderDropZone.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +// private +// This is a support class used internally by the Grid components +Roo.grid.HeaderDropZone = function(grid, hd, hd2){ + this.grid = grid; + this.view = grid.getView(); + // split the proxies so they don't interfere with mouse events + this.proxyTop = Roo.DomHelper.append(document.body, { + cls:"col-move-top", html:"&#160;" + }, true); + this.proxyBottom = Roo.DomHelper.append(document.body, { + cls:"col-move-bottom", html:"&#160;" + }, true); + this.proxyTop.hide = this.proxyBottom.hide = function(){ + this.setLeftTop(-100,-100); + this.setStyle("visibility", "hidden"); + }; + this.ddGroup = "gridHeader" + this.grid.getGridEl().id; + // temporarily disabled + //Roo.dd.ScrollManager.register(this.view.scroller.dom); + Roo.grid.HeaderDropZone.superclass.constructor.call(this, grid.getGridEl().dom); +}; +Roo.extend(Roo.grid.HeaderDropZone, Roo.dd.DropZone, { + proxyOffsets : [-4, -9], + fly: Roo.Element.fly, + + getTargetFromEvent : function(e){ + var t = Roo.lib.Event.getTarget(e); + var cindex = this.view.findCellIndex(t); + if(cindex !== false){ + return this.view.getHeaderCell(cindex); + } + return null; + }, + + nextVisible : function(h){ + var v = this.view, cm = this.grid.colModel; + h = h.nextSibling; + while(h){ + if(!cm.isHidden(v.getCellIndex(h))){ + return h; + } + h = h.nextSibling; + } + return null; + }, + + prevVisible : function(h){ + var v = this.view, cm = this.grid.colModel; + h = h.prevSibling; + while(h){ + if(!cm.isHidden(v.getCellIndex(h))){ + return h; + } + h = h.prevSibling; + } + return null; + }, + + positionIndicator : function(h, n, e){ + var x = Roo.lib.Event.getPageX(e); + var r = Roo.lib.Dom.getRegion(n.firstChild); + var px, pt, py = r.top + this.proxyOffsets[1]; + if((r.right - x) <= (r.right-r.left)/2){ + px = r.right+this.view.borderWidth; + pt = "after"; + }else{ + px = r.left; + pt = "before"; + } + var oldIndex = this.view.getCellIndex(h); + var newIndex = this.view.getCellIndex(n); + + if(this.grid.colModel.isFixed(newIndex)){ + return false; + } + + var locked = this.grid.colModel.isLocked(newIndex); + + if(pt == "after"){ + newIndex++; + } + if(oldIndex < newIndex){ + newIndex--; + } + if(oldIndex == newIndex && (locked == this.grid.colModel.isLocked(oldIndex))){ + return false; + } + px += this.proxyOffsets[0]; + this.proxyTop.setLeftTop(px, py); + this.proxyTop.show(); + if(!this.bottomOffset){ + this.bottomOffset = this.view.mainHd.getHeight(); + } + this.proxyBottom.setLeftTop(px, py+this.proxyTop.dom.offsetHeight+this.bottomOffset); + this.proxyBottom.show(); + return pt; + }, + + onNodeEnter : function(n, dd, e, data){ + if(data.header != n){ + this.positionIndicator(data.header, n, e); + } + }, + + onNodeOver : function(n, dd, e, data){ + var result = false; + if(data.header != n){ + result = this.positionIndicator(data.header, n, e); + } + if(!result){ + this.proxyTop.hide(); + this.proxyBottom.hide(); + } + return result ? this.dropAllowed : this.dropNotAllowed; + }, + + onNodeOut : function(n, dd, e, data){ + this.proxyTop.hide(); + this.proxyBottom.hide(); + }, + + onNodeDrop : function(n, dd, e, data){ + var h = data.header; + if(h != n){ + var cm = this.grid.colModel; + var x = Roo.lib.Event.getPageX(e); + var r = Roo.lib.Dom.getRegion(n.firstChild); + var pt = (r.right - x) <= ((r.right-r.left)/2) ? "after" : "before"; + var oldIndex = this.view.getCellIndex(h); + var newIndex = this.view.getCellIndex(n); + var locked = cm.isLocked(newIndex); + if(pt == "after"){ + newIndex++; + } + if(oldIndex < newIndex){ + newIndex--; + } + if(oldIndex == newIndex && (locked == cm.isLocked(oldIndex))){ + return false; + } + cm.setLocked(oldIndex, locked, true); + cm.moveColumn(oldIndex, newIndex); + this.grid.fireEvent("columnmove", oldIndex, newIndex); + return true; + } + return false; + } +}); + \ No newline at end of file diff --git a/docs2/src/Roo_grid_PropertyGrid.js.html b/docs2/src/Roo_grid_PropertyGrid.js.html new file mode 100644 index 0000000000..e74d0540f5 --- /dev/null +++ b/docs2/src/Roo_grid_PropertyGrid.js.html @@ -0,0 +1,280 @@ +/home/alan/gitlive/roojs1/Roo/grid/PropertyGrid.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + + +Roo.grid.PropertyRecord = Roo.data.Record.create([ + {name:'name',type:'string'}, 'value' +]); + + +Roo.grid.PropertyStore = function(grid, source){ + this.grid = grid; + this.store = new Roo.data.Store({ + recordType : Roo.grid.PropertyRecord + }); + this.store.on('update', this.onUpdate, this); + if(source){ + this.setSource(source); + } + Roo.grid.PropertyStore.superclass.constructor.call(this); +}; + + + +Roo.extend(Roo.grid.PropertyStore, Roo.util.Observable, { + setSource : function(o){ + this.source = o; + this.store.removeAll(); + var data = []; + for(var k in o){ + if(this.isEditableValue(o[k])){ + data.push(new Roo.grid.PropertyRecord({name: k, value: o[k]}, k)); + } + } + this.store.loadRecords({records: data}, {}, true); + }, + + onUpdate : function(ds, record, type){ + if(type == Roo.data.Record.EDIT){ + var v = record.data['value']; + var oldValue = record.modified['value']; + if(this.grid.fireEvent('beforepropertychange', this.source, record.id, v, oldValue) !== false){ + this.source[record.id] = v; + record.commit(); + this.grid.fireEvent('propertychange', this.source, record.id, v, oldValue); + }else{ + record.reject(); + } + } + }, + + getProperty : function(row){ + return this.store.getAt(row); + }, + + isEditableValue: function(val){ + if(val && val instanceof Date){ + return true; + }else if(typeof val == 'object' || typeof val == 'function'){ + return false; + } + return true; + }, + + setValue : function(prop, value){ + this.source[prop] = value; + this.store.getById(prop).set('value', value); + }, + + getSource : function(){ + return this.source; + } +}); + +Roo.grid.PropertyColumnModel = function(grid, store){ + this.grid = grid; + var g = Roo.grid; + g.PropertyColumnModel.superclass.constructor.call(this, [ + {header: this.nameText, sortable: true, dataIndex:'name', id: 'name'}, + {header: this.valueText, resizable:false, dataIndex: 'value', id: 'value'} + ]); + this.store = store; + this.bselect = Roo.DomHelper.append(document.body, { + tag: 'select', style:'display:none', cls: 'x-grid-editor', children: [ + {tag: 'option', value: 'true', html: 'true'}, + {tag: 'option', value: 'false', html: 'false'} + ] + }); + Roo.id(this.bselect); + var f = Roo.form; + this.editors = { + 'date' : new g.GridEditor(new f.DateField({selectOnFocus:true})), + 'string' : new g.GridEditor(new f.TextField({selectOnFocus:true})), + 'number' : new g.GridEditor(new f.NumberField({selectOnFocus:true, style:'text-align:left;'})), + 'int' : new g.GridEditor(new f.NumberField({selectOnFocus:true, allowDecimals:false, style:'text-align:left;'})), + 'boolean' : new g.GridEditor(new f.Field({el:this.bselect,selectOnFocus:true})) + }; + this.renderCellDelegate = this.renderCell.createDelegate(this); + this.renderPropDelegate = this.renderProp.createDelegate(this); +}; + +Roo.extend(Roo.grid.PropertyColumnModel, Roo.grid.ColumnModel, { + + + nameText : 'Name', + valueText : 'Value', + + dateFormat : 'm/j/Y', + + + renderDate : function(dateVal){ + return dateVal.dateFormat(this.dateFormat); + }, + + renderBool : function(bVal){ + return bVal ? 'true' : 'false'; + }, + + isCellEditable : function(colIndex, rowIndex){ + return colIndex == 1; + }, + + getRenderer : function(col){ + return col == 1 ? + this.renderCellDelegate : this.renderPropDelegate; + }, + + renderProp : function(v){ + return this.getPropertyName(v); + }, + + renderCell : function(val){ + var rv = val; + if(val instanceof Date){ + rv = this.renderDate(val); + }else if(typeof val == 'boolean'){ + rv = this.renderBool(val); + } + return Roo.util.Format.htmlEncode(rv); + }, + + getPropertyName : function(name){ + var pn = this.grid.propertyNames; + return pn && pn[name] ? pn[name] : name; + }, + + getCellEditor : function(colIndex, rowIndex){ + var p = this.store.getProperty(rowIndex); + var n = p.data['name'], val = p.data['value']; + + if(typeof(this.grid.customEditors[n]) == 'string'){ + return this.editors[this.grid.customEditors[n]]; + } + if(typeof(this.grid.customEditors[n]) != 'undefined'){ + return this.grid.customEditors[n]; + } + if(val instanceof Date){ + return this.editors['date']; + }else if(typeof val == 'number'){ + return this.editors['number']; + }else if(typeof val == 'boolean'){ + return this.editors['boolean']; + }else{ + return this.editors['string']; + } + } +}); + +/** + * @class Roo.grid.PropertyGrid + * @extends Roo.grid.EditorGrid + * This class represents the interface of a component based property grid control. + * <br><br>Usage:<pre><code> + var grid = new Roo.grid.PropertyGrid("my-container-id", { + + }); + // set any options + grid.render(); + * </code></pre> + + * @constructor + * @param {String/HTMLElement/Roo.Element} container The element into which this grid will be rendered - + * The container MUST have some type of size defined for the grid to fill. The container will be + * automatically set to position relative if it isn't already. + * @param {Object} config A config object that sets properties on this grid. + */ +Roo.grid.PropertyGrid = function(container, config){ + config = config || {}; + var store = new Roo.grid.PropertyStore(this); + this.store = store; + var cm = new Roo.grid.PropertyColumnModel(this, store); + store.store.sort('name', 'ASC'); + Roo.grid.PropertyGrid.superclass.constructor.call(this, container, Roo.apply({ + ds: store.store, + cm: cm, + enableColLock:false, + enableColumnMove:false, + stripeRows:false, + trackMouseOver: false, + clicksToEdit:1 + }, config)); + this.getGridEl().addClass('x-props-grid'); + this.lastEditRow = null; + this.on('columnresize', this.onColumnResize, this); + this.addEvents({ + /** + * @event beforepropertychange + * Fires before a property changes (return false to stop?) + * @param {Roo.grid.PropertyGrid} grid property grid? (check could be store) + * @param {String} id Record Id + * @param {String} newval New Value + * @param {String} oldval Old Value + */ + "beforepropertychange": true, + /** + * @event propertychange + * Fires after a property changes + * @param {Roo.grid.PropertyGrid} grid property grid? (check could be store) + * @param {String} id Record Id + * @param {String} newval New Value + * @param {String} oldval Old Value + */ + "propertychange": true + }); + this.customEditors = this.customEditors || {}; +}; +Roo.extend(Roo.grid.PropertyGrid, Roo.grid.EditorGrid, { + + /** + * @cfg {Object} customEditors map of colnames=> custom editors. + * the custom editor can be one of the standard ones (date|string|number|int|boolean), or a + * grid editor eg. Roo.grid.GridEditor(new Roo.form.TextArea({selectOnFocus:true})), + * false disables editing of the field. + */ + + /** + * @cfg {Object} propertyNames map of property Names to their displayed value + */ + + render : function(){ + Roo.grid.PropertyGrid.superclass.render.call(this); + this.autoSize.defer(100, this); + }, + + autoSize : function(){ + Roo.grid.PropertyGrid.superclass.autoSize.call(this); + if(this.view){ + this.view.fitColumns(); + } + }, + + onColumnResize : function(){ + this.colModel.setColumnWidth(1, this.container.getWidth(true)-this.colModel.getColumnWidth(0)); + this.autoSize(); + }, + /** + * Sets the data for the Grid + * accepts a Key => Value object of all the elements avaiable. + * @param {Object} data to appear in grid. + */ + setSource : function(source){ + this.store.setSource(source); + //this.autoSize(); + }, + /** + * Gets all the data from the grid. + * @return {Object} data data stored in grid + */ + getSource : function(){ + return this.store.getSource(); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_grid_RowSelectionModel.js.html b/docs2/src/Roo_grid_RowSelectionModel.js.html new file mode 100644 index 0000000000..5ea87857d9 --- /dev/null +++ b/docs2/src/Roo_grid_RowSelectionModel.js.html @@ -0,0 +1,460 @@ +/home/alan/gitlive/roojs1/Roo/grid/RowSelectionModel.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @extends Roo.grid.AbstractSelectionModel + * @class Roo.grid.RowSelectionModel + * The default SelectionModel used by {@link Roo.grid.Grid}. + * It supports multiple selections and keyboard selection/navigation. + * @constructor + * @param {Object} config + */ +Roo.grid.RowSelectionModel = function(config){ + Roo.apply(this, config); + this.selections = new Roo.util.MixedCollection(false, function(o){ + return o.id; + }); + + this.last = false; + this.lastActive = false; + + this.addEvents({ + /** + * @event selectionchange + * Fires when the selection changes + * @param {SelectionModel} this + */ + "selectionchange" : true, + /** + * @event afterselectionchange + * Fires after the selection changes (eg. by key press or clicking) + * @param {SelectionModel} this + */ + "afterselectionchange" : true, + /** + * @event beforerowselect + * Fires when a row is selected being selected, return false to cancel. + * @param {SelectionModel} this + * @param {Number} rowIndex The selected index + * @param {Boolean} keepExisting False if other selections will be cleared + */ + "beforerowselect" : true, + /** + * @event rowselect + * Fires when a row is selected. + * @param {SelectionModel} this + * @param {Number} rowIndex The selected index + * @param {Roo.data.Record} r The record + */ + "rowselect" : true, + /** + * @event rowdeselect + * Fires when a row is deselected. + * @param {SelectionModel} this + * @param {Number} rowIndex The selected index + */ + "rowdeselect" : true + }); + Roo.grid.RowSelectionModel.superclass.constructor.call(this); + this.locked = false; +}; + +Roo.extend(Roo.grid.RowSelectionModel, Roo.grid.AbstractSelectionModel, { + /** + * @cfg {Boolean} singleSelect + * True to allow selection of only one row at a time (defaults to false) + */ + singleSelect : false, + + // private + initEvents : function(){ + + if(!this.grid.enableDragDrop && !this.grid.enableDrag){ + this.grid.on("mousedown", this.handleMouseDown, this); + }else{ // allow click to work like normal + this.grid.on("rowclick", this.handleDragableRowClick, this); + } + + this.rowNav = new Roo.KeyNav(this.grid.getGridEl(), { + "up" : function(e){ + if(!e.shiftKey){ + this.selectPrevious(e.shiftKey); + }else if(this.last !== false && this.lastActive !== false){ + var last = this.last; + this.selectRange(this.last, this.lastActive-1); + this.grid.getView().focusRow(this.lastActive); + if(last !== false){ + this.last = last; + } + }else{ + this.selectFirstRow(); + } + this.fireEvent("afterselectionchange", this); + }, + "down" : function(e){ + if(!e.shiftKey){ + this.selectNext(e.shiftKey); + }else if(this.last !== false && this.lastActive !== false){ + var last = this.last; + this.selectRange(this.last, this.lastActive+1); + this.grid.getView().focusRow(this.lastActive); + if(last !== false){ + this.last = last; + } + }else{ + this.selectFirstRow(); + } + this.fireEvent("afterselectionchange", this); + }, + scope: this + }); + + var view = this.grid.view; + view.on("refresh", this.onRefresh, this); + view.on("rowupdated", this.onRowUpdated, this); + view.on("rowremoved", this.onRemove, this); + }, + + // private + onRefresh : function(){ + var ds = this.grid.dataSource, i, v = this.grid.view; + var s = this.selections; + s.each(function(r){ + if((i = ds.indexOfId(r.id)) != -1){ + v.onRowSelect(i); + s.add(ds.getAt(i)); // updating the selection relate data + }else{ + s.remove(r); + } + }); + }, + + // private + onRemove : function(v, index, r){ + this.selections.remove(r); + }, + + // private + onRowUpdated : function(v, index, r){ + if(this.isSelected(r)){ + v.onRowSelect(index); + } + }, + + /** + * Select records. + * @param {Array} records The records to select + * @param {Boolean} keepExisting (optional) True to keep existing selections + */ + selectRecords : function(records, keepExisting){ + if(!keepExisting){ + this.clearSelections(); + } + var ds = this.grid.dataSource; + for(var i = 0, len = records.length; i < len; i++){ + this.selectRow(ds.indexOf(records[i]), true); + } + }, + + /** + * Gets the number of selected rows. + * @return {Number} + */ + getCount : function(){ + return this.selections.length; + }, + + /** + * Selects the first row in the grid. + */ + selectFirstRow : function(){ + this.selectRow(0); + }, + + /** + * Select the last row. + * @param {Boolean} keepExisting (optional) True to keep existing selections + */ + selectLastRow : function(keepExisting){ + this.selectRow(this.grid.dataSource.getCount() - 1, keepExisting); + }, + + /** + * Selects the row immediately following the last selected row. + * @param {Boolean} keepExisting (optional) True to keep existing selections + */ + selectNext : function(keepExisting){ + if(this.last !== false && (this.last+1) < this.grid.dataSource.getCount()){ + this.selectRow(this.last+1, keepExisting); + this.grid.getView().focusRow(this.last); + } + }, + + /** + * Selects the row that precedes the last selected row. + * @param {Boolean} keepExisting (optional) True to keep existing selections + */ + selectPrevious : function(keepExisting){ + if(this.last){ + this.selectRow(this.last-1, keepExisting); + this.grid.getView().focusRow(this.last); + } + }, + + /** + * Returns the selected records + * @return {Array} Array of selected records + */ + getSelections : function(){ + return [].concat(this.selections.items); + }, + + /** + * Returns the first selected record. + * @return {Record} + */ + getSelected : function(){ + return this.selections.itemAt(0); + }, + + + /** + * Clears all selections. + */ + clearSelections : function(fast){ + if(this.locked) { + return; + } + if(fast !== true){ + var ds = this.grid.dataSource; + var s = this.selections; + s.each(function(r){ + this.deselectRow(ds.indexOfId(r.id)); + }, this); + s.clear(); + }else{ + this.selections.clear(); + } + this.last = false; + }, + + + /** + * Selects all rows. + */ + selectAll : function(){ + if(this.locked) { + return; + } + this.selections.clear(); + for(var i = 0, len = this.grid.dataSource.getCount(); i < len; i++){ + this.selectRow(i, true); + } + }, + + /** + * Returns True if there is a selection. + * @return {Boolean} + */ + hasSelection : function(){ + return this.selections.length > 0; + }, + + /** + * Returns True if the specified row is selected. + * @param {Number/Record} record The record or index of the record to check + * @return {Boolean} + */ + isSelected : function(index){ + var r = typeof index == "number" ? this.grid.dataSource.getAt(index) : index; + return (r && this.selections.key(r.id) ? true : false); + }, + + /** + * Returns True if the specified record id is selected. + * @param {String} id The id of record to check + * @return {Boolean} + */ + isIdSelected : function(id){ + return (this.selections.key(id) ? true : false); + }, + + // private + handleMouseDown : function(e, t){ + var view = this.grid.getView(), rowIndex; + if(this.isLocked() || (rowIndex = view.findRowIndex(t)) === false){ + return; + }; + if(e.shiftKey && this.last !== false){ + var last = this.last; + this.selectRange(last, rowIndex, e.ctrlKey); + this.last = last; // reset the last + view.focusRow(rowIndex); + }else{ + var isSelected = this.isSelected(rowIndex); + if(e.button !== 0 && isSelected){ + view.focusRow(rowIndex); + }else if(e.ctrlKey && isSelected){ + this.deselectRow(rowIndex); + }else if(!isSelected){ + this.selectRow(rowIndex, e.button === 0 && (e.ctrlKey || e.shiftKey)); + view.focusRow(rowIndex); + } + } + this.fireEvent("afterselectionchange", this); + }, + // private + handleDragableRowClick : function(grid, rowIndex, e) + { + if(e.button === 0 && !e.shiftKey && !e.ctrlKey) { + this.selectRow(rowIndex, false); + grid.view.focusRow(rowIndex); + this.fireEvent("afterselectionchange", this); + } + }, + + /** + * Selects multiple rows. + * @param {Array} rows Array of the indexes of the row to select + * @param {Boolean} keepExisting (optional) True to keep existing selections + */ + selectRows : function(rows, keepExisting){ + if(!keepExisting){ + this.clearSelections(); + } + for(var i = 0, len = rows.length; i < len; i++){ + this.selectRow(rows[i], true); + } + }, + + /** + * Selects a range of rows. All rows in between startRow and endRow are also selected. + * @param {Number} startRow The index of the first row in the range + * @param {Number} endRow The index of the last row in the range + * @param {Boolean} keepExisting (optional) True to retain existing selections + */ + selectRange : function(startRow, endRow, keepExisting){ + if(this.locked) { + return; + } + if(!keepExisting){ + this.clearSelections(); + } + if(startRow <= endRow){ + for(var i = startRow; i <= endRow; i++){ + this.selectRow(i, true); + } + }else{ + for(var i = startRow; i >= endRow; i--){ + this.selectRow(i, true); + } + } + }, + + /** + * Deselects a range of rows. All rows in between startRow and endRow are also deselected. + * @param {Number} startRow The index of the first row in the range + * @param {Number} endRow The index of the last row in the range + */ + deselectRange : function(startRow, endRow, preventViewNotify){ + if(this.locked) { + return; + } + for(var i = startRow; i <= endRow; i++){ + this.deselectRow(i, preventViewNotify); + } + }, + + /** + * Selects a row. + * @param {Number} row The index of the row to select + * @param {Boolean} keepExisting (optional) True to keep existing selections + */ + selectRow : function(index, keepExisting, preventViewNotify){ + if(this.locked || (index < 0 || index >= this.grid.dataSource.getCount())) { + return; + } + if(this.fireEvent("beforerowselect", this, index, keepExisting) !== false){ + if(!keepExisting || this.singleSelect){ + this.clearSelections(); + } + var r = this.grid.dataSource.getAt(index); + this.selections.add(r); + this.last = this.lastActive = index; + if(!preventViewNotify){ + this.grid.getView().onRowSelect(index); + } + this.fireEvent("rowselect", this, index, r); + this.fireEvent("selectionchange", this); + } + }, + + /** + * Deselects a row. + * @param {Number} row The index of the row to deselect + */ + deselectRow : function(index, preventViewNotify){ + if(this.locked) { + return; + } + if(this.last == index){ + this.last = false; + } + if(this.lastActive == index){ + this.lastActive = false; + } + var r = this.grid.dataSource.getAt(index); + this.selections.remove(r); + if(!preventViewNotify){ + this.grid.getView().onRowDeselect(index); + } + this.fireEvent("rowdeselect", this, index); + this.fireEvent("selectionchange", this); + }, + + // private + restoreLast : function(){ + if(this._last){ + this.last = this._last; + } + }, + + // private + acceptsNav : function(row, col, cm){ + return !cm.isHidden(col) && cm.isCellEditable(col, row); + }, + + // private + onEditorKey : function(field, e){ + var k = e.getKey(), newCell, g = this.grid, ed = g.activeEditor; + if(k == e.TAB){ + e.stopEvent(); + ed.completeEdit(); + if(e.shiftKey){ + newCell = g.walkCells(ed.row, ed.col-1, -1, this.acceptsNav, this); + }else{ + newCell = g.walkCells(ed.row, ed.col+1, 1, this.acceptsNav, this); + } + }else if(k == e.ENTER && !e.ctrlKey){ + e.stopEvent(); + ed.completeEdit(); + if(e.shiftKey){ + newCell = g.walkCells(ed.row-1, ed.col, -1, this.acceptsNav, this); + }else{ + newCell = g.walkCells(ed.row+1, ed.col, 1, this.acceptsNav, this); + } + }else if(k == e.ESC){ + ed.cancelEdit(); + } + if(newCell){ + g.startEditing(newCell[0], newCell[1]); + } + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_grid_SplitDragZone.js.html b/docs2/src/Roo_grid_SplitDragZone.js.html new file mode 100644 index 0000000000..95d63b7681 --- /dev/null +++ b/docs2/src/Roo_grid_SplitDragZone.js.html @@ -0,0 +1,67 @@ +/home/alan/gitlive/roojs1/Roo/grid/SplitDragZone.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +// private +// This is a support class used internally by the Grid components +Roo.grid.SplitDragZone = function(grid, hd, hd2){ + this.grid = grid; + this.view = grid.getView(); + this.proxy = this.view.resizeProxy; + Roo.grid.SplitDragZone.superclass.constructor.call(this, hd, + "gridSplitters" + this.grid.getGridEl().id, { + dragElId : Roo.id(this.proxy.dom), resizeFrame:false + }); + this.setHandleElId(Roo.id(hd)); + this.setOuterHandleElId(Roo.id(hd2)); + this.scroll = false; +}; +Roo.extend(Roo.grid.SplitDragZone, Roo.dd.DDProxy, { + fly: Roo.Element.fly, + + b4StartDrag : function(x, y){ + this.view.headersDisabled = true; + this.proxy.setHeight(this.view.mainWrap.getHeight()); + var w = this.cm.getColumnWidth(this.cellIndex); + var minw = Math.max(w-this.grid.minColumnWidth, 0); + this.resetConstraints(); + this.setXConstraint(minw, 1000); + this.setYConstraint(0, 0); + this.minX = x - minw; + this.maxX = x + 1000; + this.startPos = x; + Roo.dd.DDProxy.prototype.b4StartDrag.call(this, x, y); + }, + + + handleMouseDown : function(e){ + ev = Roo.EventObject.setEvent(e); + var t = this.fly(ev.getTarget()); + if(t.hasClass("x-grid-split")){ + this.cellIndex = this.view.getCellIndex(t.dom); + this.split = t.dom; + this.cm = this.grid.colModel; + if(this.cm.isResizable(this.cellIndex) && !this.cm.isFixed(this.cellIndex)){ + Roo.grid.SplitDragZone.superclass.handleMouseDown.apply(this, arguments); + } + } + }, + + endDrag : function(e){ + this.view.headersDisabled = false; + var endX = Math.max(this.minX, Roo.lib.Event.getPageX(e)); + var diff = endX - this.startPos; + this.view.onColumnSplitterMoved(this.cellIndex, this.cm.getColumnWidth(this.cellIndex)+diff); + }, + + autoOffset : function(){ + this.setDelta(0,0); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_lib_Ajax.js.html b/docs2/src/Roo_lib_Ajax.js.html new file mode 100644 index 0000000000..1df6abe225 --- /dev/null +++ b/docs2/src/Roo_lib_Ajax.js.html @@ -0,0 +1,485 @@ +/home/alan/gitlive/roojs1/Roo/lib/Ajax.js/* + * Portions of this file are based on pieces of Yahoo User Interface Library + * Copyright (c) 2007, Yahoo! Inc. All rights reserved. + * YUI licensed under the BSD License: + * http://developer.yahoo.net/yui/license.txt + * <script type="text/javascript"> + * + */ + +(function() { + /** + * @class Roo.lib.Ajax + * + */ + Roo.lib.Ajax = { + /** + * @static + */ + request : function(method, uri, cb, data, options) { + if(options){ + var hs = options.headers; + if(hs){ + for(var h in hs){ + if(hs.hasOwnProperty(h)){ + this.initHeader(h, hs[h], false); + } + } + } + if(options.xmlData){ + this.initHeader('Content-Type', 'text/xml', false); + method = 'POST'; + data = options.xmlData; + } + } + + return this.asyncRequest(method, uri, cb, data); + }, + + serializeForm : function(form) { + if(typeof form == 'string') { + form = (document.getElementById(form) || document.forms[form]); + } + + var el, name, val, disabled, data = '', hasSubmit = false; + for (var i = 0; i < form.elements.length; i++) { + el = form.elements[i]; + disabled = form.elements[i].disabled; + name = form.elements[i].name; + val = form.elements[i].value; + + if (!disabled && name){ + switch (el.type) + { + case 'select-one': + case 'select-multiple': + for (var j = 0; j < el.options.length; j++) { + if (el.options[j].selected) { + if (Roo.isIE) { + data += Roo.encodeURIComponent(name) + '=' + Roo.encodeURIComponent(el.options[j].attributes['value'].specified ? el.options[j].value : el.options[j].text) + '&'; + } + else { + data += Roo.encodeURIComponent(name) + '=' + Roo.encodeURIComponent(el.options[j].hasAttribute('value') ? el.options[j].value : el.options[j].text) + '&'; + } + } + } + break; + case 'radio': + case 'checkbox': + if (el.checked) { + data += Roo.encodeURIComponent(name) + '=' + Roo.encodeURIComponent(val) + '&'; + } + break; + case 'file': + + case undefined: + + case 'reset': + + case 'button': + + break; + case 'submit': + if(hasSubmit == false) { + data += Roo.encodeURIComponent(name) + '=' + Roo.encodeURIComponent(val) + '&'; + hasSubmit = true; + } + break; + default: + data += Roo.encodeURIComponent(name) + '=' + Roo.encodeURIComponent(val) + '&'; + break; + } + } + } + data = data.substr(0, data.length - 1); + return data; + }, + + headers:{}, + + hasHeaders:false, + + useDefaultHeader:true, + + defaultPostHeader:'application/x-www-form-urlencoded', + + useDefaultXhrHeader:true, + + defaultXhrHeader:'XMLHttpRequest', + + hasDefaultHeaders:true, + + defaultHeaders:{}, + + poll:{}, + + timeout:{}, + + pollInterval:50, + + transactionId:0, + + setProgId:function(id) + { + this.activeX.unshift(id); + }, + + setDefaultPostHeader:function(b) + { + this.useDefaultHeader = b; + }, + + setDefaultXhrHeader:function(b) + { + this.useDefaultXhrHeader = b; + }, + + setPollingInterval:function(i) + { + if (typeof i == 'number' && isFinite(i)) { + this.pollInterval = i; + } + }, + + createXhrObject:function(transactionId) + { + var obj,http; + try + { + + http = new XMLHttpRequest(); + + obj = { conn:http, tId:transactionId }; + } + catch(e) + { + for (var i = 0; i < this.activeX.length; ++i) { + try + { + + http = new ActiveXObject(this.activeX[i]); + + obj = { conn:http, tId:transactionId }; + break; + } + catch(e) { + } + } + } + finally + { + return obj; + } + }, + + getConnectionObject:function() + { + var o; + var tId = this.transactionId; + + try + { + o = this.createXhrObject(tId); + if (o) { + this.transactionId++; + } + } + catch(e) { + } + finally + { + return o; + } + }, + + asyncRequest:function(method, uri, callback, postData) + { + var o = this.getConnectionObject(); + + if (!o) { + return null; + } + else { + o.conn.open(method, uri, true); + + if (this.useDefaultXhrHeader) { + if (!this.defaultHeaders['X-Requested-With']) { + this.initHeader('X-Requested-With', this.defaultXhrHeader, true); + } + } + + if(postData && this.useDefaultHeader){ + this.initHeader('Content-Type', this.defaultPostHeader); + } + + if (this.hasDefaultHeaders || this.hasHeaders) { + this.setHeader(o); + } + + this.handleReadyState(o, callback); + o.conn.send(postData || null); + + return o; + } + }, + + handleReadyState:function(o, callback) + { + var oConn = this; + + if (callback && callback.timeout) { + + this.timeout[o.tId] = window.setTimeout(function() { + oConn.abort(o, callback, true); + }, callback.timeout); + } + + this.poll[o.tId] = window.setInterval( + function() { + if (o.conn && o.conn.readyState == 4) { + window.clearInterval(oConn.poll[o.tId]); + delete oConn.poll[o.tId]; + + if(callback && callback.timeout) { + window.clearTimeout(oConn.timeout[o.tId]); + delete oConn.timeout[o.tId]; + } + + oConn.handleTransactionResponse(o, callback); + } + } + , this.pollInterval); + }, + + handleTransactionResponse:function(o, callback, isAbort) + { + + if (!callback) { + this.releaseObject(o); + return; + } + + var httpStatus, responseObject; + + try + { + if (o.conn.status !== undefined && o.conn.status != 0) { + httpStatus = o.conn.status; + } + else { + httpStatus = 13030; + } + } + catch(e) { + + + httpStatus = 13030; + } + + if (httpStatus >= 200 && httpStatus < 300) { + responseObject = this.createResponseObject(o, callback.argument); + if (callback.success) { + if (!callback.scope) { + callback.success(responseObject); + } + else { + + + callback.success.apply(callback.scope, [responseObject]); + } + } + } + else { + switch (httpStatus) { + + case 12002: + case 12029: + case 12030: + case 12031: + case 12152: + case 13030: + responseObject = this.createExceptionObject(o.tId, callback.argument, (isAbort ? isAbort : false)); + if (callback.failure) { + if (!callback.scope) { + callback.failure(responseObject); + } + else { + callback.failure.apply(callback.scope, [responseObject]); + } + } + break; + default: + responseObject = this.createResponseObject(o, callback.argument); + if (callback.failure) { + if (!callback.scope) { + callback.failure(responseObject); + } + else { + callback.failure.apply(callback.scope, [responseObject]); + } + } + } + } + + this.releaseObject(o); + responseObject = null; + }, + + createResponseObject:function(o, callbackArg) + { + var obj = {}; + var headerObj = {}; + + try + { + var headerStr = o.conn.getAllResponseHeaders(); + var header = headerStr.split('\n'); + for (var i = 0; i < header.length; i++) { + var delimitPos = header[i].indexOf(':'); + if (delimitPos != -1) { + headerObj[header[i].substring(0, delimitPos)] = header[i].substring(delimitPos + 2); + } + } + } + catch(e) { + } + + obj.tId = o.tId; + obj.status = o.conn.status; + obj.statusText = o.conn.statusText; + obj.getResponseHeader = headerObj; + obj.getAllResponseHeaders = headerStr; + obj.responseText = o.conn.responseText; + obj.responseXML = o.conn.responseXML; + + if (typeof callbackArg !== undefined) { + obj.argument = callbackArg; + } + + return obj; + }, + + createExceptionObject:function(tId, callbackArg, isAbort) + { + var COMM_CODE = 0; + var COMM_ERROR = 'communication failure'; + var ABORT_CODE = -1; + var ABORT_ERROR = 'transaction aborted'; + + var obj = {}; + + obj.tId = tId; + if (isAbort) { + obj.status = ABORT_CODE; + obj.statusText = ABORT_ERROR; + } + else { + obj.status = COMM_CODE; + obj.statusText = COMM_ERROR; + } + + if (callbackArg) { + obj.argument = callbackArg; + } + + return obj; + }, + + initHeader:function(label, value, isDefault) + { + var headerObj = (isDefault) ? this.defaultHeaders : this.headers; + + if (headerObj[label] === undefined) { + headerObj[label] = value; + } + else { + + + headerObj[label] = value + "," + headerObj[label]; + } + + if (isDefault) { + this.hasDefaultHeaders = true; + } + else { + this.hasHeaders = true; + } + }, + + + setHeader:function(o) + { + if (this.hasDefaultHeaders) { + for (var prop in this.defaultHeaders) { + if (this.defaultHeaders.hasOwnProperty(prop)) { + o.conn.setRequestHeader(prop, this.defaultHeaders[prop]); + } + } + } + + if (this.hasHeaders) { + for (var prop in this.headers) { + if (this.headers.hasOwnProperty(prop)) { + o.conn.setRequestHeader(prop, this.headers[prop]); + } + } + this.headers = {}; + this.hasHeaders = false; + } + }, + + resetDefaultHeaders:function() { + delete this.defaultHeaders; + this.defaultHeaders = {}; + this.hasDefaultHeaders = false; + }, + + abort:function(o, callback, isTimeout) + { + if(this.isCallInProgress(o)) { + o.conn.abort(); + window.clearInterval(this.poll[o.tId]); + delete this.poll[o.tId]; + if (isTimeout) { + delete this.timeout[o.tId]; + } + + this.handleTransactionResponse(o, callback, true); + + return true; + } + else { + return false; + } + }, + + + isCallInProgress:function(o) + { + if (o && o.conn) { + return o.conn.readyState != 4 && o.conn.readyState != 0; + } + else { + + return false; + } + }, + + + releaseObject:function(o) + { + + o.conn = null; + + o = null; + }, + + activeX:[ + 'MSXML2.XMLHTTP.3.0', + 'MSXML2.XMLHTTP', + 'Microsoft.XMLHTTP' + ] + + + }; +})(); \ No newline at end of file diff --git a/docs2/src/Roo_lib_Anim.js.html b/docs2/src/Roo_lib_Anim.js.html new file mode 100644 index 0000000000..4b95121f20 --- /dev/null +++ b/docs2/src/Roo_lib_Anim.js.html @@ -0,0 +1,37 @@ +/home/alan/gitlive/roojs1/Roo/lib/Anim.js/* + * Portions of this file are based on pieces of Yahoo User Interface Library + * Copyright (c) 2007, Yahoo! Inc. All rights reserved. + * YUI licensed under the BSD License: + * http://developer.yahoo.net/yui/license.txt + * <script type="text/javascript"> + * + */ + +(function() { + + Roo.lib.Anim = { + scroll : function(el, args, duration, easing, cb, scope) { + this.run(el, args, duration, easing, cb, scope, Roo.lib.Scroll); + }, + + motion : function(el, args, duration, easing, cb, scope) { + this.run(el, args, duration, easing, cb, scope, Roo.lib.Motion); + }, + + color : function(el, args, duration, easing, cb, scope) { + this.run(el, args, duration, easing, cb, scope, Roo.lib.ColorAnim); + }, + + run : function(el, args, duration, easing, cb, scope, type) { + type = type || Roo.lib.AnimBase; + if (typeof easing == "string") { + easing = Roo.lib.Easing[easing]; + } + var anim = new type(el, args, duration, easing); + anim.animateX(function() { + Roo.callback(cb, scope); + }); + return anim; + } + }; +})(); \ No newline at end of file diff --git a/docs2/src/Roo_lib_AnimBase.js.html b/docs2/src/Roo_lib_AnimBase.js.html new file mode 100644 index 0000000000..44427c47bf --- /dev/null +++ b/docs2/src/Roo_lib_AnimBase.js.html @@ -0,0 +1,289 @@ +/home/alan/gitlive/roojs1/Roo/lib/AnimBase.js/* + * Portions of this file are based on pieces of Yahoo User Interface Library + * Copyright (c) 2007, Yahoo! Inc. All rights reserved. + * YUI licensed under the BSD License: + * http://developer.yahoo.net/yui/license.txt + * <script type="text/javascript"> + * + */ + +(function() { + var libFlyweight; + + function fly(el) { + if (!libFlyweight) { + libFlyweight = new Roo.Element.Flyweight(); + } + libFlyweight.dom = el; + return libFlyweight; + } + + // since this uses fly! - it cant be in DOM (which does not have fly yet..) + + + + Roo.lib.AnimBase = function(el, attributes, duration, method) { + if (el) { + this.init(el, attributes, duration, method); + } + }; + + Roo.lib.AnimBase.fly = fly; + + + + Roo.lib.AnimBase.prototype = { + + toString: function() { + var el = this.getEl(); + var id = el.id || el.tagName; + return ("Anim " + id); + }, + + patterns: { + noNegatives: /width|height|opacity|padding/i, + offsetAttribute: /^((width|height)|(top|left))$/, + defaultUnit: /width|height|top$|bottom$|left$|right$/i, + offsetUnit: /\d+(em|%|en|ex|pt|in|cm|mm|pc)$/i + }, + + + doMethod: function(attr, start, end) { + return this.method(this.currentFrame, start, end - start, this.totalFrames); + }, + + + setAttribute: function(attr, val, unit) { + if (this.patterns.noNegatives.test(attr)) { + val = (val > 0) ? val : 0; + } + + Roo.fly(this.getEl(), '_anim').setStyle(attr, val + unit); + }, + + + getAttribute: function(attr) { + var el = this.getEl(); + var val = fly(el).getStyle(attr); + + if (val !== 'auto' && !this.patterns.offsetUnit.test(val)) { + return parseFloat(val); + } + + var a = this.patterns.offsetAttribute.exec(attr) || []; + var pos = !!( a[3] ); + var box = !!( a[2] ); + + + if (box || (fly(el).getStyle('position') == 'absolute' && pos)) { + val = el['offset' + a[0].charAt(0).toUpperCase() + a[0].substr(1)]; + } else { + val = 0; + } + + return val; + }, + + + getDefaultUnit: function(attr) { + if (this.patterns.defaultUnit.test(attr)) { + return 'px'; + } + + return ''; + }, + + animateX : function(callback, scope) { + var f = function() { + this.onComplete.removeListener(f); + if (typeof callback == "function") { + callback.call(scope || this, this); + } + }; + this.onComplete.addListener(f, this); + this.animate(); + }, + + + setRuntimeAttribute: function(attr) { + var start; + var end; + var attributes = this.attributes; + + this.runtimeAttributes[attr] = {}; + + var isset = function(prop) { + return (typeof prop !== 'undefined'); + }; + + if (!isset(attributes[attr]['to']) && !isset(attributes[attr]['by'])) { + return false; + } + + start = ( isset(attributes[attr]['from']) ) ? attributes[attr]['from'] : this.getAttribute(attr); + + + if (isset(attributes[attr]['to'])) { + end = attributes[attr]['to']; + } else if (isset(attributes[attr]['by'])) { + if (start.constructor == Array) { + end = []; + for (var i = 0, len = start.length; i < len; ++i) { + end[i] = start[i] + attributes[attr]['by'][i]; + } + } else { + end = start + attributes[attr]['by']; + } + } + + this.runtimeAttributes[attr].start = start; + this.runtimeAttributes[attr].end = end; + + + this.runtimeAttributes[attr].unit = ( isset(attributes[attr].unit) ) ? attributes[attr]['unit'] : this.getDefaultUnit(attr); + }, + + + init: function(el, attributes, duration, method) { + + var isAnimated = false; + + + var startTime = null; + + + var actualFrames = 0; + + + el = Roo.getDom(el); + + + this.attributes = attributes || {}; + + + this.duration = duration || 1; + + + this.method = method || Roo.lib.Easing.easeNone; + + + this.useSeconds = true; + + + this.currentFrame = 0; + + + this.totalFrames = Roo.lib.AnimMgr.fps; + + + this.getEl = function() { + return el; + }; + + + this.isAnimated = function() { + return isAnimated; + }; + + + this.getStartTime = function() { + return startTime; + }; + + this.runtimeAttributes = {}; + + + this.animate = function() { + if (this.isAnimated()) { + return false; + } + + this.currentFrame = 0; + + this.totalFrames = ( this.useSeconds ) ? Math.ceil(Roo.lib.AnimMgr.fps * this.duration) : this.duration; + + Roo.lib.AnimMgr.registerElement(this); + }; + + + this.stop = function(finish) { + if (finish) { + this.currentFrame = this.totalFrames; + this._onTween.fire(); + } + Roo.lib.AnimMgr.stop(this); + }; + + var onStart = function() { + this.onStart.fire(); + + this.runtimeAttributes = {}; + for (var attr in this.attributes) { + this.setRuntimeAttribute(attr); + } + + isAnimated = true; + actualFrames = 0; + startTime = new Date(); + }; + + + var onTween = function() { + var data = { + duration: new Date() - this.getStartTime(), + currentFrame: this.currentFrame + }; + + data.toString = function() { + return ( + 'duration: ' + data.duration + + ', currentFrame: ' + data.currentFrame + ); + }; + + this.onTween.fire(data); + + var runtimeAttributes = this.runtimeAttributes; + + for (var attr in runtimeAttributes) { + this.setAttribute(attr, this.doMethod(attr, runtimeAttributes[attr].start, runtimeAttributes[attr].end), runtimeAttributes[attr].unit); + } + + actualFrames += 1; + }; + + var onComplete = function() { + var actual_duration = (new Date() - startTime) / 1000 ; + + var data = { + duration: actual_duration, + frames: actualFrames, + fps: actualFrames / actual_duration + }; + + data.toString = function() { + return ( + 'duration: ' + data.duration + + ', frames: ' + data.frames + + ', fps: ' + data.fps + ); + }; + + isAnimated = false; + actualFrames = 0; + this.onComplete.fire(data); + }; + + + this._onStart = new Roo.util.Event(this); + this.onStart = new Roo.util.Event(this); + this.onTween = new Roo.util.Event(this); + this._onTween = new Roo.util.Event(this); + this.onComplete = new Roo.util.Event(this); + this._onComplete = new Roo.util.Event(this); + this._onStart.addListener(onStart); + this._onTween.addListener(onTween); + this._onComplete.addListener(onComplete); + } + }; +})(); \ No newline at end of file diff --git a/docs2/src/Roo_lib_AnimMgr.js.html b/docs2/src/Roo_lib_AnimMgr.js.html new file mode 100644 index 0000000000..b5a7da523c --- /dev/null +++ b/docs2/src/Roo_lib_AnimMgr.js.html @@ -0,0 +1,131 @@ +/home/alan/gitlive/roojs1/Roo/lib/AnimMgr.js +/* + * Portions of this file are based on pieces of Yahoo User Interface Library + * Copyright (c) 2007, Yahoo! Inc. All rights reserved. + * YUI licensed under the BSD License: + * http://developer.yahoo.net/yui/license.txt + * <script type="text/javascript"> + * + */ + +Roo.lib.AnimMgr = new function() { + + var thread = null; + + + var queue = []; + + + var tweenCount = 0; + + + this.fps = 1000; + + + this.delay = 1; + + + this.registerElement = function(tween) { + queue[queue.length] = tween; + tweenCount += 1; + tween._onStart.fire(); + this.start(); + }; + + + this.unRegister = function(tween, index) { + tween._onComplete.fire(); + index = index || getIndex(tween); + if (index != -1) { + queue.splice(index, 1); + } + + tweenCount -= 1; + if (tweenCount <= 0) { + this.stop(); + } + }; + + + this.start = function() { + if (thread === null) { + thread = setInterval(this.run, this.delay); + } + }; + + + this.stop = function(tween) { + if (!tween) { + clearInterval(thread); + + for (var i = 0, len = queue.length; i < len; ++i) { + if (queue[0].isAnimated()) { + this.unRegister(queue[0], 0); + } + } + + queue = []; + thread = null; + tweenCount = 0; + } + else { + this.unRegister(tween); + } + }; + + + this.run = function() { + for (var i = 0, len = queue.length; i < len; ++i) { + var tween = queue[i]; + if (!tween || !tween.isAnimated()) { + continue; + } + + if (tween.currentFrame < tween.totalFrames || tween.totalFrames === null) + { + tween.currentFrame += 1; + + if (tween.useSeconds) { + correctFrame(tween); + } + tween._onTween.fire(); + } + else { + Roo.lib.AnimMgr.stop(tween, i); + } + } + }; + + var getIndex = function(anim) { + for (var i = 0, len = queue.length; i < len; ++i) { + if (queue[i] == anim) { + return i; + } + } + return -1; + }; + + + var correctFrame = function(tween) { + var frames = tween.totalFrames; + var frame = tween.currentFrame; + var expected = (tween.currentFrame * tween.duration * 1000 / tween.totalFrames); + var elapsed = (new Date() - tween.getStartTime()); + var tweak = 0; + + if (elapsed < tween.duration * 1000) { + tweak = Math.round((elapsed / expected - 1) * tween.currentFrame); + } else { + tweak = frames - (frame + 1); + } + if (tweak > 0 && isFinite(tweak)) { + if (tween.currentFrame + tweak >= frames) { + tweak = frames - (frame + 1); + } + + tween.currentFrame += tweak; + } + }; +}; + + \ No newline at end of file diff --git a/docs2/src/Roo_lib_Beizer.js.html b/docs2/src/Roo_lib_Beizer.js.html new file mode 100644 index 0000000000..35576661df --- /dev/null +++ b/docs2/src/Roo_lib_Beizer.js.html @@ -0,0 +1,29 @@ +/home/alan/gitlive/roojs1/Roo/lib/Beizer.js/* + * Portions of this file are based on pieces of Yahoo User Interface Library + * Copyright (c) 2007, Yahoo! Inc. All rights reserved. + * YUI licensed under the BSD License: + * http://developer.yahoo.net/yui/license.txt + * <script type="text/javascript"> + * + */ +Roo.lib.Bezier = new function() { + + this.getPosition = function(points, t) { + var n = points.length; + var tmp = []; + + for (var i = 0; i < n; ++i) { + tmp[i] = [points[i][0], points[i][1]]; + } + + for (var j = 1; j < n; ++j) { + for (i = 0; i < n - j; ++i) { + tmp[i][0] = (1 - t) * tmp[i][0] + t * tmp[parseInt(i + 1, 10)][0]; + tmp[i][1] = (1 - t) * tmp[i][1] + t * tmp[parseInt(i + 1, 10)][1]; + } + } + + return [ tmp[0][0], tmp[0][1] ]; + + }; + }; \ No newline at end of file diff --git a/docs2/src/Roo_lib_ColorAnim.js.html b/docs2/src/Roo_lib_ColorAnim.js.html new file mode 100644 index 0000000000..56f1a09349 --- /dev/null +++ b/docs2/src/Roo_lib_ColorAnim.js.html @@ -0,0 +1,145 @@ +/home/alan/gitlive/roojs1/Roo/lib/ColorAnim.js/* + * Portions of this file are based on pieces of Yahoo User Interface Library + * Copyright (c) 2007, Yahoo! Inc. All rights reserved. + * YUI licensed under the BSD License: + * http://developer.yahoo.net/yui/license.txt + * <script type="text/javascript"> + * + */ +(function() { + + Roo.lib.ColorAnim = function(el, attributes, duration, method) { + Roo.lib.ColorAnim.superclass.constructor.call(this, el, attributes, duration, method); + }; + + Roo.extend(Roo.lib.ColorAnim, Roo.lib.AnimBase); + + var fly = Roo.lib.AnimBase.fly; + var Y = Roo.lib; + var superclass = Y.ColorAnim.superclass; + var proto = Y.ColorAnim.prototype; + + proto.toString = function() { + var el = this.getEl(); + var id = el.id || el.tagName; + return ("ColorAnim " + id); + }; + + proto.patterns.color = /color$/i; + proto.patterns.rgb = /^rgb\(([0-9]+)\s*,\s*([0-9]+)\s*,\s*([0-9]+)\)$/i; + proto.patterns.hex = /^#?([0-9A-F]{2})([0-9A-F]{2})([0-9A-F]{2})$/i; + proto.patterns.hex3 = /^#?([0-9A-F]{1})([0-9A-F]{1})([0-9A-F]{1})$/i; + proto.patterns.transparent = /^transparent|rgba\(0, 0, 0, 0\)$/; + + + proto.parseColor = function(s) { + if (s.length == 3) { + return s; + } + + var c = this.patterns.hex.exec(s); + if (c && c.length == 4) { + return [ parseInt(c[1], 16), parseInt(c[2], 16), parseInt(c[3], 16) ]; + } + + c = this.patterns.rgb.exec(s); + if (c && c.length == 4) { + return [ parseInt(c[1], 10), parseInt(c[2], 10), parseInt(c[3], 10) ]; + } + + c = this.patterns.hex3.exec(s); + if (c && c.length == 4) { + return [ parseInt(c[1] + c[1], 16), parseInt(c[2] + c[2], 16), parseInt(c[3] + c[3], 16) ]; + } + + return null; + }; + // since this uses fly! - it cant be in ColorAnim (which does not have fly yet..) + proto.getAttribute = function(attr) { + var el = this.getEl(); + if (this.patterns.color.test(attr)) { + var val = fly(el).getStyle(attr); + + if (this.patterns.transparent.test(val)) { + var parent = el.parentNode; + val = fly(parent).getStyle(attr); + + while (parent && this.patterns.transparent.test(val)) { + parent = parent.parentNode; + val = fly(parent).getStyle(attr); + if (parent.tagName.toUpperCase() == 'HTML') { + val = '#fff'; + } + } + } + } else { + val = superclass.getAttribute.call(this, attr); + } + + return val; + }; + proto.getAttribute = function(attr) { + var el = this.getEl(); + if (this.patterns.color.test(attr)) { + var val = fly(el).getStyle(attr); + + if (this.patterns.transparent.test(val)) { + var parent = el.parentNode; + val = fly(parent).getStyle(attr); + + while (parent && this.patterns.transparent.test(val)) { + parent = parent.parentNode; + val = fly(parent).getStyle(attr); + if (parent.tagName.toUpperCase() == 'HTML') { + val = '#fff'; + } + } + } + } else { + val = superclass.getAttribute.call(this, attr); + } + + return val; + }; + + proto.doMethod = function(attr, start, end) { + var val; + + if (this.patterns.color.test(attr)) { + val = []; + for (var i = 0, len = start.length; i < len; ++i) { + val[i] = superclass.doMethod.call(this, attr, start[i], end[i]); + } + + val = 'rgb(' + Math.floor(val[0]) + ',' + Math.floor(val[1]) + ',' + Math.floor(val[2]) + ')'; + } + else { + val = superclass.doMethod.call(this, attr, start, end); + } + + return val; + }; + + proto.setRuntimeAttribute = function(attr) { + superclass.setRuntimeAttribute.call(this, attr); + + if (this.patterns.color.test(attr)) { + var attributes = this.attributes; + var start = this.parseColor(this.runtimeAttributes[attr].start); + var end = this.parseColor(this.runtimeAttributes[attr].end); + + if (typeof attributes[attr]['to'] === 'undefined' && typeof attributes[attr]['by'] !== 'undefined') { + end = this.parseColor(attributes[attr].by); + + for (var i = 0, len = start.length; i < len; ++i) { + end[i] = start[i] + end[i]; + } + } + + this.runtimeAttributes[attr].start = start; + this.runtimeAttributes[attr].end = end; + } + }; +})(); + + \ No newline at end of file diff --git a/docs2/src/Roo_lib_Dom.js.html b/docs2/src/Roo_lib_Dom.js.html new file mode 100644 index 0000000000..40c53a7013 --- /dev/null +++ b/docs2/src/Roo_lib_Dom.js.html @@ -0,0 +1,199 @@ +/home/alan/gitlive/roojs1/Roo/lib/Dom.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.lib.Dom + * @static + * + * Dom utils (from YIU afaik) + * + **/ +Roo.lib.Dom = { + /** + * Get the view width + * @param {Boolean} full True will get the full document, otherwise it's the view width + * @return {Number} The width + */ + + getViewWidth : function(full) { + return full ? this.getDocumentWidth() : this.getViewportWidth(); + }, + /** + * Get the view height + * @param {Boolean} full True will get the full document, otherwise it's the view height + * @return {Number} The height + */ + getViewHeight : function(full) { + return full ? this.getDocumentHeight() : this.getViewportHeight(); + }, + + getDocumentHeight: function() { + var scrollHeight = (document.compatMode != "CSS1Compat") ? document.body.scrollHeight : document.documentElement.scrollHeight; + return Math.max(scrollHeight, this.getViewportHeight()); + }, + + getDocumentWidth: function() { + var scrollWidth = (document.compatMode != "CSS1Compat") ? document.body.scrollWidth : document.documentElement.scrollWidth; + return Math.max(scrollWidth, this.getViewportWidth()); + }, + + getViewportHeight: function() { + var height = self.innerHeight; + var mode = document.compatMode; + + if ((mode || Roo.isIE) && !Roo.isOpera) { + height = (mode == "CSS1Compat") ? + document.documentElement.clientHeight : + document.body.clientHeight; + } + + return height; + }, + + getViewportWidth: function() { + var width = self.innerWidth; + var mode = document.compatMode; + + if (mode || Roo.isIE) { + width = (mode == "CSS1Compat") ? + document.documentElement.clientWidth : + document.body.clientWidth; + } + return width; + }, + + isAncestor : function(p, c) { + p = Roo.getDom(p); + c = Roo.getDom(c); + if (!p || !c) { + return false; + } + + if (p.contains && !Roo.isSafari) { + return p.contains(c); + } else if (p.compareDocumentPosition) { + return !!(p.compareDocumentPosition(c) & 16); + } else { + var parent = c.parentNode; + while (parent) { + if (parent == p) { + return true; + } + else if (!parent.tagName || parent.tagName.toUpperCase() == "HTML") { + return false; + } + parent = parent.parentNode; + } + return false; + } + }, + + getRegion : function(el) { + return Roo.lib.Region.getRegion(el); + }, + + getY : function(el) { + return this.getXY(el)[1]; + }, + + getX : function(el) { + return this.getXY(el)[0]; + }, + + getXY : function(el) { + var p, pe, b, scroll, bd = document.body; + el = Roo.getDom(el); + var fly = Roo.lib.AnimBase.fly; + if (el.getBoundingClientRect) { + b = el.getBoundingClientRect(); + scroll = fly(document).getScroll(); + return [b.left + scroll.left, b.top + scroll.top]; + } + var x = 0, y = 0; + + p = el; + + var hasAbsolute = fly(el).getStyle("position") == "absolute"; + + while (p) { + + x += p.offsetLeft; + y += p.offsetTop; + + if (!hasAbsolute && fly(p).getStyle("position") == "absolute") { + hasAbsolute = true; + } + + if (Roo.isGecko) { + pe = fly(p); + + var bt = parseInt(pe.getStyle("borderTopWidth"), 10) || 0; + var bl = parseInt(pe.getStyle("borderLeftWidth"), 10) || 0; + + + x += bl; + y += bt; + + + if (p != el && pe.getStyle('overflow') != 'visible') { + x += bl; + y += bt; + } + } + p = p.offsetParent; + } + + if (Roo.isSafari && hasAbsolute) { + x -= bd.offsetLeft; + y -= bd.offsetTop; + } + + if (Roo.isGecko && !hasAbsolute) { + var dbd = fly(bd); + x += parseInt(dbd.getStyle("borderLeftWidth"), 10) || 0; + y += parseInt(dbd.getStyle("borderTopWidth"), 10) || 0; + } + + p = el.parentNode; + while (p && p != bd) { + if (!Roo.isOpera || (p.tagName != 'TR' && fly(p).getStyle("display") != "inline")) { + x -= p.scrollLeft; + y -= p.scrollTop; + } + p = p.parentNode; + } + return [x, y]; + }, + + + + + setXY : function(el, xy) { + el = Roo.fly(el, '_setXY'); + el.position(); + var pts = el.translatePoints(xy); + if (xy[0] !== false) { + el.dom.style.left = pts.left + "px"; + } + if (xy[1] !== false) { + el.dom.style.top = pts.top + "px"; + } + }, + + setX : function(el, x) { + this.setXY(el, [x, false]); + }, + + setY : function(el, y) { + this.setXY(el, [false, y]); + } +}; + \ No newline at end of file diff --git a/docs2/src/Roo_lib_Easing.js.html b/docs2/src/Roo_lib_Easing.js.html new file mode 100644 index 0000000000..c738fb42ee --- /dev/null +++ b/docs2/src/Roo_lib_Easing.js.html @@ -0,0 +1,184 @@ +/home/alan/gitlive/roojs1/Roo/lib/Easing.js/* + * Portions of this file are based on pieces of Yahoo User Interface Library + * Copyright (c) 2007, Yahoo! Inc. All rights reserved. + * YUI licensed under the BSD License: + * http://developer.yahoo.net/yui/license.txt + * <script type="text/javascript"> + * + */ +Roo.lib.Easing = { + + + easeNone: function (t, b, c, d) { + return c * t / d + b; + }, + + + easeIn: function (t, b, c, d) { + return c * (t /= d) * t + b; + }, + + + easeOut: function (t, b, c, d) { + return -c * (t /= d) * (t - 2) + b; + }, + + + easeBoth: function (t, b, c, d) { + if ((t /= d / 2) < 1) { + return c / 2 * t * t + b; + } + + return -c / 2 * ((--t) * (t - 2) - 1) + b; + }, + + + easeInStrong: function (t, b, c, d) { + return c * (t /= d) * t * t * t + b; + }, + + + easeOutStrong: function (t, b, c, d) { + return -c * ((t = t / d - 1) * t * t * t - 1) + b; + }, + + + easeBothStrong: function (t, b, c, d) { + if ((t /= d / 2) < 1) { + return c / 2 * t * t * t * t + b; + } + + return -c / 2 * ((t -= 2) * t * t * t - 2) + b; + }, + + + + elasticIn: function (t, b, c, d, a, p) { + if (t == 0) { + return b; + } + if ((t /= d) == 1) { + return b + c; + } + if (!p) { + p = d * .3; + } + + if (!a || a < Math.abs(c)) { + a = c; + var s = p / 4; + } + else { + var s = p / (2 * Math.PI) * Math.asin(c / a); + } + + return -(a * Math.pow(2, 10 * (t -= 1)) * Math.sin((t * d - s) * (2 * Math.PI) / p)) + b; + }, + + + elasticOut: function (t, b, c, d, a, p) { + if (t == 0) { + return b; + } + if ((t /= d) == 1) { + return b + c; + } + if (!p) { + p = d * .3; + } + + if (!a || a < Math.abs(c)) { + a = c; + var s = p / 4; + } + else { + var s = p / (2 * Math.PI) * Math.asin(c / a); + } + + return a * Math.pow(2, -10 * t) * Math.sin((t * d - s) * (2 * Math.PI) / p) + c + b; + }, + + + elasticBoth: function (t, b, c, d, a, p) { + if (t == 0) { + return b; + } + + if ((t /= d / 2) == 2) { + return b + c; + } + + if (!p) { + p = d * (.3 * 1.5); + } + + if (!a || a < Math.abs(c)) { + a = c; + var s = p / 4; + } + else { + var s = p / (2 * Math.PI) * Math.asin(c / a); + } + + if (t < 1) { + return -.5 * (a * Math.pow(2, 10 * (t -= 1)) * + Math.sin((t * d - s) * (2 * Math.PI) / p)) + b; + } + return a * Math.pow(2, -10 * (t -= 1)) * + Math.sin((t * d - s) * (2 * Math.PI) / p) * .5 + c + b; + }, + + + + backIn: function (t, b, c, d, s) { + if (typeof s == 'undefined') { + s = 1.70158; + } + return c * (t /= d) * t * ((s + 1) * t - s) + b; + }, + + + backOut: function (t, b, c, d, s) { + if (typeof s == 'undefined') { + s = 1.70158; + } + return c * ((t = t / d - 1) * t * ((s + 1) * t + s) + 1) + b; + }, + + + backBoth: function (t, b, c, d, s) { + if (typeof s == 'undefined') { + s = 1.70158; + } + + if ((t /= d / 2 ) < 1) { + return c / 2 * (t * t * (((s *= (1.525)) + 1) * t - s)) + b; + } + return c / 2 * ((t -= 2) * t * (((s *= (1.525)) + 1) * t + s) + 2) + b; + }, + + + bounceIn: function (t, b, c, d) { + return c - Roo.lib.Easing.bounceOut(d - t, 0, c, d) + b; + }, + + + bounceOut: function (t, b, c, d) { + if ((t /= d) < (1 / 2.75)) { + return c * (7.5625 * t * t) + b; + } else if (t < (2 / 2.75)) { + return c * (7.5625 * (t -= (1.5 / 2.75)) * t + .75) + b; + } else if (t < (2.5 / 2.75)) { + return c * (7.5625 * (t -= (2.25 / 2.75)) * t + .9375) + b; + } + return c * (7.5625 * (t -= (2.625 / 2.75)) * t + .984375) + b; + }, + + + bounceBoth: function (t, b, c, d) { + if (t < d / 2) { + return Roo.lib.Easing.bounceIn(t * 2, 0, c, d) * .5 + b; + } + return Roo.lib.Easing.bounceOut(t * 2 - d, 0, c, d) * .5 + c * .5 + b; + } +}; \ No newline at end of file diff --git a/docs2/src/Roo_lib_Event.js.html b/docs2/src/Roo_lib_Event.js.html new file mode 100644 index 0000000000..cf8109e5ac --- /dev/null +++ b/docs2/src/Roo_lib_Event.js.html @@ -0,0 +1,526 @@ +/home/alan/gitlive/roojs1/Roo/lib/Event.js/* + * Portions of this file are based on pieces of Yahoo User Interface Library + * Copyright (c) 2007, Yahoo! Inc. All rights reserved. + * YUI licensed under the BSD License: + * http://developer.yahoo.net/yui/license.txt + * <script type="text/javascript"> + * + */ + +Roo.lib.Event = function() { + var loadComplete = false; + var listeners = []; + var unloadListeners = []; + var retryCount = 0; + var onAvailStack = []; + var counter = 0; + var lastError = null; + + return { + POLL_RETRYS: 200, + POLL_INTERVAL: 20, + EL: 0, + TYPE: 1, + FN: 2, + WFN: 3, + OBJ: 3, + ADJ_SCOPE: 4, + _interval: null, + + startInterval: function() { + if (!this._interval) { + var self = this; + var callback = function() { + self._tryPreloadAttach(); + }; + this._interval = setInterval(callback, this.POLL_INTERVAL); + + } + }, + + onAvailable: function(p_id, p_fn, p_obj, p_override) { + onAvailStack.push({ id: p_id, + fn: p_fn, + obj: p_obj, + override: p_override, + checkReady: false }); + + retryCount = this.POLL_RETRYS; + this.startInterval(); + }, + + + addListener: function(el, eventName, fn) { + el = Roo.getDom(el); + if (!el || !fn) { + return false; + } + + if ("unload" == eventName) { + unloadListeners[unloadListeners.length] = + [el, eventName, fn]; + return true; + } + + var wrappedFn = function(e) { + return fn(Roo.lib.Event.getEvent(e)); + }; + + var li = [el, eventName, fn, wrappedFn]; + + var index = listeners.length; + listeners[index] = li; + + this.doAdd(el, eventName, wrappedFn, false); + return true; + + }, + + + removeListener: function(el, eventName, fn) { + var i, len; + + el = Roo.getDom(el); + + if(!fn) { + return this.purgeElement(el, false, eventName); + } + + + if ("unload" == eventName) { + + for (i = 0,len = unloadListeners.length; i < len; i++) { + var li = unloadListeners[i]; + if (li && + li[0] == el && + li[1] == eventName && + li[2] == fn) { + unloadListeners.splice(i, 1); + return true; + } + } + + return false; + } + + var cacheItem = null; + + + var index = arguments[3]; + + if ("undefined" == typeof index) { + index = this._getCacheIndex(el, eventName, fn); + } + + if (index >= 0) { + cacheItem = listeners[index]; + } + + if (!el || !cacheItem) { + return false; + } + + this.doRemove(el, eventName, cacheItem[this.WFN], false); + + delete listeners[index][this.WFN]; + delete listeners[index][this.FN]; + listeners.splice(index, 1); + + return true; + + }, + + + getTarget: function(ev, resolveTextNode) { + ev = ev.browserEvent || ev; + ev = ev.touches ? (ev.touches[0] || ev.changedTouches[0] || ev ) : ev; + var t = ev.target || ev.srcElement; + return this.resolveTextNode(t); + }, + + + resolveTextNode: function(node) { + if (Roo.isSafari && node && 3 == node.nodeType) { + return node.parentNode; + } else { + return node; + } + }, + + + getPageX: function(ev) { + ev = ev.browserEvent || ev; + ev = ev.touches ? (ev.touches[0] || ev.changedTouches[0] || ev ) : ev; + var x = ev.pageX; + if (!x && 0 !== x) { + x = ev.clientX || 0; + + if (Roo.isIE) { + x += this.getScroll()[1]; + } + } + + return x; + }, + + + getPageY: function(ev) { + ev = ev.browserEvent || ev; + ev = ev.touches ? (ev.touches[0] || ev.changedTouches[0] || ev ) : ev; + var y = ev.pageY; + if (!y && 0 !== y) { + y = ev.clientY || 0; + + if (Roo.isIE) { + y += this.getScroll()[0]; + } + } + + + return y; + }, + + + getXY: function(ev) { + ev = ev.browserEvent || ev; + ev = ev.touches ? (ev.touches[0] || ev.changedTouches[0] || ev ) : ev; + return [this.getPageX(ev), this.getPageY(ev)]; + }, + + + getRelatedTarget: function(ev) { + ev = ev.browserEvent || ev; + ev = ev.touches ? (ev.touches[0] || ev.changedTouches[0] || ev ) : ev; + var t = ev.relatedTarget; + if (!t) { + if (ev.type == "mouseout") { + t = ev.toElement; + } else if (ev.type == "mouseover") { + t = ev.fromElement; + } + } + + return this.resolveTextNode(t); + }, + + + getTime: function(ev) { + ev = ev.browserEvent || ev; + ev = ev.touches ? (ev.touches[0] || ev.changedTouches[0] || ev ) : ev; + if (!ev.time) { + var t = new Date().getTime(); + try { + ev.time = t; + } catch(ex) { + this.lastError = ex; + return t; + } + } + + return ev.time; + }, + + + stopEvent: function(ev) { + this.stopPropagation(ev); + this.preventDefault(ev); + }, + + + stopPropagation: function(ev) { + ev = ev.browserEvent || ev; + if (ev.stopPropagation) { + ev.stopPropagation(); + } else { + ev.cancelBubble = true; + } + }, + + + preventDefault: function(ev) { + ev = ev.browserEvent || ev; + if(ev.preventDefault) { + ev.preventDefault(); + } else { + ev.returnValue = false; + } + }, + + + getEvent: function(e) { + var ev = e || window.event; + if (!ev) { + var c = this.getEvent.caller; + while (c) { + ev = c.arguments[0]; + if (ev && Event == ev.constructor) { + break; + } + c = c.caller; + } + } + return ev; + }, + + + getCharCode: function(ev) { + ev = ev.browserEvent || ev; + return ev.charCode || ev.keyCode || 0; + }, + + + _getCacheIndex: function(el, eventName, fn) { + for (var i = 0,len = listeners.length; i < len; ++i) { + var li = listeners[i]; + if (li && + li[this.FN] == fn && + li[this.EL] == el && + li[this.TYPE] == eventName) { + return i; + } + } + + return -1; + }, + + + elCache: {}, + + + getEl: function(id) { + return document.getElementById(id); + }, + + + clearCache: function() { + }, + + + _load: function(e) { + loadComplete = true; + var EU = Roo.lib.Event; + + + if (Roo.isIE) { + EU.doRemove(window, "load", EU._load); + } + }, + + + _tryPreloadAttach: function() { + + if (this.locked) { + return false; + } + + this.locked = true; + + + var tryAgain = !loadComplete; + if (!tryAgain) { + tryAgain = (retryCount > 0); + } + + + var notAvail = []; + for (var i = 0,len = onAvailStack.length; i < len; ++i) { + var item = onAvailStack[i]; + if (item) { + var el = this.getEl(item.id); + + if (el) { + if (!item.checkReady || + loadComplete || + el.nextSibling || + (document && document.body)) { + + var scope = el; + if (item.override) { + if (item.override === true) { + scope = item.obj; + } else { + scope = item.override; + } + } + item.fn.call(scope, item.obj); + onAvailStack[i] = null; + } + } else { + notAvail.push(item); + } + } + } + + retryCount = (notAvail.length === 0) ? 0 : retryCount - 1; + + if (tryAgain) { + + this.startInterval(); + } else { + clearInterval(this._interval); + this._interval = null; + } + + this.locked = false; + + return true; + + }, + + + purgeElement: function(el, recurse, eventName) { + var elListeners = this.getListeners(el, eventName); + if (elListeners) { + for (var i = 0,len = elListeners.length; i < len; ++i) { + var l = elListeners[i]; + this.removeListener(el, l.type, l.fn); + } + } + + if (recurse && el && el.childNodes) { + for (i = 0,len = el.childNodes.length; i < len; ++i) { + this.purgeElement(el.childNodes[i], recurse, eventName); + } + } + }, + + + getListeners: function(el, eventName) { + var results = [], searchLists; + if (!eventName) { + searchLists = [listeners, unloadListeners]; + } else if (eventName == "unload") { + searchLists = [unloadListeners]; + } else { + searchLists = [listeners]; + } + + for (var j = 0; j < searchLists.length; ++j) { + var searchList = searchLists[j]; + if (searchList && searchList.length > 0) { + for (var i = 0,len = searchList.length; i < len; ++i) { + var l = searchList[i]; + if (l && l[this.EL] === el && + (!eventName || eventName === l[this.TYPE])) { + results.push({ + type: l[this.TYPE], + fn: l[this.FN], + obj: l[this.OBJ], + adjust: l[this.ADJ_SCOPE], + index: i + }); + } + } + } + } + + return (results.length) ? results : null; + }, + + + _unload: function(e) { + + var EU = Roo.lib.Event, i, j, l, len, index; + + for (i = 0,len = unloadListeners.length; i < len; ++i) { + l = unloadListeners[i]; + if (l) { + var scope = window; + if (l[EU.ADJ_SCOPE]) { + if (l[EU.ADJ_SCOPE] === true) { + scope = l[EU.OBJ]; + } else { + scope = l[EU.ADJ_SCOPE]; + } + } + l[EU.FN].call(scope, EU.getEvent(e), l[EU.OBJ]); + unloadListeners[i] = null; + l = null; + scope = null; + } + } + + unloadListeners = null; + + if (listeners && listeners.length > 0) { + j = listeners.length; + while (j) { + index = j - 1; + l = listeners[index]; + if (l) { + EU.removeListener(l[EU.EL], l[EU.TYPE], + l[EU.FN], index); + } + j = j - 1; + } + l = null; + + EU.clearCache(); + } + + EU.doRemove(window, "unload", EU._unload); + + }, + + + getScroll: function() { + var dd = document.documentElement, db = document.body; + if (dd && (dd.scrollTop || dd.scrollLeft)) { + return [dd.scrollTop, dd.scrollLeft]; + } else if (db) { + return [db.scrollTop, db.scrollLeft]; + } else { + return [0, 0]; + } + }, + + + doAdd: function () { + if (window.addEventListener) { + return function(el, eventName, fn, capture) { + el.addEventListener(eventName, fn, (capture)); + }; + } else if (window.attachEvent) { + return function(el, eventName, fn, capture) { + el.attachEvent("on" + eventName, fn); + }; + } else { + return function() { + }; + } + }(), + + + doRemove: function() { + if (window.removeEventListener) { + return function (el, eventName, fn, capture) { + el.removeEventListener(eventName, fn, (capture)); + }; + } else if (window.detachEvent) { + return function (el, eventName, fn) { + el.detachEvent("on" + eventName, fn); + }; + } else { + return function() { + }; + } + }() + }; + +}(); +(function() { + + var E = Roo.lib.Event; + E.on = E.addListener; + E.un = E.removeListener; + + if (document && document.body) { + E._load(); + } else { + E.doAdd(window, "load", E._load); + } + E.doAdd(window, "unload", E._unload); + E._tryPreloadAttach(); +})(); + + \ No newline at end of file diff --git a/docs2/src/Roo_lib_Motion.js.html b/docs2/src/Roo_lib_Motion.js.html new file mode 100644 index 0000000000..dc1814a31d --- /dev/null +++ b/docs2/src/Roo_lib_Motion.js.html @@ -0,0 +1,138 @@ +/home/alan/gitlive/roojs1/Roo/lib/Motion.js/* + * Portions of this file are based on pieces of Yahoo User Interface Library + * Copyright (c) 2007, Yahoo! Inc. All rights reserved. + * YUI licensed under the BSD License: + * http://developer.yahoo.net/yui/license.txt + * <script type="text/javascript"> + * + */ + (function() { + Roo.lib.Motion = function(el, attributes, duration, method) { + if (el) { + Roo.lib.Motion.superclass.constructor.call(this, el, attributes, duration, method); + } + }; + + Roo.extend(Roo.lib.Motion, Roo.lib.ColorAnim); + + + var Y = Roo.lib; + var superclass = Y.Motion.superclass; + var proto = Y.Motion.prototype; + + proto.toString = function() { + var el = this.getEl(); + var id = el.id || el.tagName; + return ("Motion " + id); + }; + + proto.patterns.points = /^points$/i; + + proto.setAttribute = function(attr, val, unit) { + if (this.patterns.points.test(attr)) { + unit = unit || 'px'; + superclass.setAttribute.call(this, 'left', val[0], unit); + superclass.setAttribute.call(this, 'top', val[1], unit); + } else { + superclass.setAttribute.call(this, attr, val, unit); + } + }; + + proto.getAttribute = function(attr) { + if (this.patterns.points.test(attr)) { + var val = [ + superclass.getAttribute.call(this, 'left'), + superclass.getAttribute.call(this, 'top') + ]; + } else { + val = superclass.getAttribute.call(this, attr); + } + + return val; + }; + + proto.doMethod = function(attr, start, end) { + var val = null; + + if (this.patterns.points.test(attr)) { + var t = this.method(this.currentFrame, 0, 100, this.totalFrames) / 100; + val = Y.Bezier.getPosition(this.runtimeAttributes[attr], t); + } else { + val = superclass.doMethod.call(this, attr, start, end); + } + return val; + }; + + proto.setRuntimeAttribute = function(attr) { + if (this.patterns.points.test(attr)) { + var el = this.getEl(); + var attributes = this.attributes; + var start; + var control = attributes['points']['control'] || []; + var end; + var i, len; + + if (control.length > 0 && !(control[0] instanceof Array)) { + control = [control]; + } else { + var tmp = []; + for (i = 0,len = control.length; i < len; ++i) { + tmp[i] = control[i]; + } + control = tmp; + } + + Roo.fly(el).position(); + + if (isset(attributes['points']['from'])) { + Roo.lib.Dom.setXY(el, attributes['points']['from']); + } + else { + Roo.lib.Dom.setXY(el, Roo.lib.Dom.getXY(el)); + } + + start = this.getAttribute('points'); + + + if (isset(attributes['points']['to'])) { + end = translateValues.call(this, attributes['points']['to'], start); + + var pageXY = Roo.lib.Dom.getXY(this.getEl()); + for (i = 0,len = control.length; i < len; ++i) { + control[i] = translateValues.call(this, control[i], start); + } + + + } else if (isset(attributes['points']['by'])) { + end = [ start[0] + attributes['points']['by'][0], start[1] + attributes['points']['by'][1] ]; + + for (i = 0,len = control.length; i < len; ++i) { + control[i] = [ start[0] + control[i][0], start[1] + control[i][1] ]; + } + } + + this.runtimeAttributes[attr] = [start]; + + if (control.length > 0) { + this.runtimeAttributes[attr] = this.runtimeAttributes[attr].concat(control); + } + + this.runtimeAttributes[attr][this.runtimeAttributes[attr].length] = end; + } + else { + superclass.setRuntimeAttribute.call(this, attr); + } + }; + + var translateValues = function(val, start) { + var pageXY = Roo.lib.Dom.getXY(this.getEl()); + val = [ val[0] - pageXY[0] + start[0], val[1] - pageXY[1] + start[1] ]; + + return val; + }; + + var isset = function(prop) { + return (typeof prop !== 'undefined'); + }; + })(); + \ No newline at end of file diff --git a/docs2/src/Roo_lib_Point.js.html b/docs2/src/Roo_lib_Point.js.html new file mode 100644 index 0000000000..f40c1b8147 --- /dev/null +++ b/docs2/src/Roo_lib_Point.js.html @@ -0,0 +1,22 @@ +/home/alan/gitlive/roojs1/Roo/lib/Point.js/* + * Portions of this file are based on pieces of Yahoo User Interface Library + * Copyright (c) 2007, Yahoo! Inc. All rights reserved. + * YUI licensed under the BSD License: + * http://developer.yahoo.net/yui/license.txt + * <script type="text/javascript"> + * + */ +//@@dep Roo.lib.Region + + +Roo.lib.Point = function(x, y) { + if (x instanceof Array) { + y = x[1]; + x = x[0]; + } + this.x = this.right = this.left = this[0] = x; + this.y = this.top = this.bottom = this[1] = y; +}; + +Roo.lib.Point.prototype = new Roo.lib.Region(); + \ No newline at end of file diff --git a/docs2/src/Roo_lib_Region.js.html b/docs2/src/Roo_lib_Region.js.html new file mode 100644 index 0000000000..229edf3612 --- /dev/null +++ b/docs2/src/Roo_lib_Region.js.html @@ -0,0 +1,73 @@ +/home/alan/gitlive/roojs1/Roo/lib/Region.js/* + * Portions of this file are based on pieces of Yahoo User Interface Library + * Copyright (c) 2007, Yahoo! Inc. All rights reserved. + * YUI licensed under the BSD License: + * http://developer.yahoo.net/yui/license.txt + * <script type="text/javascript"> + * + */ + +Roo.lib.Region = function(t, r, b, l) { + this.top = t; + this[1] = t; + this.right = r; + this.bottom = b; + this.left = l; + this[0] = l; +}; + + +Roo.lib.Region.prototype = { + contains : function(region) { + return ( region.left >= this.left && + region.right <= this.right && + region.top >= this.top && + region.bottom <= this.bottom ); + + }, + + getArea : function() { + return ( (this.bottom - this.top) * (this.right - this.left) ); + }, + + intersect : function(region) { + var t = Math.max(this.top, region.top); + var r = Math.min(this.right, region.right); + var b = Math.min(this.bottom, region.bottom); + var l = Math.max(this.left, region.left); + + if (b >= t && r >= l) { + return new Roo.lib.Region(t, r, b, l); + } else { + return null; + } + }, + union : function(region) { + var t = Math.min(this.top, region.top); + var r = Math.max(this.right, region.right); + var b = Math.max(this.bottom, region.bottom); + var l = Math.min(this.left, region.left); + + return new Roo.lib.Region(t, r, b, l); + }, + + adjust : function(t, l, b, r) { + this.top += t; + this.left += l; + this.right += r; + this.bottom += b; + return this; + } +}; + +Roo.lib.Region.getRegion = function(el) { + var p = Roo.lib.Dom.getXY(el); + + var t = p[1]; + var r = p[0] + el.offsetWidth; + var b = p[1] + el.offsetHeight; + var l = p[0]; + + return new Roo.lib.Region(t, r, b, l); +}; + \ No newline at end of file diff --git a/docs2/src/Roo_lib_Scroll.js.html b/docs2/src/Roo_lib_Scroll.js.html new file mode 100644 index 0000000000..5b5b308995 --- /dev/null +++ b/docs2/src/Roo_lib_Scroll.js.html @@ -0,0 +1,68 @@ +/home/alan/gitlive/roojs1/Roo/lib/Scroll.js/* + * Portions of this file are based on pieces of Yahoo User Interface Library + * Copyright (c) 2007, Yahoo! Inc. All rights reserved. + * YUI licensed under the BSD License: + * http://developer.yahoo.net/yui/license.txt + * <script type="text/javascript"> + * + */ + (function() { + Roo.lib.Scroll = function(el, attributes, duration, method) { + if (el) { + Roo.lib.Scroll.superclass.constructor.call(this, el, attributes, duration, method); + } + }; + + Roo.extend(Roo.lib.Scroll, Roo.lib.ColorAnim); + + + var Y = Roo.lib; + var superclass = Y.Scroll.superclass; + var proto = Y.Scroll.prototype; + + proto.toString = function() { + var el = this.getEl(); + var id = el.id || el.tagName; + return ("Scroll " + id); + }; + + proto.doMethod = function(attr, start, end) { + var val = null; + + if (attr == 'scroll') { + val = [ + this.method(this.currentFrame, start[0], end[0] - start[0], this.totalFrames), + this.method(this.currentFrame, start[1], end[1] - start[1], this.totalFrames) + ]; + + } else { + val = superclass.doMethod.call(this, attr, start, end); + } + return val; + }; + + proto.getAttribute = function(attr) { + var val = null; + var el = this.getEl(); + + if (attr == 'scroll') { + val = [ el.scrollLeft, el.scrollTop ]; + } else { + val = superclass.getAttribute.call(this, attr); + } + + return val; + }; + + proto.setAttribute = function(attr, val, unit) { + var el = this.getEl(); + + if (attr == 'scroll') { + el.scrollLeft = val[0]; + el.scrollTop = val[1]; + } else { + superclass.setAttribute.call(this, attr, val, unit); + } + }; + })(); + \ No newline at end of file diff --git a/docs2/src/Roo_menu_Adapter.js.html b/docs2/src/Roo_menu_Adapter.js.html new file mode 100644 index 0000000000..0def690ce0 --- /dev/null +++ b/docs2/src/Roo_menu_Adapter.js.html @@ -0,0 +1,61 @@ +/home/alan/gitlive/roojs1/Roo/menu/Adapter.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.menu.Adapter + * @extends Roo.menu.BaseItem + * A base utility class that adapts a non-menu component so that it can be wrapped by a menu item and added to a menu. + * It provides basic rendering, activation management and enable/disable logic required to work in menus. + * @constructor + * Creates a new Adapter + * @param {Object} config Configuration options + */ +Roo.menu.Adapter = function(component, config){ + Roo.menu.Adapter.superclass.constructor.call(this, config); + this.component = component; +}; +Roo.extend(Roo.menu.Adapter, Roo.menu.BaseItem, { + // private + canActivate : true, + + // private + onRender : function(container, position){ + this.component.render(container); + this.el = this.component.getEl(); + }, + + // private + activate : function(){ + if(this.disabled){ + return false; + } + this.component.focus(); + this.fireEvent("activate", this); + return true; + }, + + // private + deactivate : function(){ + this.fireEvent("deactivate", this); + }, + + // private + disable : function(){ + this.component.disable(); + Roo.menu.Adapter.superclass.disable.call(this); + }, + + // private + enable : function(){ + this.component.enable(); + Roo.menu.Adapter.superclass.enable.call(this); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_menu_BaseItem.js.html b/docs2/src/Roo_menu_BaseItem.js.html new file mode 100644 index 0000000000..4ef72defb3 --- /dev/null +++ b/docs2/src/Roo_menu_BaseItem.js.html @@ -0,0 +1,148 @@ +/home/alan/gitlive/roojs1/Roo/menu/BaseItem.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.menu.BaseItem + * @extends Roo.Component + * The base class for all items that render into menus. BaseItem provides default rendering, activated state + * management and base configuration options shared by all menu components. + * @constructor + * Creates a new BaseItem + * @param {Object} config Configuration options + */ +Roo.menu.BaseItem = function(config){ + Roo.menu.BaseItem.superclass.constructor.call(this, config); + + this.addEvents({ + /** + * @event click + * Fires when this item is clicked + * @param {Roo.menu.BaseItem} this + * @param {Roo.EventObject} e + */ + click: true, + /** + * @event activate + * Fires when this item is activated + * @param {Roo.menu.BaseItem} this + */ + activate : true, + /** + * @event deactivate + * Fires when this item is deactivated + * @param {Roo.menu.BaseItem} this + */ + deactivate : true + }); + + if(this.handler){ + this.on("click", this.handler, this.scope, true); + } +}; + +Roo.extend(Roo.menu.BaseItem, Roo.Component, { + /** + * @cfg {Function} handler + * A function that will handle the click event of this menu item (defaults to undefined) + */ + /** + * @cfg {Boolean} canActivate True if this item can be visually activated (defaults to false) + */ + canActivate : false, + + /** + * @cfg {Boolean} hidden True to prevent creation of this menu item (defaults to false) + */ + hidden: false, + + /** + * @cfg {String} activeClass The CSS class to use when the item becomes activated (defaults to "x-menu-item-active") + */ + activeClass : "x-menu-item-active", + /** + * @cfg {Boolean} hideOnClick True to hide the containing menu after this item is clicked (defaults to true) + */ + hideOnClick : true, + /** + * @cfg {Number} hideDelay Length of time in milliseconds to wait before hiding after a click (defaults to 100) + */ + hideDelay : 100, + + // private + ctype: "Roo.menu.BaseItem", + + // private + actionMode : "container", + + // private + render : function(container, parentMenu){ + this.parentMenu = parentMenu; + Roo.menu.BaseItem.superclass.render.call(this, container); + this.container.menuItemId = this.id; + }, + + // private + onRender : function(container, position){ + this.el = Roo.get(this.el); + container.dom.appendChild(this.el.dom); + }, + + // private + onClick : function(e){ + if(!this.disabled && this.fireEvent("click", this, e) !== false + && this.parentMenu.fireEvent("itemclick", this, e) !== false){ + this.handleClick(e); + }else{ + e.stopEvent(); + } + }, + + // private + activate : function(){ + if(this.disabled){ + return false; + } + var li = this.container; + li.addClass(this.activeClass); + this.region = li.getRegion().adjust(2, 2, -2, -2); + this.fireEvent("activate", this); + return true; + }, + + // private + deactivate : function(){ + this.container.removeClass(this.activeClass); + this.fireEvent("deactivate", this); + }, + + // private + shouldDeactivate : function(e){ + return !this.region || !this.region.contains(e.getPoint()); + }, + + // private + handleClick : function(e){ + if(this.hideOnClick){ + this.parentMenu.hide.defer(this.hideDelay, this.parentMenu, [true]); + } + }, + + // private + expandMenu : function(autoActivate){ + // do nothing + }, + + // private + hideMenu : function(){ + // do nothing + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_menu_CheckItem.js.html b/docs2/src/Roo_menu_CheckItem.js.html new file mode 100644 index 0000000000..240fa406f2 --- /dev/null +++ b/docs2/src/Roo_menu_CheckItem.js.html @@ -0,0 +1,112 @@ +/home/alan/gitlive/roojs1/Roo/menu/CheckItem.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.menu.CheckItem + * @extends Roo.menu.Item + * Adds a menu item that contains a checkbox by default, but can also be part of a radio group. + * @constructor + * Creates a new CheckItem + * @param {Object} config Configuration options + */ +Roo.menu.CheckItem = function(config){ + Roo.menu.CheckItem.superclass.constructor.call(this, config); + this.addEvents({ + /** + * @event beforecheckchange + * Fires before the checked value is set, providing an opportunity to cancel if needed + * @param {Roo.menu.CheckItem} this + * @param {Boolean} checked The new checked value that will be set + */ + "beforecheckchange" : true, + /** + * @event checkchange + * Fires after the checked value has been set + * @param {Roo.menu.CheckItem} this + * @param {Boolean} checked The checked value that was set + */ + "checkchange" : true + }); + if(this.checkHandler){ + this.on('checkchange', this.checkHandler, this.scope); + } +}; +Roo.extend(Roo.menu.CheckItem, Roo.menu.Item, { + /** + * @cfg {String} group + * All check items with the same group name will automatically be grouped into a single-select + * radio button group (defaults to '') + */ + /** + * @cfg {String} itemCls The default CSS class to use for check items (defaults to "x-menu-item x-menu-check-item") + */ + itemCls : "x-menu-item x-menu-check-item", + /** + * @cfg {String} groupClass The default CSS class to use for radio group check items (defaults to "x-menu-group-item") + */ + groupClass : "x-menu-group-item", + + /** + * @cfg {Boolean} checked True to initialize this checkbox as checked (defaults to false). Note that + * if this checkbox is part of a radio group (group = true) only the last item in the group that is + * initialized with checked = true will be rendered as checked. + */ + checked: false, + + // private + ctype: "Roo.menu.CheckItem", + + // private + onRender : function(c){ + Roo.menu.CheckItem.superclass.onRender.apply(this, arguments); + if(this.group){ + this.el.addClass(this.groupClass); + } + Roo.menu.MenuMgr.registerCheckable(this); + if(this.checked){ + this.checked = false; + this.setChecked(true, true); + } + }, + + // private + destroy : function(){ + if(this.rendered){ + Roo.menu.MenuMgr.unregisterCheckable(this); + } + Roo.menu.CheckItem.superclass.destroy.apply(this, arguments); + }, + + /** + * Set the checked state of this item + * @param {Boolean} checked The new checked value + * @param {Boolean} suppressEvent (optional) True to prevent the checkchange event from firing (defaults to false) + */ + setChecked : function(state, suppressEvent){ + if(this.checked != state && this.fireEvent("beforecheckchange", this, state) !== false){ + if(this.container){ + this.container[state ? "addClass" : "removeClass"]("x-menu-item-checked"); + } + this.checked = state; + if(suppressEvent !== true){ + this.fireEvent("checkchange", this, state); + } + } + }, + + // private + handleClick : function(e){ + if(!this.disabled && !(this.checked && this.group)){// disable unselect on radio item + this.setChecked(!this.checked); + } + Roo.menu.CheckItem.superclass.handleClick.apply(this, arguments); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_menu_ColorItem.js.html b/docs2/src/Roo_menu_ColorItem.js.html new file mode 100644 index 0000000000..0583d73ac1 --- /dev/null +++ b/docs2/src/Roo_menu_ColorItem.js.html @@ -0,0 +1,29 @@ +/home/alan/gitlive/roojs1/Roo/menu/ColorItem.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.menu.ColorItem + * @extends Roo.menu.Adapter + * A menu item that wraps the {@link Roo.ColorPalette} component. + * @constructor + * Creates a new ColorItem + * @param {Object} config Configuration options + */ +Roo.menu.ColorItem = function(config){ + Roo.menu.ColorItem.superclass.constructor.call(this, new Roo.ColorPalette(config), config); + /** The Roo.ColorPalette object @type Roo.ColorPalette */ + this.palette = this.component; + this.relayEvents(this.palette, ["select"]); + if(this.selectHandler){ + this.on('select', this.selectHandler, this.scope); + } +}; +Roo.extend(Roo.menu.ColorItem, Roo.menu.Adapter); \ No newline at end of file diff --git a/docs2/src/Roo_menu_ColorMenu.js.html b/docs2/src/Roo_menu_ColorMenu.js.html new file mode 100644 index 0000000000..4336addcea --- /dev/null +++ b/docs2/src/Roo_menu_ColorMenu.js.html @@ -0,0 +1,38 @@ +/home/alan/gitlive/roojs1/Roo/menu/ColorMenu.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.menu.ColorMenu + * @extends Roo.menu.Menu + * A menu containing a {@link Roo.menu.ColorItem} component (which provides a basic color picker). + * @constructor + * Creates a new ColorMenu + * @param {Object} config Configuration options + */ +Roo.menu.ColorMenu = function(config){ + Roo.menu.ColorMenu.superclass.constructor.call(this, config); + this.plain = true; + var ci = new Roo.menu.ColorItem(config); + this.add(ci); + /** + * The {@link Roo.ColorPalette} instance for this ColorMenu + * @type ColorPalette + */ + this.palette = ci.palette; + /** + * @event select + * @param {ColorPalette} palette + * @param {String} color + */ + this.relayEvents(ci, ["select"]); +}; +Roo.extend(Roo.menu.ColorMenu, Roo.menu.Menu); \ No newline at end of file diff --git a/docs2/src/Roo_menu_DateItem.js.html b/docs2/src/Roo_menu_DateItem.js.html new file mode 100644 index 0000000000..8f81072c72 --- /dev/null +++ b/docs2/src/Roo_menu_DateItem.js.html @@ -0,0 +1,40 @@ +/home/alan/gitlive/roojs1/Roo/menu/DateItem.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.menu.DateItem + * @extends Roo.menu.Adapter + * A menu item that wraps the {@link Roo.DatPicker} component. + * @constructor + * Creates a new DateItem + * @param {Object} config Configuration options + */ +Roo.menu.DateItem = function(config){ + Roo.menu.DateItem.superclass.constructor.call(this, new Roo.DatePicker(config), config); + /** The Roo.DatePicker object @type Roo.DatePicker */ + this.picker = this.component; + this.addEvents({select: true}); + + this.picker.on("render", function(picker){ + picker.getEl().swallowEvent("click"); + picker.container.addClass("x-menu-date-item"); + }); + + this.picker.on("select", this.onSelect, this); +}; + +Roo.extend(Roo.menu.DateItem, Roo.menu.Adapter, { + // private + onSelect : function(picker, date){ + this.fireEvent("select", this, date, picker); + Roo.menu.DateItem.superclass.handleClick.call(this); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_menu_DateMenu.js.html b/docs2/src/Roo_menu_DateMenu.js.html new file mode 100644 index 0000000000..f821873be5 --- /dev/null +++ b/docs2/src/Roo_menu_DateMenu.js.html @@ -0,0 +1,45 @@ +/home/alan/gitlive/roojs1/Roo/menu/DateMenu.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.menu.DateMenu + * @extends Roo.menu.Menu + * A menu containing a {@link Roo.menu.DateItem} component (which provides a date picker). + * @constructor + * Creates a new DateMenu + * @param {Object} config Configuration options + */ +Roo.menu.DateMenu = function(config){ + Roo.menu.DateMenu.superclass.constructor.call(this, config); + this.plain = true; + var di = new Roo.menu.DateItem(config); + this.add(di); + /** + * The {@link Roo.DatePicker} instance for this DateMenu + * @type DatePicker + */ + this.picker = di.picker; + /** + * @event select + * @param {DatePicker} picker + * @param {Date} date + */ + this.relayEvents(di, ["select"]); + this.on('beforeshow', function(){ + if(this.picker){ + this.picker.hideMonthPicker(false); + } + }, this); +}; +Roo.extend(Roo.menu.DateMenu, Roo.menu.Menu, { + cls:'x-date-menu' +}); \ No newline at end of file diff --git a/docs2/src/Roo_menu_Item.js.html b/docs2/src/Roo_menu_Item.js.html new file mode 100644 index 0000000000..f074f2d140 --- /dev/null +++ b/docs2/src/Roo_menu_Item.js.html @@ -0,0 +1,176 @@ +/home/alan/gitlive/roojs1/Roo/menu/Item.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.menu.Item + * @extends Roo.menu.BaseItem + * A base class for all menu items that require menu-related functionality (like sub-menus) and are not static + * display items. Item extends the base functionality of {@link Roo.menu.BaseItem} by adding menu-specific + * activation and click handling. + * @constructor + * Creates a new Item + * @param {Object} config Configuration options + */ +Roo.menu.Item = function(config){ + Roo.menu.Item.superclass.constructor.call(this, config); + if(this.menu){ + this.menu = Roo.menu.MenuMgr.get(this.menu); + } +}; +Roo.extend(Roo.menu.Item, Roo.menu.BaseItem, { + + /** + * @cfg {String} text + * The text to show on the menu item. + */ + text: '', + /** + * @cfg {String} HTML to render in menu + * The text to show on the menu item (HTML version). + */ + html: '', + /** + * @cfg {String} icon + * The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL) + */ + icon: undefined, + /** + * @cfg {String} itemCls The default CSS class to use for menu items (defaults to "x-menu-item") + */ + itemCls : "x-menu-item", + /** + * @cfg {Boolean} canActivate True if this item can be visually activated (defaults to true) + */ + canActivate : true, + /** + * @cfg {Number} showDelay Length of time in milliseconds to wait before showing this item (defaults to 200) + */ + showDelay: 200, + // doc'd in BaseItem + hideDelay: 200, + + // private + ctype: "Roo.menu.Item", + + // private + onRender : function(container, position){ + var el = document.createElement("a"); + el.hideFocus = true; + el.unselectable = "on"; + el.href = this.href || "#"; + if(this.hrefTarget){ + el.target = this.hrefTarget; + } + el.className = this.itemCls + (this.menu ? " x-menu-item-arrow" : "") + (this.cls ? " " + this.cls : ""); + + var html = this.html.length ? this.html : String.format('{0}',this.text); + + el.innerHTML = String.format( + '<img src="{0}" class="x-menu-item-icon {1}" />' + html, + this.icon || Roo.BLANK_IMAGE_URL, this.iconCls || ''); + this.el = el; + Roo.menu.Item.superclass.onRender.call(this, container, position); + }, + + /** + * Sets the text to display in this menu item + * @param {String} text The text to display + * @param {Boolean} isHTML true to indicate text is pure html. + */ + setText : function(text, isHTML){ + if (isHTML) { + this.html = text; + } else { + this.text = text; + this.html = ''; + } + if(this.rendered){ + var html = this.html.length ? this.html : String.format('{0}',this.text); + + this.el.update(String.format( + '<img src="{0}" class="x-menu-item-icon {2}">' + html, + this.icon || Roo.BLANK_IMAGE_URL, this.text, this.iconCls || '')); + this.parentMenu.autoWidth(); + } + }, + + // private + handleClick : function(e){ + if(!this.href){ // if no link defined, stop the event automatically + e.stopEvent(); + } + Roo.menu.Item.superclass.handleClick.apply(this, arguments); + }, + + // private + activate : function(autoExpand){ + if(Roo.menu.Item.superclass.activate.apply(this, arguments)){ + this.focus(); + if(autoExpand){ + this.expandMenu(); + } + } + return true; + }, + + // private + shouldDeactivate : function(e){ + if(Roo.menu.Item.superclass.shouldDeactivate.call(this, e)){ + if(this.menu && this.menu.isVisible()){ + return !this.menu.getEl().getRegion().contains(e.getPoint()); + } + return true; + } + return false; + }, + + // private + deactivate : function(){ + Roo.menu.Item.superclass.deactivate.apply(this, arguments); + this.hideMenu(); + }, + + // private + expandMenu : function(autoActivate){ + if(!this.disabled && this.menu){ + clearTimeout(this.hideTimer); + delete this.hideTimer; + if(!this.menu.isVisible() && !this.showTimer){ + this.showTimer = this.deferExpand.defer(this.showDelay, this, [autoActivate]); + }else if (this.menu.isVisible() && autoActivate){ + this.menu.tryActivate(0, 1); + } + } + }, + + // private + deferExpand : function(autoActivate){ + delete this.showTimer; + this.menu.show(this.container, this.parentMenu.subMenuAlign || "tl-tr?", this.parentMenu); + if(autoActivate){ + this.menu.tryActivate(0, 1); + } + }, + + // private + hideMenu : function(){ + clearTimeout(this.showTimer); + delete this.showTimer; + if(!this.hideTimer && this.menu && this.menu.isVisible()){ + this.hideTimer = this.deferHide.defer(this.hideDelay, this); + } + }, + + // private + deferHide : function(){ + delete this.hideTimer; + this.menu.hide(); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_menu_Menu.js.html b/docs2/src/Roo_menu_Menu.js.html new file mode 100644 index 0000000000..970f30cfff --- /dev/null +++ b/docs2/src/Roo_menu_Menu.js.html @@ -0,0 +1,568 @@ +/home/alan/gitlive/roojs1/Roo/menu/Menu.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.menu.Menu + * @extends Roo.util.Observable + * A menu object. This is the container to which you add all other menu items. Menu can also serve a as a base class + * when you want a specialzed menu based off of another component (like {@link Roo.menu.DateMenu} for example). + * @constructor + * Creates a new Menu + * @param {Object} config Configuration options + */ +Roo.menu.Menu = function(config){ + Roo.apply(this, config); + this.id = this.id || Roo.id(); + this.addEvents({ + /** + * @event beforeshow + * Fires before this menu is displayed + * @param {Roo.menu.Menu} this + */ + beforeshow : true, + /** + * @event beforehide + * Fires before this menu is hidden + * @param {Roo.menu.Menu} this + */ + beforehide : true, + /** + * @event show + * Fires after this menu is displayed + * @param {Roo.menu.Menu} this + */ + show : true, + /** + * @event hide + * Fires after this menu is hidden + * @param {Roo.menu.Menu} this + */ + hide : true, + /** + * @event click + * Fires when this menu is clicked (or when the enter key is pressed while it is active) + * @param {Roo.menu.Menu} this + * @param {Roo.menu.Item} menuItem The menu item that was clicked + * @param {Roo.EventObject} e + */ + click : true, + /** + * @event mouseover + * Fires when the mouse is hovering over this menu + * @param {Roo.menu.Menu} this + * @param {Roo.EventObject} e + * @param {Roo.menu.Item} menuItem The menu item that was clicked + */ + mouseover : true, + /** + * @event mouseout + * Fires when the mouse exits this menu + * @param {Roo.menu.Menu} this + * @param {Roo.EventObject} e + * @param {Roo.menu.Item} menuItem The menu item that was clicked + */ + mouseout : true, + /** + * @event itemclick + * Fires when a menu item contained in this menu is clicked + * @param {Roo.menu.BaseItem} baseItem The BaseItem that was clicked + * @param {Roo.EventObject} e + */ + itemclick: true + }); + if (this.registerMenu) { + Roo.menu.MenuMgr.register(this); + } + + var mis = this.items; + this.items = new Roo.util.MixedCollection(); + if(mis){ + this.add.apply(this, mis); + } +}; + +Roo.extend(Roo.menu.Menu, Roo.util.Observable, { + /** + * @cfg {Number} minWidth The minimum width of the menu in pixels (defaults to 120) + */ + minWidth : 120, + /** + * @cfg {Boolean/String} shadow True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" + * for bottom-right shadow (defaults to "sides") + */ + shadow : "sides", + /** + * @cfg {String} subMenuAlign The {@link Roo.Element#alignTo} anchor position value to use for submenus of + * this menu (defaults to "tl-tr?") + */ + subMenuAlign : "tl-tr?", + /** + * @cfg {String} defaultAlign The default {@link Roo.Element#alignTo) anchor position value for this menu + * relative to its element of origin (defaults to "tl-bl?") + */ + defaultAlign : "tl-bl?", + /** + * @cfg {Boolean} allowOtherMenus True to allow multiple menus to be displayed at the same time (defaults to false) + */ + allowOtherMenus : false, + /** + * @cfg {Boolean} registerMenu True (default) - means that clicking on screen etc. hides it. + */ + registerMenu : true, + + hidden:true, + + // private + render : function(){ + if(this.el){ + return; + } + var el = this.el = new Roo.Layer({ + cls: "x-menu", + shadow:this.shadow, + constrain: false, + parentEl: this.parentEl || document.body, + zindex:15000 + }); + + this.keyNav = new Roo.menu.MenuNav(this); + + if(this.plain){ + el.addClass("x-menu-plain"); + } + if(this.cls){ + el.addClass(this.cls); + } + // generic focus element + this.focusEl = el.createChild({ + tag: "a", cls: "x-menu-focus", href: "#", onclick: "return false;", tabIndex:"-1" + }); + var ul = el.createChild({tag: "ul", cls: "x-menu-list"}); + //disabling touch- as it's causing issues .. + //ul.on(Roo.isTouch ? 'touchstart' : 'click' , this.onClick, this); + ul.on('click' , this.onClick, this); + + + ul.on("mouseover", this.onMouseOver, this); + ul.on("mouseout", this.onMouseOut, this); + this.items.each(function(item){ + if (item.hidden) { + return; + } + + var li = document.createElement("li"); + li.className = "x-menu-list-item"; + ul.dom.appendChild(li); + item.render(li, this); + }, this); + this.ul = ul; + this.autoWidth(); + }, + + // private + autoWidth : function(){ + var el = this.el, ul = this.ul; + if(!el){ + return; + } + var w = this.width; + if(w){ + el.setWidth(w); + }else if(Roo.isIE){ + el.setWidth(this.minWidth); + var t = el.dom.offsetWidth; // force recalc + el.setWidth(ul.getWidth()+el.getFrameWidth("lr")); + } + }, + + // private + delayAutoWidth : function(){ + if(this.rendered){ + if(!this.awTask){ + this.awTask = new Roo.util.DelayedTask(this.autoWidth, this); + } + this.awTask.delay(20); + } + }, + + // private + findTargetItem : function(e){ + var t = e.getTarget(".x-menu-list-item", this.ul, true); + if(t && t.menuItemId){ + return this.items.get(t.menuItemId); + } + }, + + // private + onClick : function(e){ + Roo.log("menu.onClick"); + var t = this.findTargetItem(e); + if(!t){ + return; + } + Roo.log(e); + if (Roo.isTouch && e.type == 'touchstart' && t.menu && !t.disabled) { + if(t == this.activeItem && t.shouldDeactivate(e)){ + this.activeItem.deactivate(); + delete this.activeItem; + return; + } + if(t.canActivate){ + this.setActiveItem(t, true); + } + return; + + + } + + t.onClick(e); + this.fireEvent("click", this, t, e); + }, + + // private + setActiveItem : function(item, autoExpand){ + if(item != this.activeItem){ + if(this.activeItem){ + this.activeItem.deactivate(); + } + this.activeItem = item; + item.activate(autoExpand); + }else if(autoExpand){ + item.expandMenu(); + } + }, + + // private + tryActivate : function(start, step){ + var items = this.items; + for(var i = start, len = items.length; i >= 0 && i < len; i+= step){ + var item = items.get(i); + if(!item.disabled && item.canActivate){ + this.setActiveItem(item, false); + return item; + } + } + return false; + }, + + // private + onMouseOver : function(e){ + var t; + if(t = this.findTargetItem(e)){ + if(t.canActivate && !t.disabled){ + this.setActiveItem(t, true); + } + } + this.fireEvent("mouseover", this, e, t); + }, + + // private + onMouseOut : function(e){ + var t; + if(t = this.findTargetItem(e)){ + if(t == this.activeItem && t.shouldDeactivate(e)){ + this.activeItem.deactivate(); + delete this.activeItem; + } + } + this.fireEvent("mouseout", this, e, t); + }, + + /** + * Read-only. Returns true if the menu is currently displayed, else false. + * @type Boolean + */ + isVisible : function(){ + return this.el && !this.hidden; + }, + + /** + * Displays this menu relative to another element + * @param {String/HTMLElement/Roo.Element} element The element to align to + * @param {String} position (optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to + * the element (defaults to this.defaultAlign) + * @param {Roo.menu.Menu} parentMenu (optional) This menu's parent menu, if applicable (defaults to undefined) + */ + show : function(el, pos, parentMenu){ + this.parentMenu = parentMenu; + if(!this.el){ + this.render(); + } + this.fireEvent("beforeshow", this); + this.showAt(this.el.getAlignToXY(el, pos || this.defaultAlign), parentMenu, false); + }, + + /** + * Displays this menu at a specific xy position + * @param {Array} xyPosition Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based) + * @param {Roo.menu.Menu} parentMenu (optional) This menu's parent menu, if applicable (defaults to undefined) + */ + showAt : function(xy, parentMenu, /* private: */_e){ + this.parentMenu = parentMenu; + if(!this.el){ + this.render(); + } + if(_e !== false){ + this.fireEvent("beforeshow", this); + xy = this.el.adjustForConstraints(xy); + } + this.el.setXY(xy); + this.el.show(); + this.hidden = false; + this.focus(); + this.fireEvent("show", this); + }, + + focus : function(){ + if(!this.hidden){ + this.doFocus.defer(50, this); + } + }, + + doFocus : function(){ + if(!this.hidden){ + this.focusEl.focus(); + } + }, + + /** + * Hides this menu and optionally all parent menus + * @param {Boolean} deep (optional) True to hide all parent menus recursively, if any (defaults to false) + */ + hide : function(deep){ + if(this.el && this.isVisible()){ + this.fireEvent("beforehide", this); + if(this.activeItem){ + this.activeItem.deactivate(); + this.activeItem = null; + } + this.el.hide(); + this.hidden = true; + this.fireEvent("hide", this); + } + if(deep === true && this.parentMenu){ + this.parentMenu.hide(true); + } + }, + + /** + * Addds one or more items of any type supported by the Menu class, or that can be converted into menu items. + * Any of the following are valid: + * <ul> + * <li>Any menu item object based on {@link Roo.menu.Item}</li> + * <li>An HTMLElement object which will be converted to a menu item</li> + * <li>A menu item config object that will be created as a new menu item</li> + * <li>A string, which can either be '-' or 'separator' to add a menu separator, otherwise + * it will be converted into a {@link Roo.menu.TextItem} and added</li> + * </ul> + * Usage: + * <pre><code> +// Create the menu +var menu = new Roo.menu.Menu(); + +// Create a menu item to add by reference +var menuItem = new Roo.menu.Item({ text: 'New Item!' }); + +// Add a bunch of items at once using different methods. +// Only the last item added will be returned. +var item = menu.add( + menuItem, // add existing item by ref + 'Dynamic Item', // new TextItem + '-', // new separator + { text: 'Config Item' } // new item by config +); +</code></pre> + * @param {Mixed} args One or more menu items, menu item configs or other objects that can be converted to menu items + * @return {Roo.menu.Item} The menu item that was added, or the last one if multiple items were added + */ + add : function(){ + var a = arguments, l = a.length, item; + for(var i = 0; i < l; i++){ + var el = a[i]; + if ((typeof(el) == "object") && el.xtype && el.xns) { + el = Roo.factory(el, Roo.menu); + } + + if(el.render){ // some kind of Item + item = this.addItem(el); + }else if(typeof el == "string"){ // string + if(el == "separator" || el == "-"){ + item = this.addSeparator(); + }else{ + item = this.addText(el); + } + }else if(el.tagName || el.el){ // element + item = this.addElement(el); + }else if(typeof el == "object"){ // must be menu item config? + item = this.addMenuItem(el); + } + } + return item; + }, + + /** + * Returns this menu's underlying {@link Roo.Element} object + * @return {Roo.Element} The element + */ + getEl : function(){ + if(!this.el){ + this.render(); + } + return this.el; + }, + + /** + * Adds a separator bar to the menu + * @return {Roo.menu.Item} The menu item that was added + */ + addSeparator : function(){ + return this.addItem(new Roo.menu.Separator()); + }, + + /** + * Adds an {@link Roo.Element} object to the menu + * @param {String/HTMLElement/Roo.Element} el The element or DOM node to add, or its id + * @return {Roo.menu.Item} The menu item that was added + */ + addElement : function(el){ + return this.addItem(new Roo.menu.BaseItem(el)); + }, + + /** + * Adds an existing object based on {@link Roo.menu.Item} to the menu + * @param {Roo.menu.Item} item The menu item to add + * @return {Roo.menu.Item} The menu item that was added + */ + addItem : function(item){ + this.items.add(item); + if(this.ul){ + var li = document.createElement("li"); + li.className = "x-menu-list-item"; + this.ul.dom.appendChild(li); + item.render(li, this); + this.delayAutoWidth(); + } + return item; + }, + + /** + * Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu + * @param {Object} config A MenuItem config object + * @return {Roo.menu.Item} The menu item that was added + */ + addMenuItem : function(config){ + if(!(config instanceof Roo.menu.Item)){ + if(typeof config.checked == "boolean"){ // must be check menu item config? + config = new Roo.menu.CheckItem(config); + }else{ + config = new Roo.menu.Item(config); + } + } + return this.addItem(config); + }, + + /** + * Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu + * @param {String} text The text to display in the menu item + * @return {Roo.menu.Item} The menu item that was added + */ + addText : function(text){ + return this.addItem(new Roo.menu.TextItem({ text : text })); + }, + + /** + * Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index + * @param {Number} index The index in the menu's list of current items where the new item should be inserted + * @param {Roo.menu.Item} item The menu item to add + * @return {Roo.menu.Item} The menu item that was added + */ + insert : function(index, item){ + this.items.insert(index, item); + if(this.ul){ + var li = document.createElement("li"); + li.className = "x-menu-list-item"; + this.ul.dom.insertBefore(li, this.ul.dom.childNodes[index]); + item.render(li, this); + this.delayAutoWidth(); + } + return item; + }, + + /** + * Removes an {@link Roo.menu.Item} from the menu and destroys the object + * @param {Roo.menu.Item} item The menu item to remove + */ + remove : function(item){ + this.items.removeKey(item.id); + item.destroy(); + }, + + /** + * Removes and destroys all items in the menu + */ + removeAll : function(){ + var f; + while(f = this.items.first()){ + this.remove(f); + } + } +}); + +// MenuNav is a private utility class used internally by the Menu +Roo.menu.MenuNav = function(menu){ + Roo.menu.MenuNav.superclass.constructor.call(this, menu.el); + this.scope = this.menu = menu; +}; + +Roo.extend(Roo.menu.MenuNav, Roo.KeyNav, { + doRelay : function(e, h){ + var k = e.getKey(); + if(!this.menu.activeItem && e.isNavKeyPress() && k != e.SPACE && k != e.RETURN){ + this.menu.tryActivate(0, 1); + return false; + } + return h.call(this.scope || this, e, this.menu); + }, + + up : function(e, m){ + if(!m.tryActivate(m.items.indexOf(m.activeItem)-1, -1)){ + m.tryActivate(m.items.length-1, -1); + } + }, + + down : function(e, m){ + if(!m.tryActivate(m.items.indexOf(m.activeItem)+1, 1)){ + m.tryActivate(0, 1); + } + }, + + right : function(e, m){ + if(m.activeItem){ + m.activeItem.expandMenu(true); + } + }, + + left : function(e, m){ + m.hide(); + if(m.parentMenu && m.parentMenu.activeItem){ + m.parentMenu.activeItem.activate(); + } + }, + + enter : function(e, m){ + if(m.activeItem){ + e.stopPropagation(); + m.activeItem.onClick(e); + m.fireEvent("click", this, m.activeItem); + return true; + } + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_menu_MenuMgr.js.html b/docs2/src/Roo_menu_MenuMgr.js.html new file mode 100644 index 0000000000..abf85c2c0d --- /dev/null +++ b/docs2/src/Roo_menu_MenuMgr.js.html @@ -0,0 +1,188 @@ +/home/alan/gitlive/roojs1/Roo/menu/MenuMgr.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.menu.MenuMgr + * Provides a common registry of all menu items on a page so that they can be easily accessed by id. + * @singleton + */ +Roo.menu.MenuMgr = function(){ + var menus, active, groups = {}, attached = false, lastShow = new Date(); + + // private - called when first menu is created + function init(){ + menus = {}; + active = new Roo.util.MixedCollection(); + Roo.get(document).addKeyListener(27, function(){ + if(active.length > 0){ + hideAll(); + } + }); + } + + // private + function hideAll(){ + if(active && active.length > 0){ + var c = active.clone(); + c.each(function(m){ + m.hide(); + }); + } + } + + // private + function onHide(m){ + active.remove(m); + if(active.length < 1){ + Roo.get(document).un("mousedown", onMouseDown); + attached = false; + } + } + + // private + function onShow(m){ + var last = active.last(); + lastShow = new Date(); + active.add(m); + if(!attached){ + Roo.get(document).on("mousedown", onMouseDown); + attached = true; + } + if(m.parentMenu){ + m.getEl().setZIndex(parseInt(m.parentMenu.getEl().getStyle("z-index"), 10) + 3); + m.parentMenu.activeChild = m; + }else if(last && last.isVisible()){ + m.getEl().setZIndex(parseInt(last.getEl().getStyle("z-index"), 10) + 3); + } + } + + // private + function onBeforeHide(m){ + if(m.activeChild){ + m.activeChild.hide(); + } + if(m.autoHideTimer){ + clearTimeout(m.autoHideTimer); + delete m.autoHideTimer; + } + } + + // private + function onBeforeShow(m){ + var pm = m.parentMenu; + if(!pm && !m.allowOtherMenus){ + hideAll(); + }else if(pm && pm.activeChild && active != m){ + pm.activeChild.hide(); + } + } + + // private + function onMouseDown(e){ + if(lastShow.getElapsed() > 50 && active.length > 0 && !e.getTarget(".x-menu")){ + hideAll(); + } + } + + // private + function onBeforeCheck(mi, state){ + if(state){ + var g = groups[mi.group]; + for(var i = 0, l = g.length; i < l; i++){ + if(g[i] != mi){ + g[i].setChecked(false); + } + } + } + } + + return { + + /** + * Hides all menus that are currently visible + */ + hideAll : function(){ + hideAll(); + }, + + // private + register : function(menu){ + if(!menus){ + init(); + } + menus[menu.id] = menu; + menu.on("beforehide", onBeforeHide); + menu.on("hide", onHide); + menu.on("beforeshow", onBeforeShow); + menu.on("show", onShow); + var g = menu.group; + if(g && menu.events["checkchange"]){ + if(!groups[g]){ + groups[g] = []; + } + groups[g].push(menu); + menu.on("checkchange", onCheck); + } + }, + + /** + * Returns a {@link Roo.menu.Menu} object + * @param {String/Object} menu The string menu id, an existing menu object reference, or a Menu config that will + * be used to generate and return a new Menu instance. + */ + get : function(menu){ + if(typeof menu == "string"){ // menu id + return menus[menu]; + }else if(menu.events){ // menu instance + return menu; + }else if(typeof menu.length == 'number'){ // array of menu items? + return new Roo.menu.Menu({items:menu}); + }else{ // otherwise, must be a config + return new Roo.menu.Menu(menu); + } + }, + + // private + unregister : function(menu){ + delete menus[menu.id]; + menu.un("beforehide", onBeforeHide); + menu.un("hide", onHide); + menu.un("beforeshow", onBeforeShow); + menu.un("show", onShow); + var g = menu.group; + if(g && menu.events["checkchange"]){ + groups[g].remove(menu); + menu.un("checkchange", onCheck); + } + }, + + // private + registerCheckable : function(menuItem){ + var g = menuItem.group; + if(g){ + if(!groups[g]){ + groups[g] = []; + } + groups[g].push(menuItem); + menuItem.on("beforecheckchange", onBeforeCheck); + } + }, + + // private + unregisterCheckable : function(menuItem){ + var g = menuItem.group; + if(g){ + groups[g].remove(menuItem); + menuItem.un("beforecheckchange", onBeforeCheck); + } + } + }; +}(); \ No newline at end of file diff --git a/docs2/src/Roo_menu_Separator.js.html b/docs2/src/Roo_menu_Separator.js.html new file mode 100644 index 0000000000..3a3d7bfd69 --- /dev/null +++ b/docs2/src/Roo_menu_Separator.js.html @@ -0,0 +1,43 @@ +/home/alan/gitlive/roojs1/Roo/menu/Separator.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.menu.Separator + * @extends Roo.menu.BaseItem + * Adds a separator bar to a menu, used to divide logical groups of menu items. Generally you will + * add one of these by using "-" in you call to add() or in your items config rather than creating one directly. + * @constructor + * @param {Object} config Configuration options + */ +Roo.menu.Separator = function(config){ + Roo.menu.Separator.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.menu.Separator, Roo.menu.BaseItem, { + /** + * @cfg {String} itemCls The default CSS class to use for separators (defaults to "x-menu-sep") + */ + itemCls : "x-menu-sep", + /** + * @cfg {Boolean} hideOnClick True to hide the containing menu after this item is clicked (defaults to false) + */ + hideOnClick : false, + + // private + onRender : function(li){ + var s = document.createElement("span"); + s.className = this.itemCls; + s.innerHTML = "&#160;"; + this.el = s; + li.addClass("x-menu-sep-li"); + Roo.menu.Separator.superclass.onRender.apply(this, arguments); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_menu_TextItem.js.html b/docs2/src/Roo_menu_TextItem.js.html new file mode 100644 index 0000000000..0adcd1b14c --- /dev/null +++ b/docs2/src/Roo_menu_TextItem.js.html @@ -0,0 +1,55 @@ +/home/alan/gitlive/roojs1/Roo/menu/TextItem.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.menu.TextItem + * @extends Roo.menu.BaseItem + * Adds a static text string to a menu, usually used as either a heading or group separator. + * Note: old style constructor with text is still supported. + * + * @constructor + * Creates a new TextItem + * @param {Object} cfg Configuration + */ +Roo.menu.TextItem = function(cfg){ + if (typeof(cfg) == 'string') { + this.text = cfg; + } else { + Roo.apply(this,cfg); + } + + Roo.menu.TextItem.superclass.constructor.call(this); +}; + +Roo.extend(Roo.menu.TextItem, Roo.menu.BaseItem, { + /** + * @cfg {Boolean} text Text to show on item. + */ + text : '', + + /** + * @cfg {Boolean} hideOnClick True to hide the containing menu after this item is clicked (defaults to false) + */ + hideOnClick : false, + /** + * @cfg {String} itemCls The default CSS class to use for text items (defaults to "x-menu-text") + */ + itemCls : "x-menu-text", + + // private + onRender : function(){ + var s = document.createElement("span"); + s.className = this.itemCls; + s.innerHTML = this.text; + this.el = s; + Roo.menu.TextItem.superclass.onRender.apply(this, arguments); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_state_CookieProvider.js.html b/docs2/src/Roo_state_CookieProvider.js.html new file mode 100644 index 0000000000..699cd79f5e --- /dev/null +++ b/docs2/src/Roo_state_CookieProvider.js.html @@ -0,0 +1,94 @@ +/home/alan/gitlive/roojs1/Roo/state/CookieProvider.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.state.CookieProvider + * @extends Roo.state.Provider + * The default Provider implementation which saves state via cookies. + * <br />Usage: + <pre><code> + var cp = new Roo.state.CookieProvider({ + path: "/cgi-bin/", + expires: new Date(new Date().getTime()+(1000*60*60*24*30)); //30 days + domain: "roojs.com" + }) + Roo.state.Manager.setProvider(cp); + </code></pre> + * @cfg {String} path The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site) + * @cfg {Date} expires The cookie expiration date (defaults to 7 days from now) + * @cfg {String} domain The domain to save the cookie for. Note that you cannot specify a different domain than + * your page is on, but you can specify a sub-domain, or simply the domain itself like 'roojs.com' to include + * all sub-domains if you need to access cookies across different sub-domains (defaults to null which uses the same + * domain the page is running on including the 'www' like 'www.roojs.com') + * @cfg {Boolean} secure True if the site is using SSL (defaults to false) + * @constructor + * Create a new CookieProvider + * @param {Object} config The configuration object + */ +Roo.state.CookieProvider = function(config){ + Roo.state.CookieProvider.superclass.constructor.call(this); + this.path = "/"; + this.expires = new Date(new Date().getTime()+(1000*60*60*24*7)); //7 days + this.domain = null; + this.secure = false; + Roo.apply(this, config); + this.state = this.readCookies(); +}; + +Roo.extend(Roo.state.CookieProvider, Roo.state.Provider, { + // private + set : function(name, value){ + if(typeof value == "undefined" || value === null){ + this.clear(name); + return; + } + this.setCookie(name, value); + Roo.state.CookieProvider.superclass.set.call(this, name, value); + }, + + // private + clear : function(name){ + this.clearCookie(name); + Roo.state.CookieProvider.superclass.clear.call(this, name); + }, + + // private + readCookies : function(){ + var cookies = {}; + var c = document.cookie + ";"; + var re = /\s?(.*?)=(.*?);/g; + var matches; + while((matches = re.exec(c)) != null){ + var name = matches[1]; + var value = matches[2]; + if(name && name.substring(0,3) == "ys-"){ + cookies[name.substr(3)] = this.decodeValue(value); + } + } + return cookies; + }, + + // private + setCookie : function(name, value){ + document.cookie = "ys-"+ name + "=" + this.encodeValue(value) + + ((this.expires == null) ? "" : ("; expires=" + this.expires.toGMTString())) + + ((this.path == null) ? "" : ("; path=" + this.path)) + + ((this.domain == null) ? "" : ("; domain=" + this.domain)) + + ((this.secure == true) ? "; secure" : ""); + }, + + // private + clearCookie : function(name){ + document.cookie = "ys-" + name + "=null; expires=Thu, 01-Jan-70 00:00:01 GMT" + + ((this.path == null) ? "" : ("; path=" + this.path)) + + ((this.domain == null) ? "" : ("; domain=" + this.domain)) + + ((this.secure == true) ? "; secure" : ""); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_state_Manager.js.html b/docs2/src/Roo_state_Manager.js.html new file mode 100644 index 0000000000..7708cef4f7 --- /dev/null +++ b/docs2/src/Roo_state_Manager.js.html @@ -0,0 +1,78 @@ +/home/alan/gitlive/roojs1/Roo/state/Manager.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.state.Manager + * This is the global state manager. By default all components that are "state aware" check this class + * for state information if you don't pass them a custom state provider. In order for this class + * to be useful, it must be initialized with a provider when your application initializes. + <pre><code> +// in your initialization function +init : function(){ + Roo.state.Manager.setProvider(new Roo.state.CookieProvider()); + ... + // supposed you have a {@link Roo.BorderLayout} + var layout = new Roo.BorderLayout(...); + layout.restoreState(); + // or a {Roo.BasicDialog} + var dialog = new Roo.BasicDialog(...); + dialog.restoreState(); + </code></pre> + * @singleton + */ +Roo.state.Manager = function(){ + var provider = new Roo.state.Provider(); + + return { + /** + * Configures the default state provider for your application + * @param {Provider} stateProvider The state provider to set + */ + setProvider : function(stateProvider){ + provider = stateProvider; + }, + + /** + * Returns the current value for a key + * @param {String} name The key name + * @param {Mixed} defaultValue The default value to return if the key lookup does not match + * @return {Mixed} The state data + */ + get : function(key, defaultValue){ + return provider.get(key, defaultValue); + }, + + /** + * Sets the value for a key + * @param {String} name The key name + * @param {Mixed} value The state data + */ + set : function(key, value){ + provider.set(key, value); + }, + + /** + * Clears a value from the state + * @param {String} name The key name + */ + clear : function(key){ + provider.clear(key); + }, + + /** + * Gets the currently configured state provider + * @return {Provider} The state provider + */ + getProvider : function(){ + return provider; + } + }; +}(); + \ No newline at end of file diff --git a/docs2/src/Roo_state_Provider.js.html b/docs2/src/Roo_state_Provider.js.html new file mode 100644 index 0000000000..1e1c3233b9 --- /dev/null +++ b/docs2/src/Roo_state_Provider.js.html @@ -0,0 +1,140 @@ +/home/alan/gitlive/roojs1/Roo/state/Provider.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.state.Provider + * Abstract base class for state provider implementations. This class provides methods + * for encoding and decoding <b>typed</b> variables including dates and defines the + * Provider interface. + */ +Roo.state.Provider = function(){ + /** + * @event statechange + * Fires when a state change occurs. + * @param {Provider} this This state provider + * @param {String} key The state key which was changed + * @param {String} value The encoded value for the state + */ + this.addEvents({ + "statechange": true + }); + this.state = {}; + Roo.state.Provider.superclass.constructor.call(this); +}; +Roo.extend(Roo.state.Provider, Roo.util.Observable, { + /** + * Returns the current value for a key + * @param {String} name The key name + * @param {Mixed} defaultValue A default value to return if the key's value is not found + * @return {Mixed} The state data + */ + get : function(name, defaultValue){ + return typeof this.state[name] == "undefined" ? + defaultValue : this.state[name]; + }, + + /** + * Clears a value from the state + * @param {String} name The key name + */ + clear : function(name){ + delete this.state[name]; + this.fireEvent("statechange", this, name, null); + }, + + /** + * Sets the value for a key + * @param {String} name The key name + * @param {Mixed} value The value to set + */ + set : function(name, value){ + this.state[name] = value; + this.fireEvent("statechange", this, name, value); + }, + + /** + * Decodes a string previously encoded with {@link #encodeValue}. + * @param {String} value The value to decode + * @return {Mixed} The decoded value + */ + decodeValue : function(cookie){ + var re = /^(a|n|d|b|s|o)\:(.*)$/; + var matches = re.exec(unescape(cookie)); + if(!matches || !matches[1]) { + return; // non state cookie + } + var type = matches[1]; + var v = matches[2]; + switch(type){ + case "n": + return parseFloat(v); + case "d": + return new Date(Date.parse(v)); + case "b": + return (v == "1"); + case "a": + var all = []; + var values = v.split("^"); + for(var i = 0, len = values.length; i < len; i++){ + all.push(this.decodeValue(values[i])); + } + return all; + case "o": + var all = {}; + var values = v.split("^"); + for(var i = 0, len = values.length; i < len; i++){ + var kv = values[i].split("="); + all[kv[0]] = this.decodeValue(kv[1]); + } + return all; + default: + return v; + } + }, + + /** + * Encodes a value including type information. Decode with {@link #decodeValue}. + * @param {Mixed} value The value to encode + * @return {String} The encoded value + */ + encodeValue : function(v){ + var enc; + if(typeof v == "number"){ + enc = "n:" + v; + }else if(typeof v == "boolean"){ + enc = "b:" + (v ? "1" : "0"); + }else if(v instanceof Date){ + enc = "d:" + v.toGMTString(); + }else if(v instanceof Array){ + var flat = ""; + for(var i = 0, len = v.length; i < len; i++){ + flat += this.encodeValue(v[i]); + if(i != len-1) { + flat += "^"; + } + } + enc = "a:" + flat; + }else if(typeof v == "object"){ + var flat = ""; + for(var key in v){ + if(typeof v[key] != "function"){ + flat += key + "=" + this.encodeValue(v[key]) + "^"; + } + } + enc = "o:" + flat.substring(0, flat.length-1); + }else{ + enc = "s:" + v; + } + return escape(enc); + } +}); + + \ No newline at end of file diff --git a/docs2/src/Roo_tree_AsyncTreeNode.js.html b/docs2/src/Roo_tree_AsyncTreeNode.js.html new file mode 100644 index 0000000000..e839edc429 --- /dev/null +++ b/docs2/src/Roo_tree_AsyncTreeNode.js.html @@ -0,0 +1,116 @@ +/home/alan/gitlive/roojs1/Roo/tree/AsyncTreeNode.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.tree.AsyncTreeNode + * @extends Roo.tree.TreeNode + * @cfg {TreeLoader} loader A TreeLoader to be used by this node (defaults to the loader defined on the tree) + * @constructor + * @param {Object/String} attributes The attributes/config for the node or just a string with the text for the node + */ + Roo.tree.AsyncTreeNode = function(config){ + this.loaded = false; + this.loading = false; + Roo.tree.AsyncTreeNode.superclass.constructor.apply(this, arguments); + /** + * @event beforeload + * Fires before this node is loaded, return false to cancel + * @param {Node} this This node + */ + this.addEvents({'beforeload':true, 'load': true}); + /** + * @event load + * Fires when this node is loaded + * @param {Node} this This node + */ + /** + * The loader used by this node (defaults to using the tree's defined loader) + * @type TreeLoader + * @property loader + */ +}; +Roo.extend(Roo.tree.AsyncTreeNode, Roo.tree.TreeNode, { + expand : function(deep, anim, callback){ + if(this.loading){ // if an async load is already running, waiting til it's done + var timer; + var f = function(){ + if(!this.loading){ // done loading + clearInterval(timer); + this.expand(deep, anim, callback); + } + }.createDelegate(this); + timer = setInterval(f, 200); + return; + } + if(!this.loaded){ + if(this.fireEvent("beforeload", this) === false){ + return; + } + this.loading = true; + this.ui.beforeLoad(this); + var loader = this.loader || this.attributes.loader || this.getOwnerTree().getLoader(); + if(loader){ + loader.load(this, this.loadComplete.createDelegate(this, [deep, anim, callback])); + return; + } + } + Roo.tree.AsyncTreeNode.superclass.expand.call(this, deep, anim, callback); + }, + + /** + * Returns true if this node is currently loading + * @return {Boolean} + */ + isLoading : function(){ + return this.loading; + }, + + loadComplete : function(deep, anim, callback){ + this.loading = false; + this.loaded = true; + this.ui.afterLoad(this); + this.fireEvent("load", this); + this.expand(deep, anim, callback); + }, + + /** + * Returns true if this node has been loaded + * @return {Boolean} + */ + isLoaded : function(){ + return this.loaded; + }, + + hasChildNodes : function(){ + if(!this.isLeaf() && !this.loaded){ + return true; + }else{ + return Roo.tree.AsyncTreeNode.superclass.hasChildNodes.call(this); + } + }, + + /** + * Trigger a reload for this node + * @param {Function} callback + */ + reload : function(callback){ + this.collapse(false, false); + while(this.firstChild){ + this.removeChild(this.firstChild); + } + this.childrenRendered = false; + this.loaded = false; + if(this.isHiddenRoot()){ + this.expanded = false; + } + this.expand(false, false, callback); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_tree_ColumnNodeUI.js.html b/docs2/src/Roo_tree_ColumnNodeUI.js.html new file mode 100644 index 0000000000..3c700bf36f --- /dev/null +++ b/docs2/src/Roo_tree_ColumnNodeUI.js.html @@ -0,0 +1,149 @@ +/home/alan/gitlive/roojs1/Roo/tree/ColumnNodeUI.js//<Script type="text/javascript"> +/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * Not documented??? - probably should be... + */ + +Roo.tree.ColumnNodeUI = Roo.extend(Roo.tree.TreeNodeUI, { + //focus: Roo.emptyFn, // prevent odd scrolling behavior + + renderElements : function(n, a, targetNode, bulkRender){ + //consel.log("renderElements?"); + this.indentMarkup = n.parentNode ? n.parentNode.ui.getChildIndent() : ''; + + var t = n.getOwnerTree(); + var tid = Pman.Tab.Document_TypesTree.tree.el.id; + + var cols = t.columns; + var bw = t.borderWidth; + var c = cols[0]; + var href = a.href ? a.href : Roo.isGecko ? "" : "#"; + var cb = typeof a.checked == "boolean"; + var tx = String.format('{0}',n.text || (c.renderer ? c.renderer(a[c.dataIndex], n, a) : a[c.dataIndex])); + var colcls = 'x-t-' + tid + '-c0'; + var buf = [ + '<li class="x-tree-node">', + + + '<div class="x-tree-node-el ', a.cls,'">', + // extran... + '<div class="x-tree-col ', colcls, '" style="width:', c.width-bw, 'px;">', + + + '<span class="x-tree-node-indent">',this.indentMarkup,'</span>', + '<img src="', this.emptyIcon, '" class="x-tree-ec-icon " />', + '<img src="', a.icon || this.emptyIcon, '" class="x-tree-node-icon', + (a.icon ? ' x-tree-node-inline-icon' : ''), + (a.iconCls ? ' '+a.iconCls : ''), + '" unselectable="on" />', + (cb ? ('<input class="x-tree-node-cb" type="checkbox" ' + + (a.checked ? 'checked="checked" />' : ' />')) : ''), + + '<a class="x-tree-node-anchor" hidefocus="on" href="',href,'" tabIndex="1" ', + (a.hrefTarget ? ' target="' +a.hrefTarget + '"' : ''), '>', + '<span unselectable="on" qtip="' + tx + '">', + tx, + '</span></a>' , + '</div>', + '<a class="x-tree-node-anchor" hidefocus="on" href="',href,'" tabIndex="1" ', + (a.hrefTarget ? ' target="' +a.hrefTarget + '"' : ''), '>' + ]; + for(var i = 1, len = cols.length; i < len; i++){ + c = cols[i]; + colcls = 'x-t-' + tid + '-c' +i; + tx = String.format('{0}', (c.renderer ? c.renderer(a[c.dataIndex], n, a) : a[c.dataIndex])); + buf.push('<div class="x-tree-col ', colcls, ' ' ,(c.cls?c.cls:''),'" style="width:',c.width-bw,'px;">', + '<div class="x-tree-col-text" qtip="' + tx +'">',tx,"</div>", + "</div>"); + } + + buf.push( + '</a>', + '<div class="x-clear"></div></div>', + '<ul class="x-tree-node-ct" style="display:none;"></ul>', + "</li>"); + + if(bulkRender !== true && n.nextSibling && n.nextSibling.ui.getEl()){ + this.wrap = Roo.DomHelper.insertHtml("beforeBegin", + n.nextSibling.ui.getEl(), buf.join("")); + }else{ + this.wrap = Roo.DomHelper.insertHtml("beforeEnd", targetNode, buf.join("")); + } + var el = this.wrap.firstChild; + this.elRow = el; + this.elNode = el.firstChild; + this.ranchor = el.childNodes[1]; + this.ctNode = this.wrap.childNodes[1]; + var cs = el.firstChild.childNodes; + this.indentNode = cs[0]; + this.ecNode = cs[1]; + this.iconNode = cs[2]; + var index = 3; + if(cb){ + this.checkbox = cs[3]; + index++; + } + this.anchor = cs[index]; + + this.textNode = cs[index].firstChild; + + //el.on("click", this.onClick, this); + //el.on("dblclick", this.onDblClick, this); + + + // console.log(this); + }, + initEvents : function(){ + Roo.tree.ColumnNodeUI.superclass.initEvents.call(this); + + + var a = this.ranchor; + + var el = Roo.get(a); + + if(Roo.isOpera){ // opera render bug ignores the CSS + el.setStyle("text-decoration", "none"); + } + + el.on("click", this.onClick, this); + el.on("dblclick", this.onDblClick, this); + el.on("contextmenu", this.onContextMenu, this); + + }, + + /*onSelectedChange : function(state){ + if(state){ + this.focus(); + this.addClass("x-tree-selected"); + }else{ + //this.blur(); + this.removeClass("x-tree-selected"); + } + },*/ + addClass : function(cls){ + if(this.elRow){ + Roo.fly(this.elRow).addClass(cls); + } + + }, + + + removeClass : function(cls){ + if(this.elRow){ + Roo.fly(this.elRow).removeClass(cls); + } + } + + + +}); \ No newline at end of file diff --git a/docs2/src/Roo_tree_ColumnTree.js.html b/docs2/src/Roo_tree_ColumnTree.js.html new file mode 100644 index 0000000000..d77cce3193 --- /dev/null +++ b/docs2/src/Roo_tree_ColumnTree.js.html @@ -0,0 +1,114 @@ +/home/alan/gitlive/roojs1/Roo/tree/ColumnTree.js//<Script type="text/javascript"> + +/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.tree.ColumnTree + * @extends Roo.data.TreePanel + * @cfg {Object} columns Including width, header, renderer, cls, dataIndex + * @cfg {int} borderWidth compined right/left border allowance + * @constructor + * @param {String/HTMLElement/Element} el The container element + * @param {Object} config + */ +Roo.tree.ColumnTree = function(el, config) +{ + Roo.tree.ColumnTree.superclass.constructor.call(this, el , config); + this.addEvents({ + /** + * @event resize + * Fire this event on a container when it resizes + * @param {int} w Width + * @param {int} h Height + */ + "resize" : true + }); + this.on('resize', this.onResize, this); +}; + +Roo.extend(Roo.tree.ColumnTree, Roo.tree.TreePanel, { + //lines:false, + + + borderWidth: Roo.isBorderBox ? 0 : 2, + headEls : false, + + render : function(){ + // add the header..... + + Roo.tree.ColumnTree.superclass.render.apply(this); + + this.el.addClass('x-column-tree'); + + this.headers = this.el.createChild( + {cls:'x-tree-headers'},this.innerCt.dom); + + var cols = this.columns, c; + var totalWidth = 0; + this.headEls = []; + var len = cols.length; + for(var i = 0; i < len; i++){ + c = cols[i]; + totalWidth += c.width; + this.headEls.push(this.headers.createChild({ + cls:'x-tree-hd ' + (c.cls?c.cls+'-hd':''), + cn: { + cls:'x-tree-hd-text', + html: c.header + }, + style:'width:'+(c.width-this.borderWidth)+'px;' + })); + } + this.headers.createChild({cls:'x-clear'}); + // prevent floats from wrapping when clipped + this.headers.setWidth(totalWidth); + //this.innerCt.setWidth(totalWidth); + this.innerCt.setStyle({ overflow: 'auto' }); + this.onResize(this.width, this.height); + + + }, + onResize : function(w,h) + { + this.height = h; + this.width = w; + // resize cols.. + this.innerCt.setWidth(this.width); + this.innerCt.setHeight(this.height-20); + + // headers... + var cols = this.columns, c; + var totalWidth = 0; + var expEl = false; + var len = cols.length; + for(var i = 0; i < len; i++){ + c = cols[i]; + if (this.autoExpandColumn !== false && c.dataIndex == this.autoExpandColumn) { + // it's the expander.. + expEl = this.headEls[i]; + continue; + } + totalWidth += c.width; + + } + if (expEl) { + expEl.setWidth( ((w - totalWidth)-this.borderWidth - 20)); + } + this.headers.setWidth(w-20); + + + + + } +}); + \ No newline at end of file diff --git a/docs2/src/Roo_tree_TreeDragZone.js.html b/docs2/src/Roo_tree_TreeDragZone.js.html new file mode 100644 index 0000000000..baa92019d6 --- /dev/null +++ b/docs2/src/Roo_tree_TreeDragZone.js.html @@ -0,0 +1,58 @@ +/home/alan/gitlive/roojs1/Roo/tree/TreeDragZone.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +if(Roo.dd.DragZone){ +Roo.tree.TreeDragZone = function(tree, config){ + Roo.tree.TreeDragZone.superclass.constructor.call(this, tree.getTreeEl(), config); + this.tree = tree; +}; + +Roo.extend(Roo.tree.TreeDragZone, Roo.dd.DragZone, { + ddGroup : "TreeDD", + + onBeforeDrag : function(data, e){ + var n = data.node; + return n && n.draggable && !n.disabled; + }, + + + onInitDrag : function(e){ + var data = this.dragData; + this.tree.getSelectionModel().select(data.node); + this.proxy.update(""); + data.node.ui.appendDDGhost(this.proxy.ghost.dom); + this.tree.fireEvent("startdrag", this.tree, data.node, e); + }, + + getRepairXY : function(e, data){ + return data.node.ui.getDDRepairXY(); + }, + + onEndDrag : function(data, e){ + this.tree.fireEvent("enddrag", this.tree, data.node, e); + + + }, + + onValidDrop : function(dd, e, id){ + this.tree.fireEvent("dragdrop", this.tree, this.dragData.node, dd, e); + this.hideProxy(); + }, + + beforeInvalidDrop : function(e, id){ + // this scrolls the original position back into view + var sm = this.tree.getSelectionModel(); + sm.clearSelections(); + sm.select(this.dragData.node); + } +}); +} \ No newline at end of file diff --git a/docs2/src/Roo_tree_TreeDropZone.js.html b/docs2/src/Roo_tree_TreeDropZone.js.html new file mode 100644 index 0000000000..fbebec8cb8 --- /dev/null +++ b/docs2/src/Roo_tree_TreeDropZone.js.html @@ -0,0 +1,256 @@ +/home/alan/gitlive/roojs1/Roo/tree/TreeDropZone.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +if(Roo.dd.DropZone){ + +Roo.tree.TreeDropZone = function(tree, config){ + this.allowParentInsert = false; + this.allowContainerDrop = false; + this.appendOnly = false; + Roo.tree.TreeDropZone.superclass.constructor.call(this, tree.innerCt, config); + this.tree = tree; + this.lastInsertClass = "x-tree-no-status"; + this.dragOverData = {}; +}; + +Roo.extend(Roo.tree.TreeDropZone, Roo.dd.DropZone, { + ddGroup : "TreeDD", + scroll: true, + + expandDelay : 1000, + + expandNode : function(node){ + if(node.hasChildNodes() && !node.isExpanded()){ + node.expand(false, null, this.triggerCacheRefresh.createDelegate(this)); + } + }, + + queueExpand : function(node){ + this.expandProcId = this.expandNode.defer(this.expandDelay, this, [node]); + }, + + cancelExpand : function(){ + if(this.expandProcId){ + clearTimeout(this.expandProcId); + this.expandProcId = false; + } + }, + + isValidDropPoint : function(n, pt, dd, e, data){ + if(!n || !data){ return false; } + var targetNode = n.node; + var dropNode = data.node; + // default drop rules + if(!(targetNode && targetNode.isTarget && pt)){ + return false; + } + if(pt == "append" && targetNode.allowChildren === false){ + return false; + } + if((pt == "above" || pt == "below") && (targetNode.parentNode && targetNode.parentNode.allowChildren === false)){ + return false; + } + if(dropNode && (targetNode == dropNode || dropNode.contains(targetNode))){ + return false; + } + // reuse the object + var overEvent = this.dragOverData; + overEvent.tree = this.tree; + overEvent.target = targetNode; + overEvent.data = data; + overEvent.point = pt; + overEvent.source = dd; + overEvent.rawEvent = e; + overEvent.dropNode = dropNode; + overEvent.cancel = false; + var result = this.tree.fireEvent("nodedragover", overEvent); + return overEvent.cancel === false && result !== false; + }, + + getDropPoint : function(e, n, dd) + { + var tn = n.node; + if(tn.isRoot){ + return tn.allowChildren !== false ? "append" : false; // always append for root + } + var dragEl = n.ddel; + var t = Roo.lib.Dom.getY(dragEl), b = t + dragEl.offsetHeight; + var y = Roo.lib.Event.getPageY(e); + //var noAppend = tn.allowChildren === false || tn.isLeaf(); + + // we may drop nodes anywhere, as long as allowChildren has not been set to false.. + var noAppend = tn.allowChildren === false; + if(this.appendOnly || tn.parentNode.allowChildren === false){ + return noAppend ? false : "append"; + } + var noBelow = false; + if(!this.allowParentInsert){ + noBelow = tn.hasChildNodes() && tn.isExpanded(); + } + var q = (b - t) / (noAppend ? 2 : 3); + if(y >= t && y < (t + q)){ + return "above"; + }else if(!noBelow && (noAppend || y >= b-q && y <= b)){ + return "below"; + }else{ + return "append"; + } + }, + + onNodeEnter : function(n, dd, e, data) + { + this.cancelExpand(); + }, + + onNodeOver : function(n, dd, e, data) + { + + var pt = this.getDropPoint(e, n, dd); + var node = n.node; + + // auto node expand check + if(!this.expandProcId && pt == "append" && node.hasChildNodes() && !n.node.isExpanded()){ + this.queueExpand(node); + }else if(pt != "append"){ + this.cancelExpand(); + } + + // set the insert point style on the target node + var returnCls = this.dropNotAllowed; + if(this.isValidDropPoint(n, pt, dd, e, data)){ + if(pt){ + var el = n.ddel; + var cls; + if(pt == "above"){ + returnCls = n.node.isFirst() ? "x-tree-drop-ok-above" : "x-tree-drop-ok-between"; + cls = "x-tree-drag-insert-above"; + }else if(pt == "below"){ + returnCls = n.node.isLast() ? "x-tree-drop-ok-below" : "x-tree-drop-ok-between"; + cls = "x-tree-drag-insert-below"; + }else{ + returnCls = "x-tree-drop-ok-append"; + cls = "x-tree-drag-append"; + } + if(this.lastInsertClass != cls){ + Roo.fly(el).replaceClass(this.lastInsertClass, cls); + this.lastInsertClass = cls; + } + } + } + return returnCls; + }, + + onNodeOut : function(n, dd, e, data){ + + this.cancelExpand(); + this.removeDropIndicators(n); + }, + + onNodeDrop : function(n, dd, e, data){ + var point = this.getDropPoint(e, n, dd); + var targetNode = n.node; + targetNode.ui.startDrop(); + if(!this.isValidDropPoint(n, point, dd, e, data)){ + targetNode.ui.endDrop(); + return false; + } + // first try to find the drop node + var dropNode = data.node || (dd.getTreeNode ? dd.getTreeNode(data, targetNode, point, e) : null); + var dropEvent = { + tree : this.tree, + target: targetNode, + data: data, + point: point, + source: dd, + rawEvent: e, + dropNode: dropNode, + cancel: !dropNode + }; + var retval = this.tree.fireEvent("beforenodedrop", dropEvent); + if(retval === false || dropEvent.cancel === true || !dropEvent.dropNode){ + targetNode.ui.endDrop(); + return false; + } + // allow target changing + targetNode = dropEvent.target; + if(point == "append" && !targetNode.isExpanded()){ + targetNode.expand(false, null, function(){ + this.completeDrop(dropEvent); + }.createDelegate(this)); + }else{ + this.completeDrop(dropEvent); + } + return true; + }, + + completeDrop : function(de){ + var ns = de.dropNode, p = de.point, t = de.target; + if(!(ns instanceof Array)){ + ns = [ns]; + } + var n; + for(var i = 0, len = ns.length; i < len; i++){ + n = ns[i]; + if(p == "above"){ + t.parentNode.insertBefore(n, t); + }else if(p == "below"){ + t.parentNode.insertBefore(n, t.nextSibling); + }else{ + t.appendChild(n); + } + } + n.ui.focus(); + if(this.tree.hlDrop){ + n.ui.highlight(); + } + t.ui.endDrop(); + this.tree.fireEvent("nodedrop", de); + }, + + afterNodeMoved : function(dd, data, e, targetNode, dropNode){ + if(this.tree.hlDrop){ + dropNode.ui.focus(); + dropNode.ui.highlight(); + } + this.tree.fireEvent("nodedrop", this.tree, targetNode, data, dd, e); + }, + + getTree : function(){ + return this.tree; + }, + + removeDropIndicators : function(n){ + if(n && n.ddel){ + var el = n.ddel; + Roo.fly(el).removeClass([ + "x-tree-drag-insert-above", + "x-tree-drag-insert-below", + "x-tree-drag-append"]); + this.lastInsertClass = "_noclass"; + } + }, + + beforeDragDrop : function(target, e, id){ + this.cancelExpand(); + return true; + }, + + afterRepair : function(data){ + if(data && Roo.enableFx){ + data.node.ui.highlight(); + } + this.hideProxy(); + } + +}); + +} + \ No newline at end of file diff --git a/docs2/src/Roo_tree_TreeEditor.js.html b/docs2/src/Roo_tree_TreeEditor.js.html new file mode 100644 index 0000000000..c952331003 --- /dev/null +++ b/docs2/src/Roo_tree_TreeEditor.js.html @@ -0,0 +1,163 @@ +/home/alan/gitlive/roojs1/Roo/tree/TreeEditor.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.tree.TreeEditor + * @extends Roo.Editor + * Provides editor functionality for inline tree node editing. Any valid {@link Roo.form.Field} can be used + * as the editor field. + * @constructor + * @param {Object} config (used to be the tree panel.) + * @param {Object} oldconfig DEPRECIATED Either a prebuilt {@link Roo.form.Field} instance or a Field config object + * + * @cfg {Roo.tree.TreePanel} tree The tree to bind to. + * @cfg {Roo.form.TextField|Object} field The field configuration + * + * + */ +Roo.tree.TreeEditor = function(config, oldconfig) { // was -- (tree, config){ + var tree = config; + var field; + if (oldconfig) { // old style.. + field = oldconfig.events ? oldconfig : new Roo.form.TextField(oldconfig); + } else { + // new style.. + tree = config.tree; + config.field = config.field || {}; + config.field.xtype = 'TextField'; + field = Roo.factory(config.field, Roo.form); + } + config = config || {}; + + + this.addEvents({ + /** + * @event beforenodeedit + * Fires when editing is initiated, but before the value changes. Editing can be canceled by returning + * false from the handler of this event. + * @param {Editor} this + * @param {Roo.tree.Node} node + */ + "beforenodeedit" : true + }); + + //Roo.log(config); + Roo.tree.TreeEditor.superclass.constructor.call(this, field, config); + + this.tree = tree; + + tree.on('beforeclick', this.beforeNodeClick, this); + tree.getTreeEl().on('mousedown', this.hide, this); + this.on('complete', this.updateNode, this); + this.on('beforestartedit', this.fitToTree, this); + this.on('startedit', this.bindScroll, this, {delay:10}); + this.on('specialkey', this.onSpecialKey, this); +}; + +Roo.extend(Roo.tree.TreeEditor, Roo.Editor, { + /** + * @cfg {String} alignment + * The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to "l-l"). + */ + alignment: "l-l", + // inherit + autoSize: false, + /** + * @cfg {Boolean} hideEl + * True to hide the bound element while the editor is displayed (defaults to false) + */ + hideEl : false, + /** + * @cfg {String} cls + * CSS class to apply to the editor (defaults to "x-small-editor x-tree-editor") + */ + cls: "x-small-editor x-tree-editor", + /** + * @cfg {Boolean} shim + * True to shim the editor if selects/iframes could be displayed beneath it (defaults to false) + */ + shim:false, + // inherit + shadow:"frame", + /** + * @cfg {Number} maxWidth + * The maximum width in pixels of the editor field (defaults to 250). Note that if the maxWidth would exceed + * the containing tree element's size, it will be automatically limited for you to the container width, taking + * scroll and client offsets into account prior to each edit. + */ + maxWidth: 250, + + editDelay : 350, + + // private + fitToTree : function(ed, el){ + var td = this.tree.getTreeEl().dom, nd = el.dom; + if(td.scrollLeft > nd.offsetLeft){ // ensure the node left point is visible + td.scrollLeft = nd.offsetLeft; + } + var w = Math.min( + this.maxWidth, + (td.clientWidth > 20 ? td.clientWidth : td.offsetWidth) - Math.max(0, nd.offsetLeft-td.scrollLeft) - /*cushion*/5); + this.setSize(w, ''); + + return this.fireEvent('beforenodeedit', this, this.editNode); + + }, + + // private + triggerEdit : function(node){ + this.completeEdit(); + this.editNode = node; + this.startEdit(node.ui.textNode, node.text); + }, + + // private + bindScroll : function(){ + this.tree.getTreeEl().on('scroll', this.cancelEdit, this); + }, + + // private + beforeNodeClick : function(node, e){ + var sinceLast = (this.lastClick ? this.lastClick.getElapsed() : 0); + this.lastClick = new Date(); + if(sinceLast > this.editDelay && this.tree.getSelectionModel().isSelected(node)){ + e.stopEvent(); + this.triggerEdit(node); + return false; + } + return true; + }, + + // private + updateNode : function(ed, value){ + this.tree.getTreeEl().un('scroll', this.cancelEdit, this); + this.editNode.setText(value); + }, + + // private + onHide : function(){ + Roo.tree.TreeEditor.superclass.onHide.call(this); + if(this.editNode){ + this.editNode.ui.focus(); + } + }, + + // private + onSpecialKey : function(field, e){ + var k = e.getKey(); + if(k == e.ESC){ + e.stopEvent(); + this.cancelEdit(); + }else if(k == e.ENTER && !e.hasModifier()){ + e.stopEvent(); + this.completeEdit(); + } + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_tree_TreeFilter.js.html b/docs2/src/Roo_tree_TreeFilter.js.html new file mode 100644 index 0000000000..077c91598c --- /dev/null +++ b/docs2/src/Roo_tree_TreeFilter.js.html @@ -0,0 +1,120 @@ +/home/alan/gitlive/roojs1/Roo/tree/TreeFilter.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** +* @class Roo.tree.TreeFilter +* Note this class is experimental and doesn't update the indent (lines) or expand collapse icons of the nodes +* @param {TreePanel} tree +* @param {Object} config (optional) + */ +Roo.tree.TreeFilter = function(tree, config){ + this.tree = tree; + this.filtered = {}; + Roo.apply(this, config); +}; + +Roo.tree.TreeFilter.prototype = { + clearBlank:false, + reverse:false, + autoClear:false, + remove:false, + + /** + * Filter the data by a specific attribute. + * @param {String/RegExp} value Either string that the attribute value + * should start with or a RegExp to test against the attribute + * @param {String} attr (optional) The attribute passed in your node's attributes collection. Defaults to "text". + * @param {TreeNode} startNode (optional) The node to start the filter at. + */ + filter : function(value, attr, startNode){ + attr = attr || "text"; + var f; + if(typeof value == "string"){ + var vlen = value.length; + // auto clear empty filter + if(vlen == 0 && this.clearBlank){ + this.clear(); + return; + } + value = value.toLowerCase(); + f = function(n){ + return n.attributes[attr].substr(0, vlen).toLowerCase() == value; + }; + }else if(value.exec){ // regex? + f = function(n){ + return value.test(n.attributes[attr]); + }; + }else{ + throw 'Illegal filter type, must be string or regex'; + } + this.filterBy(f, null, startNode); + }, + + /** + * Filter by a function. The passed function will be called with each + * node in the tree (or from the startNode). If the function returns true, the node is kept + * otherwise it is filtered. If a node is filtered, its children are also filtered. + * @param {Function} fn The filter function + * @param {Object} scope (optional) The scope of the function (defaults to the current node) + */ + filterBy : function(fn, scope, startNode){ + startNode = startNode || this.tree.root; + if(this.autoClear){ + this.clear(); + } + var af = this.filtered, rv = this.reverse; + var f = function(n){ + if(n == startNode){ + return true; + } + if(af[n.id]){ + return false; + } + var m = fn.call(scope || n, n); + if(!m || rv){ + af[n.id] = n; + n.ui.hide(); + return false; + } + return true; + }; + startNode.cascade(f); + if(this.remove){ + for(var id in af){ + if(typeof id != "function"){ + var n = af[id]; + if(n && n.parentNode){ + n.parentNode.removeChild(n); + } + } + } + } + }, + + /** + * Clears the current filter. Note: with the "remove" option + * set a filter cannot be cleared. + */ + clear : function(){ + var t = this.tree; + var af = this.filtered; + for(var id in af){ + if(typeof id != "function"){ + var n = af[id]; + if(n){ + n.ui.show(); + } + } + } + this.filtered = {}; + } +}; + \ No newline at end of file diff --git a/docs2/src/Roo_tree_TreeLoader.js.html b/docs2/src/Roo_tree_TreeLoader.js.html new file mode 100644 index 0000000000..82ff8e345d --- /dev/null +++ b/docs2/src/Roo_tree_TreeLoader.js.html @@ -0,0 +1,298 @@ +/home/alan/gitlive/roojs1/Roo/tree/TreeLoader.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.tree.TreeLoader + * @extends Roo.util.Observable + * A TreeLoader provides for lazy loading of an {@link Roo.tree.TreeNode}'s child + * nodes from a specified URL. The response must be a javascript Array definition + * who's elements are node definition objects. eg: + * <pre><code> +{ success : true, + data : [ + + { 'id': 1, 'text': 'A folder Node', 'leaf': false }, + { 'id': 2, 'text': 'A leaf Node', 'leaf': true } + ] +} + + +</code></pre> + * <br><br> + * The old style respose with just an array is still supported, but not recommended. + * <br><br> + * + * A server request is sent, and child nodes are loaded only when a node is expanded. + * The loading node's id is passed to the server under the parameter name "node" to + * enable the server to produce the correct child nodes. + * <br><br> + * To pass extra parameters, an event handler may be attached to the "beforeload" + * event, and the parameters specified in the TreeLoader's baseParams property: + * <pre><code> + myTreeLoader.on("beforeload", function(treeLoader, node) { + this.baseParams.category = node.attributes.category; + }, this); +</code></pre>< + * This would pass an HTTP parameter called "category" to the server containing + * the value of the Node's "category" attribute. + * @constructor + * Creates a new Treeloader. + * @param {Object} config A config object containing config properties. + */ +Roo.tree.TreeLoader = function(config){ + this.baseParams = {}; + this.requestMethod = "POST"; + Roo.apply(this, config); + + this.addEvents({ + + /** + * @event beforeload + * Fires before a network request is made to retrieve the Json text which specifies a node's children. + * @param {Object} This TreeLoader object. + * @param {Object} node The {@link Roo.tree.TreeNode} object being loaded. + * @param {Object} callback The callback function specified in the {@link #load} call. + */ + beforeload : true, + /** + * @event load + * Fires when the node has been successfuly loaded. + * @param {Object} This TreeLoader object. + * @param {Object} node The {@link Roo.tree.TreeNode} object being loaded. + * @param {Object} response The response object containing the data from the server. + */ + load : true, + /** + * @event loadexception + * Fires if the network request failed. + * @param {Object} This TreeLoader object. + * @param {Object} node The {@link Roo.tree.TreeNode} object being loaded. + * @param {Object} response The response object containing the data from the server. + */ + loadexception : true, + /** + * @event create + * Fires before a node is created, enabling you to return custom Node types + * @param {Object} This TreeLoader object. + * @param {Object} attr - the data returned from the AJAX call (modify it to suit) + */ + create : true + }); + + Roo.tree.TreeLoader.superclass.constructor.call(this); +}; + +Roo.extend(Roo.tree.TreeLoader, Roo.util.Observable, { + /** + * @cfg {String} dataUrl The URL from which to request a Json string which + * specifies an array of node definition object representing the child nodes + * to be loaded. + */ + /** + * @cfg {String} requestMethod either GET or POST + * defaults to POST (due to BC) + * to be loaded. + */ + /** + * @cfg {Object} baseParams (optional) An object containing properties which + * specify HTTP parameters to be passed to each request for child nodes. + */ + /** + * @cfg {Object} baseAttrs (optional) An object containing attributes to be added to all nodes + * created by this loader. If the attributes sent by the server have an attribute in this object, + * they take priority. + */ + /** + * @cfg {Object} uiProviders (optional) An object containing properties which + * + * DEPRECATED - use 'create' event handler to modify attributes - which affect creation. + * specify custom {@link Roo.tree.TreeNodeUI} implementations. If the optional + * <i>uiProvider</i> attribute of a returned child node is a string rather + * than a reference to a TreeNodeUI implementation, this that string value + * is used as a property name in the uiProviders object. You can define the provider named + * 'default' , and this will be used for all nodes (if no uiProvider is delivered by the node data) + */ + uiProviders : {}, + + /** + * @cfg {Boolean} clearOnLoad (optional) Default to true. Remove previously existing + * child nodes before loading. + */ + clearOnLoad : true, + + /** + * @cfg {String} root (optional) Default to false. Use this to read data from an object + * property on loading, rather than expecting an array. (eg. more compatible to a standard + * Grid query { data : [ .....] } + */ + + root : false, + /** + * @cfg {String} queryParam (optional) + * Name of the query as it will be passed on the querystring (defaults to 'node') + * eg. the request will be ?node=[id] + */ + + + queryParam: false, + + /** + * Load an {@link Roo.tree.TreeNode} from the URL specified in the constructor. + * This is called automatically when a node is expanded, but may be used to reload + * a node (or append new children if the {@link #clearOnLoad} option is false.) + * @param {Roo.tree.TreeNode} node + * @param {Function} callback + */ + load : function(node, callback){ + if(this.clearOnLoad){ + while(node.firstChild){ + node.removeChild(node.firstChild); + } + } + if(node.attributes.children){ // preloaded json children + var cs = node.attributes.children; + for(var i = 0, len = cs.length; i < len; i++){ + node.appendChild(this.createNode(cs[i])); + } + if(typeof callback == "function"){ + callback(); + } + }else if(this.dataUrl){ + this.requestData(node, callback); + } + }, + + getParams: function(node){ + var buf = [], bp = this.baseParams; + for(var key in bp){ + if(typeof bp[key] != "function"){ + buf.push(encodeURIComponent(key), "=", encodeURIComponent(bp[key]), "&"); + } + } + var n = this.queryParam === false ? 'node' : this.queryParam; + buf.push(n + "=", encodeURIComponent(node.id)); + return buf.join(""); + }, + + requestData : function(node, callback){ + if(this.fireEvent("beforeload", this, node, callback) !== false){ + this.transId = Roo.Ajax.request({ + method:this.requestMethod, + url: this.dataUrl||this.url, + success: this.handleResponse, + failure: this.handleFailure, + scope: this, + argument: {callback: callback, node: node}, + params: this.getParams(node) + }); + }else{ + // if the load is cancelled, make sure we notify + // the node that we are done + if(typeof callback == "function"){ + callback(); + } + } + }, + + isLoading : function(){ + return this.transId ? true : false; + }, + + abort : function(){ + if(this.isLoading()){ + Roo.Ajax.abort(this.transId); + } + }, + + // private + createNode : function(attr) + { + // apply baseAttrs, nice idea Corey! + if(this.baseAttrs){ + Roo.applyIf(attr, this.baseAttrs); + } + if(this.applyLoader !== false){ + attr.loader = this; + } + // uiProvider = depreciated.. + + if(typeof(attr.uiProvider) == 'string'){ + attr.uiProvider = this.uiProviders[attr.uiProvider] || + /** eval:var:attr */ eval(attr.uiProvider); + } + if(typeof(this.uiProviders['default']) != 'undefined') { + attr.uiProvider = this.uiProviders['default']; + } + + this.fireEvent('create', this, attr); + + attr.leaf = typeof(attr.leaf) == 'string' ? attr.leaf * 1 : attr.leaf; + return(attr.leaf ? + new Roo.tree.TreeNode(attr) : + new Roo.tree.AsyncTreeNode(attr)); + }, + + processResponse : function(response, node, callback) + { + var json = response.responseText; + try { + + var o = Roo.decode(json); + + if (this.root === false && typeof(o.success) != undefined) { + this.root = 'data'; // the default behaviour for list like data.. + } + + if (this.root !== false && !o.success) { + // it's a failure condition. + var a = response.argument; + this.fireEvent("loadexception", this, a.node, response); + Roo.log("Load failed - should have a handler really"); + return; + } + + + + if (this.root !== false) { + o = o[this.root]; + } + + for(var i = 0, len = o.length; i < len; i++){ + var n = this.createNode(o[i]); + if(n){ + node.appendChild(n); + } + } + if(typeof callback == "function"){ + callback(this, node); + } + }catch(e){ + this.handleFailure(response); + } + }, + + handleResponse : function(response){ + this.transId = false; + var a = response.argument; + this.processResponse(response, a.node, a.callback); + this.fireEvent("load", this, a.node, response); + }, + + handleFailure : function(response) + { + // should handle failure better.. + this.transId = false; + var a = response.argument; + this.fireEvent("loadexception", this, a.node, response); + if(typeof a.callback == "function"){ + a.callback(this, a.node); + } + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_tree_TreeNode.js.html b/docs2/src/Roo_tree_TreeNode.js.html new file mode 100644 index 0000000000..d21dc5699b --- /dev/null +++ b/docs2/src/Roo_tree_TreeNode.js.html @@ -0,0 +1,498 @@ +/home/alan/gitlive/roojs1/Roo/tree/TreeNode.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.tree.TreeNode + * @extends Roo.data.Node + * @cfg {String} text The text for this node + * @cfg {Boolean} expanded true to start the node expanded + * @cfg {Boolean} allowDrag false to make this node undraggable if DD is on (defaults to true) + * @cfg {Boolean} allowDrop false if this node cannot be drop on + * @cfg {Boolean} disabled true to start the node disabled + * @cfg {String} icon The path to an icon for the node. The preferred way to do this + * is to use the cls or iconCls attributes and add the icon via a CSS background image. + * @cfg {String} cls A css class to be added to the node + * @cfg {String} iconCls A css class to be added to the nodes icon element for applying css background images + * @cfg {String} href URL of the link used for the node (defaults to #) + * @cfg {String} hrefTarget target frame for the link + * @cfg {String} qtip An Ext QuickTip for the node + * @cfg {String} qtipCfg An Ext QuickTip config for the node (used instead of qtip) + * @cfg {Boolean} singleClickExpand True for single click expand on this node + * @cfg {Function} uiProvider A UI <b>class</b> to use for this node (defaults to Roo.tree.TreeNodeUI) + * @cfg {Boolean} checked True to render a checked checkbox for this node, false to render an unchecked checkbox + * (defaults to undefined with no checkbox rendered) + * @constructor + * @param {Object/String} attributes The attributes/config for the node or just a string with the text for the node + */ +Roo.tree.TreeNode = function(attributes){ + attributes = attributes || {}; + if(typeof attributes == "string"){ + attributes = {text: attributes}; + } + this.childrenRendered = false; + this.rendered = false; + Roo.tree.TreeNode.superclass.constructor.call(this, attributes); + this.expanded = attributes.expanded === true; + this.isTarget = attributes.isTarget !== false; + this.draggable = attributes.draggable !== false && attributes.allowDrag !== false; + this.allowChildren = attributes.allowChildren !== false && attributes.allowDrop !== false; + + /** + * Read-only. The text for this node. To change it use setText(). + * @type String + */ + this.text = attributes.text; + /** + * True if this node is disabled. + * @type Boolean + */ + this.disabled = attributes.disabled === true; + + this.addEvents({ + /** + * @event textchange + * Fires when the text for this node is changed + * @param {Node} this This node + * @param {String} text The new text + * @param {String} oldText The old text + */ + "textchange" : true, + /** + * @event beforeexpand + * Fires before this node is expanded, return false to cancel. + * @param {Node} this This node + * @param {Boolean} deep + * @param {Boolean} anim + */ + "beforeexpand" : true, + /** + * @event beforecollapse + * Fires before this node is collapsed, return false to cancel. + * @param {Node} this This node + * @param {Boolean} deep + * @param {Boolean} anim + */ + "beforecollapse" : true, + /** + * @event expand + * Fires when this node is expanded + * @param {Node} this This node + */ + "expand" : true, + /** + * @event disabledchange + * Fires when the disabled status of this node changes + * @param {Node} this This node + * @param {Boolean} disabled + */ + "disabledchange" : true, + /** + * @event collapse + * Fires when this node is collapsed + * @param {Node} this This node + */ + "collapse" : true, + /** + * @event beforeclick + * Fires before click processing. Return false to cancel the default action. + * @param {Node} this This node + * @param {Roo.EventObject} e The event object + */ + "beforeclick":true, + /** + * @event checkchange + * Fires when a node with a checkbox's checked property changes + * @param {Node} this This node + * @param {Boolean} checked + */ + "checkchange":true, + /** + * @event click + * Fires when this node is clicked + * @param {Node} this This node + * @param {Roo.EventObject} e The event object + */ + "click":true, + /** + * @event dblclick + * Fires when this node is double clicked + * @param {Node} this This node + * @param {Roo.EventObject} e The event object + */ + "dblclick":true, + /** + * @event contextmenu + * Fires when this node is right clicked + * @param {Node} this This node + * @param {Roo.EventObject} e The event object + */ + "contextmenu":true, + /** + * @event beforechildrenrendered + * Fires right before the child nodes for this node are rendered + * @param {Node} this This node + */ + "beforechildrenrendered":true + }); + + var uiClass = this.attributes.uiProvider || Roo.tree.TreeNodeUI; + + /** + * Read-only. The UI for this node + * @type TreeNodeUI + */ + this.ui = new uiClass(this); + + // finally support items[] + if (typeof(this.attributes.items) == 'undefined' || !this.attributes.items) { + return; + } + + + Roo.each(this.attributes.items, function(c) { + this.appendChild(Roo.factory(c,Roo.Tree)); + }, this); + delete this.attributes.items; + + + +}; +Roo.extend(Roo.tree.TreeNode, Roo.data.Node, { + preventHScroll: true, + /** + * Returns true if this node is expanded + * @return {Boolean} + */ + isExpanded : function(){ + return this.expanded; + }, + + /** + * Returns the UI object for this node + * @return {TreeNodeUI} + */ + getUI : function(){ + return this.ui; + }, + + // private override + setFirstChild : function(node){ + var of = this.firstChild; + Roo.tree.TreeNode.superclass.setFirstChild.call(this, node); + if(this.childrenRendered && of && node != of){ + of.renderIndent(true, true); + } + if(this.rendered){ + this.renderIndent(true, true); + } + }, + + // private override + setLastChild : function(node){ + var ol = this.lastChild; + Roo.tree.TreeNode.superclass.setLastChild.call(this, node); + if(this.childrenRendered && ol && node != ol){ + ol.renderIndent(true, true); + } + if(this.rendered){ + this.renderIndent(true, true); + } + }, + + // these methods are overridden to provide lazy rendering support + // private override + appendChild : function() + { + var node = Roo.tree.TreeNode.superclass.appendChild.apply(this, arguments); + if(node && this.childrenRendered){ + node.render(); + } + this.ui.updateExpandIcon(); + return node; + }, + + // private override + removeChild : function(node){ + this.ownerTree.getSelectionModel().unselect(node); + Roo.tree.TreeNode.superclass.removeChild.apply(this, arguments); + // if it's been rendered remove dom node + if(this.childrenRendered){ + node.ui.remove(); + } + if(this.childNodes.length < 1){ + this.collapse(false, false); + }else{ + this.ui.updateExpandIcon(); + } + if(!this.firstChild) { + this.childrenRendered = false; + } + return node; + }, + + // private override + insertBefore : function(node, refNode){ + var newNode = Roo.tree.TreeNode.superclass.insertBefore.apply(this, arguments); + if(newNode && refNode && this.childrenRendered){ + node.render(); + } + this.ui.updateExpandIcon(); + return newNode; + }, + + /** + * Sets the text for this node + * @param {String} text + */ + setText : function(text){ + var oldText = this.text; + this.text = text; + this.attributes.text = text; + if(this.rendered){ // event without subscribing + this.ui.onTextChange(this, text, oldText); + } + this.fireEvent("textchange", this, text, oldText); + }, + + /** + * Triggers selection of this node + */ + select : function(){ + this.getOwnerTree().getSelectionModel().select(this); + }, + + /** + * Triggers deselection of this node + */ + unselect : function(){ + this.getOwnerTree().getSelectionModel().unselect(this); + }, + + /** + * Returns true if this node is selected + * @return {Boolean} + */ + isSelected : function(){ + return this.getOwnerTree().getSelectionModel().isSelected(this); + }, + + /** + * Expand this node. + * @param {Boolean} deep (optional) True to expand all children as well + * @param {Boolean} anim (optional) false to cancel the default animation + * @param {Function} callback (optional) A callback to be called when + * expanding this node completes (does not wait for deep expand to complete). + * Called with 1 parameter, this node. + */ + expand : function(deep, anim, callback){ + if(!this.expanded){ + if(this.fireEvent("beforeexpand", this, deep, anim) === false){ + return; + } + if(!this.childrenRendered){ + this.renderChildren(); + } + this.expanded = true; + if(!this.isHiddenRoot() && (this.getOwnerTree().animate && anim !== false) || anim){ + this.ui.animExpand(function(){ + this.fireEvent("expand", this); + if(typeof callback == "function"){ + callback(this); + } + if(deep === true){ + this.expandChildNodes(true); + } + }.createDelegate(this)); + return; + }else{ + this.ui.expand(); + this.fireEvent("expand", this); + if(typeof callback == "function"){ + callback(this); + } + } + }else{ + if(typeof callback == "function"){ + callback(this); + } + } + if(deep === true){ + this.expandChildNodes(true); + } + }, + + isHiddenRoot : function(){ + return this.isRoot && !this.getOwnerTree().rootVisible; + }, + + /** + * Collapse this node. + * @param {Boolean} deep (optional) True to collapse all children as well + * @param {Boolean} anim (optional) false to cancel the default animation + */ + collapse : function(deep, anim){ + if(this.expanded && !this.isHiddenRoot()){ + if(this.fireEvent("beforecollapse", this, deep, anim) === false){ + return; + } + this.expanded = false; + if((this.getOwnerTree().animate && anim !== false) || anim){ + this.ui.animCollapse(function(){ + this.fireEvent("collapse", this); + if(deep === true){ + this.collapseChildNodes(true); + } + }.createDelegate(this)); + return; + }else{ + this.ui.collapse(); + this.fireEvent("collapse", this); + } + } + if(deep === true){ + var cs = this.childNodes; + for(var i = 0, len = cs.length; i < len; i++) { + cs[i].collapse(true, false); + } + } + }, + + // private + delayedExpand : function(delay){ + if(!this.expandProcId){ + this.expandProcId = this.expand.defer(delay, this); + } + }, + + // private + cancelExpand : function(){ + if(this.expandProcId){ + clearTimeout(this.expandProcId); + } + this.expandProcId = false; + }, + + /** + * Toggles expanded/collapsed state of the node + */ + toggle : function(){ + if(this.expanded){ + this.collapse(); + }else{ + this.expand(); + } + }, + + /** + * Ensures all parent nodes are expanded + */ + ensureVisible : function(callback){ + var tree = this.getOwnerTree(); + tree.expandPath(this.parentNode.getPath(), false, function(){ + tree.getTreeEl().scrollChildIntoView(this.ui.anchor); + Roo.callback(callback); + }.createDelegate(this)); + }, + + /** + * Expand all child nodes + * @param {Boolean} deep (optional) true if the child nodes should also expand their child nodes + */ + expandChildNodes : function(deep){ + var cs = this.childNodes; + for(var i = 0, len = cs.length; i < len; i++) { + cs[i].expand(deep); + } + }, + + /** + * Collapse all child nodes + * @param {Boolean} deep (optional) true if the child nodes should also collapse their child nodes + */ + collapseChildNodes : function(deep){ + var cs = this.childNodes; + for(var i = 0, len = cs.length; i < len; i++) { + cs[i].collapse(deep); + } + }, + + /** + * Disables this node + */ + disable : function(){ + this.disabled = true; + this.unselect(); + if(this.rendered && this.ui.onDisableChange){ // event without subscribing + this.ui.onDisableChange(this, true); + } + this.fireEvent("disabledchange", this, true); + }, + + /** + * Enables this node + */ + enable : function(){ + this.disabled = false; + if(this.rendered && this.ui.onDisableChange){ // event without subscribing + this.ui.onDisableChange(this, false); + } + this.fireEvent("disabledchange", this, false); + }, + + // private + renderChildren : function(suppressEvent){ + if(suppressEvent !== false){ + this.fireEvent("beforechildrenrendered", this); + } + var cs = this.childNodes; + for(var i = 0, len = cs.length; i < len; i++){ + cs[i].render(true); + } + this.childrenRendered = true; + }, + + // private + sort : function(fn, scope){ + Roo.tree.TreeNode.superclass.sort.apply(this, arguments); + if(this.childrenRendered){ + var cs = this.childNodes; + for(var i = 0, len = cs.length; i < len; i++){ + cs[i].render(true); + } + } + }, + + // private + render : function(bulkRender){ + this.ui.render(bulkRender); + if(!this.rendered){ + this.rendered = true; + if(this.expanded){ + this.expanded = false; + this.expand(false, false); + } + } + }, + + // private + renderIndent : function(deep, refresh){ + if(refresh){ + this.ui.childIndent = null; + } + this.ui.renderIndent(); + if(deep === true && this.childrenRendered){ + var cs = this.childNodes; + for(var i = 0, len = cs.length; i < len; i++){ + cs[i].renderIndent(true, refresh); + } + } + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_tree_TreeNodeUI.js.html b/docs2/src/Roo_tree_TreeNodeUI.js.html new file mode 100644 index 0000000000..bb847ed00d --- /dev/null +++ b/docs2/src/Roo_tree_TreeNodeUI.js.html @@ -0,0 +1,535 @@ +/home/alan/gitlive/roojs1/Roo/tree/TreeNodeUI.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.tree.TreeNodeUI + * @constructor + * @param {Object} node The node to render + * The TreeNode UI implementation is separate from the + * tree implementation. Unless you are customizing the tree UI, + * you should never have to use this directly. + */ +Roo.tree.TreeNodeUI = function(node){ + this.node = node; + this.rendered = false; + this.animating = false; + this.emptyIcon = Roo.BLANK_IMAGE_URL; +}; + +Roo.tree.TreeNodeUI.prototype = { + removeChild : function(node){ + if(this.rendered){ + this.ctNode.removeChild(node.ui.getEl()); + } + }, + + beforeLoad : function(){ + this.addClass("x-tree-node-loading"); + }, + + afterLoad : function(){ + this.removeClass("x-tree-node-loading"); + }, + + onTextChange : function(node, text, oldText){ + if(this.rendered){ + this.textNode.innerHTML = text; + } + }, + + onDisableChange : function(node, state){ + this.disabled = state; + if(state){ + this.addClass("x-tree-node-disabled"); + }else{ + this.removeClass("x-tree-node-disabled"); + } + }, + + onSelectedChange : function(state){ + if(state){ + this.focus(); + this.addClass("x-tree-selected"); + }else{ + //this.blur(); + this.removeClass("x-tree-selected"); + } + }, + + onMove : function(tree, node, oldParent, newParent, index, refNode){ + this.childIndent = null; + if(this.rendered){ + var targetNode = newParent.ui.getContainer(); + if(!targetNode){//target not rendered + this.holder = document.createElement("div"); + this.holder.appendChild(this.wrap); + return; + } + var insertBefore = refNode ? refNode.ui.getEl() : null; + if(insertBefore){ + targetNode.insertBefore(this.wrap, insertBefore); + }else{ + targetNode.appendChild(this.wrap); + } + this.node.renderIndent(true); + } + }, + + addClass : function(cls){ + if(this.elNode){ + Roo.fly(this.elNode).addClass(cls); + } + }, + + removeClass : function(cls){ + if(this.elNode){ + Roo.fly(this.elNode).removeClass(cls); + } + }, + + remove : function(){ + if(this.rendered){ + this.holder = document.createElement("div"); + this.holder.appendChild(this.wrap); + } + }, + + fireEvent : function(){ + return this.node.fireEvent.apply(this.node, arguments); + }, + + initEvents : function(){ + this.node.on("move", this.onMove, this); + var E = Roo.EventManager; + var a = this.anchor; + + var el = Roo.fly(a, '_treeui'); + + if(Roo.isOpera){ // opera render bug ignores the CSS + el.setStyle("text-decoration", "none"); + } + + el.on("click", this.onClick, this); + el.on("dblclick", this.onDblClick, this); + + if(this.checkbox){ + Roo.EventManager.on(this.checkbox, + Roo.isIE ? 'click' : 'change', this.onCheckChange, this); + } + + el.on("contextmenu", this.onContextMenu, this); + + var icon = Roo.fly(this.iconNode); + icon.on("click", this.onClick, this); + icon.on("dblclick", this.onDblClick, this); + icon.on("contextmenu", this.onContextMenu, this); + E.on(this.ecNode, "click", this.ecClick, this, true); + + if(this.node.disabled){ + this.addClass("x-tree-node-disabled"); + } + if(this.node.hidden){ + this.addClass("x-tree-node-disabled"); + } + var ot = this.node.getOwnerTree(); + var dd = ot.enableDD || ot.enableDrag || ot.enableDrop; + if(dd && (!this.node.isRoot || ot.rootVisible)){ + Roo.dd.Registry.register(this.elNode, { + node: this.node, + handles: this.getDDHandles(), + isHandle: false + }); + } + }, + + getDDHandles : function(){ + return [this.iconNode, this.textNode]; + }, + + hide : function(){ + if(this.rendered){ + this.wrap.style.display = "none"; + } + }, + + show : function(){ + if(this.rendered){ + this.wrap.style.display = ""; + } + }, + + onContextMenu : function(e){ + if (this.node.hasListener("contextmenu") || this.node.getOwnerTree().hasListener("contextmenu")) { + e.preventDefault(); + this.focus(); + this.fireEvent("contextmenu", this.node, e); + } + }, + + onClick : function(e){ + if(this.dropping){ + e.stopEvent(); + return; + } + if(this.fireEvent("beforeclick", this.node, e) !== false){ + if(!this.disabled && this.node.attributes.href){ + this.fireEvent("click", this.node, e); + return; + } + e.preventDefault(); + if(this.disabled){ + return; + } + + if(this.node.attributes.singleClickExpand && !this.animating && this.node.hasChildNodes()){ + this.node.toggle(); + } + + this.fireEvent("click", this.node, e); + }else{ + e.stopEvent(); + } + }, + + onDblClick : function(e){ + e.preventDefault(); + if(this.disabled){ + return; + } + if(this.checkbox){ + this.toggleCheck(); + } + if(!this.animating && this.node.hasChildNodes()){ + this.node.toggle(); + } + this.fireEvent("dblclick", this.node, e); + }, + + onCheckChange : function(){ + var checked = this.checkbox.checked; + this.node.attributes.checked = checked; + this.fireEvent('checkchange', this.node, checked); + }, + + ecClick : function(e){ + if(!this.animating && this.node.hasChildNodes()){ + this.node.toggle(); + } + }, + + startDrop : function(){ + this.dropping = true; + }, + + // delayed drop so the click event doesn't get fired on a drop + endDrop : function(){ + setTimeout(function(){ + this.dropping = false; + }.createDelegate(this), 50); + }, + + expand : function(){ + this.updateExpandIcon(); + this.ctNode.style.display = ""; + }, + + focus : function(){ + if(!this.node.preventHScroll){ + try{this.anchor.focus(); + }catch(e){} + }else if(!Roo.isIE){ + try{ + var noscroll = this.node.getOwnerTree().getTreeEl().dom; + var l = noscroll.scrollLeft; + this.anchor.focus(); + noscroll.scrollLeft = l; + }catch(e){} + } + }, + + toggleCheck : function(value){ + var cb = this.checkbox; + if(cb){ + cb.checked = (value === undefined ? !cb.checked : value); + } + }, + + blur : function(){ + try{ + this.anchor.blur(); + }catch(e){} + }, + + animExpand : function(callback){ + var ct = Roo.get(this.ctNode); + ct.stopFx(); + if(!this.node.hasChildNodes()){ + this.updateExpandIcon(); + this.ctNode.style.display = ""; + Roo.callback(callback); + return; + } + this.animating = true; + this.updateExpandIcon(); + + ct.slideIn('t', { + callback : function(){ + this.animating = false; + Roo.callback(callback); + }, + scope: this, + duration: this.node.ownerTree.duration || .25 + }); + }, + + highlight : function(){ + var tree = this.node.getOwnerTree(); + Roo.fly(this.wrap).highlight( + tree.hlColor || "C3DAF9", + {endColor: tree.hlBaseColor} + ); + }, + + collapse : function(){ + this.updateExpandIcon(); + this.ctNode.style.display = "none"; + }, + + animCollapse : function(callback){ + var ct = Roo.get(this.ctNode); + ct.enableDisplayMode('block'); + ct.stopFx(); + + this.animating = true; + this.updateExpandIcon(); + + ct.slideOut('t', { + callback : function(){ + this.animating = false; + Roo.callback(callback); + }, + scope: this, + duration: this.node.ownerTree.duration || .25 + }); + }, + + getContainer : function(){ + return this.ctNode; + }, + + getEl : function(){ + return this.wrap; + }, + + appendDDGhost : function(ghostNode){ + ghostNode.appendChild(this.elNode.cloneNode(true)); + }, + + getDDRepairXY : function(){ + return Roo.lib.Dom.getXY(this.iconNode); + }, + + onRender : function(){ + this.render(); + }, + + render : function(bulkRender){ + var n = this.node, a = n.attributes; + var targetNode = n.parentNode ? + n.parentNode.ui.getContainer() : n.ownerTree.innerCt.dom; + + if(!this.rendered){ + this.rendered = true; + + this.renderElements(n, a, targetNode, bulkRender); + + if(a.qtip){ + if(this.textNode.setAttributeNS){ + this.textNode.setAttributeNS("ext", "qtip", a.qtip); + if(a.qtipTitle){ + this.textNode.setAttributeNS("ext", "qtitle", a.qtipTitle); + } + }else{ + this.textNode.setAttribute("ext:qtip", a.qtip); + if(a.qtipTitle){ + this.textNode.setAttribute("ext:qtitle", a.qtipTitle); + } + } + }else if(a.qtipCfg){ + a.qtipCfg.target = Roo.id(this.textNode); + Roo.QuickTips.register(a.qtipCfg); + } + this.initEvents(); + if(!this.node.expanded){ + this.updateExpandIcon(); + } + }else{ + if(bulkRender === true) { + targetNode.appendChild(this.wrap); + } + } + }, + + renderElements : function(n, a, targetNode, bulkRender) + { + // add some indent caching, this helps performance when rendering a large tree + this.indentMarkup = n.parentNode ? n.parentNode.ui.getChildIndent() : ''; + var t = n.getOwnerTree(); + var txt = t.renderer ? t.renderer(n.attributes) : Roo.util.Format.htmlEncode(n.text); + if (typeof(n.attributes.html) != 'undefined') { + txt = n.attributes.html; + } + var tip = t.rendererTip ? t.rendererTip(n.attributes) : txt; + var cb = typeof a.checked == 'boolean'; + var href = a.href ? a.href : Roo.isGecko ? "" : "#"; + var buf = ['<li class="x-tree-node"><div class="x-tree-node-el ', a.cls,'">', + '<span class="x-tree-node-indent">',this.indentMarkup,"</span>", + '<img src="', this.emptyIcon, '" class="x-tree-ec-icon" />', + '<img src="', a.icon || this.emptyIcon, '" class="x-tree-node-icon',(a.icon ? " x-tree-node-inline-icon" : ""),(a.iconCls ? " "+a.iconCls : ""),'" unselectable="on" />', + cb ? ('<input class="x-tree-node-cb" type="checkbox" ' + (a.checked ? 'checked="checked" />' : ' />')) : '', + '<a hidefocus="on" href="',href,'" tabIndex="1" ', + a.hrefTarget ? ' target="'+a.hrefTarget+'"' : "", + '><span unselectable="on" qtip="' , tip ,'">',txt,"</span></a></div>", + '<ul class="x-tree-node-ct" style="display:none;"></ul>', + "</li>"]; + + if(bulkRender !== true && n.nextSibling && n.nextSibling.ui.getEl()){ + this.wrap = Roo.DomHelper.insertHtml("beforeBegin", + n.nextSibling.ui.getEl(), buf.join("")); + }else{ + this.wrap = Roo.DomHelper.insertHtml("beforeEnd", targetNode, buf.join("")); + } + + this.elNode = this.wrap.childNodes[0]; + this.ctNode = this.wrap.childNodes[1]; + var cs = this.elNode.childNodes; + this.indentNode = cs[0]; + this.ecNode = cs[1]; + this.iconNode = cs[2]; + var index = 3; + if(cb){ + this.checkbox = cs[3]; + index++; + } + this.anchor = cs[index]; + this.textNode = cs[index].firstChild; + }, + + getAnchor : function(){ + return this.anchor; + }, + + getTextEl : function(){ + return this.textNode; + }, + + getIconEl : function(){ + return this.iconNode; + }, + + isChecked : function(){ + return this.checkbox ? this.checkbox.checked : false; + }, + + updateExpandIcon : function(){ + if(this.rendered){ + var n = this.node, c1, c2; + var cls = n.isLast() ? "x-tree-elbow-end" : "x-tree-elbow"; + var hasChild = n.hasChildNodes(); + if(hasChild){ + if(n.expanded){ + cls += "-minus"; + c1 = "x-tree-node-collapsed"; + c2 = "x-tree-node-expanded"; + }else{ + cls += "-plus"; + c1 = "x-tree-node-expanded"; + c2 = "x-tree-node-collapsed"; + } + if(this.wasLeaf){ + this.removeClass("x-tree-node-leaf"); + this.wasLeaf = false; + } + if(this.c1 != c1 || this.c2 != c2){ + Roo.fly(this.elNode).replaceClass(c1, c2); + this.c1 = c1; this.c2 = c2; + } + }else{ + // this changes non-leafs into leafs if they have no children. + // it's not very rational behaviour.. + + if(!this.wasLeaf && this.node.leaf){ + Roo.fly(this.elNode).replaceClass("x-tree-node-expanded", "x-tree-node-leaf"); + delete this.c1; + delete this.c2; + this.wasLeaf = true; + } + } + var ecc = "x-tree-ec-icon "+cls; + if(this.ecc != ecc){ + this.ecNode.className = ecc; + this.ecc = ecc; + } + } + }, + + getChildIndent : function(){ + if(!this.childIndent){ + var buf = []; + var p = this.node; + while(p){ + if(!p.isRoot || (p.isRoot && p.ownerTree.rootVisible)){ + if(!p.isLast()) { + buf.unshift('<img src="'+this.emptyIcon+'" class="x-tree-elbow-line" />'); + } else { + buf.unshift('<img src="'+this.emptyIcon+'" class="x-tree-icon" />'); + } + } + p = p.parentNode; + } + this.childIndent = buf.join(""); + } + return this.childIndent; + }, + + renderIndent : function(){ + if(this.rendered){ + var indent = ""; + var p = this.node.parentNode; + if(p){ + indent = p.ui.getChildIndent(); + } + if(this.indentMarkup != indent){ // don't rerender if not required + this.indentNode.innerHTML = indent; + this.indentMarkup = indent; + } + this.updateExpandIcon(); + } + } +}; + +Roo.tree.RootTreeNodeUI = function(){ + Roo.tree.RootTreeNodeUI.superclass.constructor.apply(this, arguments); +}; +Roo.extend(Roo.tree.RootTreeNodeUI, Roo.tree.TreeNodeUI, { + render : function(){ + if(!this.rendered){ + var targetNode = this.node.ownerTree.innerCt.dom; + this.node.expanded = true; + targetNode.innerHTML = '<div class="x-tree-root-node"></div>'; + this.wrap = this.ctNode = targetNode.firstChild; + } + }, + collapse : function(){ + }, + expand : function(){ + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_tree_TreePanel.js.html b/docs2/src/Roo_tree_TreePanel.js.html new file mode 100644 index 0000000000..54c0f3a359 --- /dev/null +++ b/docs2/src/Roo_tree_TreePanel.js.html @@ -0,0 +1,469 @@ +/home/alan/gitlive/roojs1/Roo/tree/TreePanel.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.tree.TreePanel + * @extends Roo.data.Tree + + * @cfg {Boolean} rootVisible false to hide the root node (defaults to true) + * @cfg {Boolean} lines false to disable tree lines (defaults to true) + * @cfg {Boolean} enableDD true to enable drag and drop + * @cfg {Boolean} enableDrag true to enable just drag + * @cfg {Boolean} enableDrop true to enable just drop + * @cfg {Object} dragConfig Custom config to pass to the {@link Roo.tree.TreeDragZone} instance + * @cfg {Object} dropConfig Custom config to pass to the {@link Roo.tree.TreeDropZone} instance + * @cfg {String} ddGroup The DD group this TreePanel belongs to + * @cfg {String} ddAppendOnly True if the tree should only allow append drops (use for trees which are sorted) + * @cfg {Boolean} ddScroll true to enable YUI body scrolling + * @cfg {Boolean} containerScroll true to register this container with ScrollManager + * @cfg {Boolean} hlDrop false to disable node highlight on drop (defaults to the value of Roo.enableFx) + * @cfg {String} hlColor The color of the node highlight (defaults to C3DAF9) + * @cfg {Boolean} animate true to enable animated expand/collapse (defaults to the value of Roo.enableFx) + * @cfg {Boolean} singleExpand true if only 1 node per branch may be expanded + * @cfg {Boolean} selModel A tree selection model to use with this TreePanel (defaults to a {@link Roo.tree.DefaultSelectionModel}) + * @cfg {Boolean} loader A TreeLoader for use with this TreePanel + * @cfg {Object|Roo.tree.TreeEditor} editor The TreeEditor or xtype data to display when clicked. + * @cfg {String} pathSeparator The token used to separate sub-paths in path strings (defaults to '/') + * @cfg {Function} renderer DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes. to return HTML markup for the tree view. The render function is called with the following parameters:<ul><li>The {Object} The data for the node.</li></ul> + * @cfg {Function} rendererTip DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes hovertip to return HTML markup for the tree view. The render function is called with the following parameters:<ul><li>The {Object} The data for the node.</li></ul> + * + * @constructor + * @param {String/HTMLElement/Element} el The container element + * @param {Object} config + */ +Roo.tree.TreePanel = function(el, config){ + var root = false; + var loader = false; + if (config.root) { + root = config.root; + delete config.root; + } + if (config.loader) { + loader = config.loader; + delete config.loader; + } + + Roo.apply(this, config); + Roo.tree.TreePanel.superclass.constructor.call(this); + this.el = Roo.get(el); + this.el.addClass('x-tree'); + //console.log(root); + if (root) { + this.setRootNode( Roo.factory(root, Roo.tree)); + } + if (loader) { + this.loader = Roo.factory(loader, Roo.tree); + } + /** + * Read-only. The id of the container element becomes this TreePanel's id. + */ + this.id = this.el.id; + this.addEvents({ + /** + * @event beforeload + * Fires before a node is loaded, return false to cancel + * @param {Node} node The node being loaded + */ + "beforeload" : true, + /** + * @event load + * Fires when a node is loaded + * @param {Node} node The node that was loaded + */ + "load" : true, + /** + * @event textchange + * Fires when the text for a node is changed + * @param {Node} node The node + * @param {String} text The new text + * @param {String} oldText The old text + */ + "textchange" : true, + /** + * @event beforeexpand + * Fires before a node is expanded, return false to cancel. + * @param {Node} node The node + * @param {Boolean} deep + * @param {Boolean} anim + */ + "beforeexpand" : true, + /** + * @event beforecollapse + * Fires before a node is collapsed, return false to cancel. + * @param {Node} node The node + * @param {Boolean} deep + * @param {Boolean} anim + */ + "beforecollapse" : true, + /** + * @event expand + * Fires when a node is expanded + * @param {Node} node The node + */ + "expand" : true, + /** + * @event disabledchange + * Fires when the disabled status of a node changes + * @param {Node} node The node + * @param {Boolean} disabled + */ + "disabledchange" : true, + /** + * @event collapse + * Fires when a node is collapsed + * @param {Node} node The node + */ + "collapse" : true, + /** + * @event beforeclick + * Fires before click processing on a node. Return false to cancel the default action. + * @param {Node} node The node + * @param {Roo.EventObject} e The event object + */ + "beforeclick":true, + /** + * @event checkchange + * Fires when a node with a checkbox's checked property changes + * @param {Node} this This node + * @param {Boolean} checked + */ + "checkchange":true, + /** + * @event click + * Fires when a node is clicked + * @param {Node} node The node + * @param {Roo.EventObject} e The event object + */ + "click":true, + /** + * @event dblclick + * Fires when a node is double clicked + * @param {Node} node The node + * @param {Roo.EventObject} e The event object + */ + "dblclick":true, + /** + * @event contextmenu + * Fires when a node is right clicked + * @param {Node} node The node + * @param {Roo.EventObject} e The event object + */ + "contextmenu":true, + /** + * @event beforechildrenrendered + * Fires right before the child nodes for a node are rendered + * @param {Node} node The node + */ + "beforechildrenrendered":true, + /** + * @event startdrag + * Fires when a node starts being dragged + * @param {Roo.tree.TreePanel} this + * @param {Roo.tree.TreeNode} node + * @param {event} e The raw browser event + */ + "startdrag" : true, + /** + * @event enddrag + * Fires when a drag operation is complete + * @param {Roo.tree.TreePanel} this + * @param {Roo.tree.TreeNode} node + * @param {event} e The raw browser event + */ + "enddrag" : true, + /** + * @event dragdrop + * Fires when a dragged node is dropped on a valid DD target + * @param {Roo.tree.TreePanel} this + * @param {Roo.tree.TreeNode} node + * @param {DD} dd The dd it was dropped on + * @param {event} e The raw browser event + */ + "dragdrop" : true, + /** + * @event beforenodedrop + * Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The dropEvent + * passed to handlers has the following properties:<br /> + * <ul style="padding:5px;padding-left:16px;"> + * <li>tree - The TreePanel</li> + * <li>target - The node being targeted for the drop</li> + * <li>data - The drag data from the drag source</li> + * <li>point - The point of the drop - append, above or below</li> + * <li>source - The drag source</li> + * <li>rawEvent - Raw mouse event</li> + * <li>dropNode - Drop node(s) provided by the source <b>OR</b> you can supply node(s) + * to be inserted by setting them on this object.</li> + * <li>cancel - Set this to true to cancel the drop.</li> + * </ul> + * @param {Object} dropEvent + */ + "beforenodedrop" : true, + /** + * @event nodedrop + * Fires after a DD object is dropped on a node in this tree. The dropEvent + * passed to handlers has the following properties:<br /> + * <ul style="padding:5px;padding-left:16px;"> + * <li>tree - The TreePanel</li> + * <li>target - The node being targeted for the drop</li> + * <li>data - The drag data from the drag source</li> + * <li>point - The point of the drop - append, above or below</li> + * <li>source - The drag source</li> + * <li>rawEvent - Raw mouse event</li> + * <li>dropNode - Dropped node(s).</li> + * </ul> + * @param {Object} dropEvent + */ + "nodedrop" : true, + /** + * @event nodedragover + * Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent + * passed to handlers has the following properties:<br /> + * <ul style="padding:5px;padding-left:16px;"> + * <li>tree - The TreePanel</li> + * <li>target - The node being targeted for the drop</li> + * <li>data - The drag data from the drag source</li> + * <li>point - The point of the drop - append, above or below</li> + * <li>source - The drag source</li> + * <li>rawEvent - Raw mouse event</li> + * <li>dropNode - Drop node(s) provided by the source.</li> + * <li>cancel - Set this to true to signal drop not allowed.</li> + * </ul> + * @param {Object} dragOverEvent + */ + "nodedragover" : true + + }); + if(this.singleExpand){ + this.on("beforeexpand", this.restrictExpand, this); + } + if (this.editor) { + this.editor.tree = this; + this.editor = Roo.factory(this.editor, Roo.tree); + } + + if (this.selModel) { + this.selModel = Roo.factory(this.selModel, Roo.tree); + } + +}; +Roo.extend(Roo.tree.TreePanel, Roo.data.Tree, { + rootVisible : true, + animate: Roo.enableFx, + lines : true, + enableDD : false, + hlDrop : Roo.enableFx, + + renderer: false, + + rendererTip: false, + // private + restrictExpand : function(node){ + var p = node.parentNode; + if(p){ + if(p.expandedChild && p.expandedChild.parentNode == p){ + p.expandedChild.collapse(); + } + p.expandedChild = node; + } + }, + + // private override + setRootNode : function(node){ + Roo.tree.TreePanel.superclass.setRootNode.call(this, node); + if(!this.rootVisible){ + node.ui = new Roo.tree.RootTreeNodeUI(node); + } + return node; + }, + + /** + * Returns the container element for this TreePanel + */ + getEl : function(){ + return this.el; + }, + + /** + * Returns the default TreeLoader for this TreePanel + */ + getLoader : function(){ + return this.loader; + }, + + /** + * Expand all nodes + */ + expandAll : function(){ + this.root.expand(true); + }, + + /** + * Collapse all nodes + */ + collapseAll : function(){ + this.root.collapse(true); + }, + + /** + * Returns the selection model used by this TreePanel + */ + getSelectionModel : function(){ + if(!this.selModel){ + this.selModel = new Roo.tree.DefaultSelectionModel(); + } + return this.selModel; + }, + + /** + * Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. "id") + * @param {String} attribute (optional) Defaults to null (return the actual nodes) + * @param {TreeNode} startNode (optional) The node to start from, defaults to the root + * @return {Array} + */ + getChecked : function(a, startNode){ + startNode = startNode || this.root; + var r = []; + var f = function(){ + if(this.attributes.checked){ + r.push(!a ? this : (a == 'id' ? this.id : this.attributes[a])); + } + } + startNode.cascade(f); + return r; + }, + + /** + * Expands a specified path in this TreePanel. A path can be retrieved from a node with {@link Roo.data.Node#getPath} + * @param {String} path + * @param {String} attr (optional) The attribute used in the path (see {@link Roo.data.Node#getPath} for more info) + * @param {Function} callback (optional) The callback to call when the expand is complete. The callback will be called with + * (bSuccess, oLastNode) where bSuccess is if the expand was successful and oLastNode is the last node that was expanded. + */ + expandPath : function(path, attr, callback){ + attr = attr || "id"; + var keys = path.split(this.pathSeparator); + var curNode = this.root; + if(curNode.attributes[attr] != keys[1]){ // invalid root + if(callback){ + callback(false, null); + } + return; + } + var index = 1; + var f = function(){ + if(++index == keys.length){ + if(callback){ + callback(true, curNode); + } + return; + } + var c = curNode.findChild(attr, keys[index]); + if(!c){ + if(callback){ + callback(false, curNode); + } + return; + } + curNode = c; + c.expand(false, false, f); + }; + curNode.expand(false, false, f); + }, + + /** + * Selects the node in this tree at the specified path. A path can be retrieved from a node with {@link Roo.data.Node#getPath} + * @param {String} path + * @param {String} attr (optional) The attribute used in the path (see {@link Roo.data.Node#getPath} for more info) + * @param {Function} callback (optional) The callback to call when the selection is complete. The callback will be called with + * (bSuccess, oSelNode) where bSuccess is if the selection was successful and oSelNode is the selected node. + */ + selectPath : function(path, attr, callback){ + attr = attr || "id"; + var keys = path.split(this.pathSeparator); + var v = keys.pop(); + if(keys.length > 0){ + var f = function(success, node){ + if(success && node){ + var n = node.findChild(attr, v); + if(n){ + n.select(); + if(callback){ + callback(true, n); + } + }else if(callback){ + callback(false, n); + } + }else{ + if(callback){ + callback(false, n); + } + } + }; + this.expandPath(keys.join(this.pathSeparator), attr, f); + }else{ + this.root.select(); + if(callback){ + callback(true, this.root); + } + } + }, + + getTreeEl : function(){ + return this.el; + }, + + /** + * Trigger rendering of this TreePanel + */ + render : function(){ + if (this.innerCt) { + return this; // stop it rendering more than once!! + } + + this.innerCt = this.el.createChild({tag:"ul", + cls:"x-tree-root-ct " + + (this.lines ? "x-tree-lines" : "x-tree-no-lines")}); + + if(this.containerScroll){ + Roo.dd.ScrollManager.register(this.el); + } + if((this.enableDD || this.enableDrop) && !this.dropZone){ + /** + * The dropZone used by this tree if drop is enabled + * @type Roo.tree.TreeDropZone + */ + this.dropZone = new Roo.tree.TreeDropZone(this, this.dropConfig || { + ddGroup: this.ddGroup || "TreeDD", appendOnly: this.ddAppendOnly === true + }); + } + if((this.enableDD || this.enableDrag) && !this.dragZone){ + /** + * The dragZone used by this tree if drag is enabled + * @type Roo.tree.TreeDragZone + */ + this.dragZone = new Roo.tree.TreeDragZone(this, this.dragConfig || { + ddGroup: this.ddGroup || "TreeDD", + scroll: this.ddScroll + }); + } + this.getSelectionModel().init(this); + if (!this.root) { + Roo.log("ROOT not set in tree"); + return this; + } + this.root.render(); + if(!this.rootVisible){ + this.root.renderChildren(); + } + return this; + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_tree_TreeSelectionModel.js.html b/docs2/src/Roo_tree_TreeSelectionModel.js.html new file mode 100644 index 0000000000..b93c521432 --- /dev/null +++ b/docs2/src/Roo_tree_TreeSelectionModel.js.html @@ -0,0 +1,332 @@ +/home/alan/gitlive/roojs1/Roo/tree/TreeSelectionModel.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.tree.DefaultSelectionModel + * @extends Roo.util.Observable + * The default single selection for a TreePanel. + * @param {Object} cfg Configuration + */ +Roo.tree.DefaultSelectionModel = function(cfg){ + this.selNode = null; + + + + this.addEvents({ + /** + * @event selectionchange + * Fires when the selected node changes + * @param {DefaultSelectionModel} this + * @param {TreeNode} node the new selection + */ + "selectionchange" : true, + + /** + * @event beforeselect + * Fires before the selected node changes, return false to cancel the change + * @param {DefaultSelectionModel} this + * @param {TreeNode} node the new selection + * @param {TreeNode} node the old selection + */ + "beforeselect" : true + }); + + Roo.tree.DefaultSelectionModel.superclass.constructor.call(this,cfg); +}; + +Roo.extend(Roo.tree.DefaultSelectionModel, Roo.util.Observable, { + init : function(tree){ + this.tree = tree; + tree.getTreeEl().on("keydown", this.onKeyDown, this); + tree.on("click", this.onNodeClick, this); + }, + + onNodeClick : function(node, e){ + if (e.ctrlKey && this.selNode == node) { + this.unselect(node); + return; + } + this.select(node); + }, + + /** + * Select a node. + * @param {TreeNode} node The node to select + * @return {TreeNode} The selected node + */ + select : function(node){ + var last = this.selNode; + if(last != node && this.fireEvent('beforeselect', this, node, last) !== false){ + if(last){ + last.ui.onSelectedChange(false); + } + this.selNode = node; + node.ui.onSelectedChange(true); + this.fireEvent("selectionchange", this, node, last); + } + return node; + }, + + /** + * Deselect a node. + * @param {TreeNode} node The node to unselect + */ + unselect : function(node){ + if(this.selNode == node){ + this.clearSelections(); + } + }, + + /** + * Clear all selections + */ + clearSelections : function(){ + var n = this.selNode; + if(n){ + n.ui.onSelectedChange(false); + this.selNode = null; + this.fireEvent("selectionchange", this, null); + } + return n; + }, + + /** + * Get the selected node + * @return {TreeNode} The selected node + */ + getSelectedNode : function(){ + return this.selNode; + }, + + /** + * Returns true if the node is selected + * @param {TreeNode} node The node to check + * @return {Boolean} + */ + isSelected : function(node){ + return this.selNode == node; + }, + + /** + * Selects the node above the selected node in the tree, intelligently walking the nodes + * @return TreeNode The new selection + */ + selectPrevious : function(){ + var s = this.selNode || this.lastSelNode; + if(!s){ + return null; + } + var ps = s.previousSibling; + if(ps){ + if(!ps.isExpanded() || ps.childNodes.length < 1){ + return this.select(ps); + } else{ + var lc = ps.lastChild; + while(lc && lc.isExpanded() && lc.childNodes.length > 0){ + lc = lc.lastChild; + } + return this.select(lc); + } + } else if(s.parentNode && (this.tree.rootVisible || !s.parentNode.isRoot)){ + return this.select(s.parentNode); + } + return null; + }, + + /** + * Selects the node above the selected node in the tree, intelligently walking the nodes + * @return TreeNode The new selection + */ + selectNext : function(){ + var s = this.selNode || this.lastSelNode; + if(!s){ + return null; + } + if(s.firstChild && s.isExpanded()){ + return this.select(s.firstChild); + }else if(s.nextSibling){ + return this.select(s.nextSibling); + }else if(s.parentNode){ + var newS = null; + s.parentNode.bubble(function(){ + if(this.nextSibling){ + newS = this.getOwnerTree().selModel.select(this.nextSibling); + return false; + } + }); + return newS; + } + return null; + }, + + onKeyDown : function(e){ + var s = this.selNode || this.lastSelNode; + // undesirable, but required + var sm = this; + if(!s){ + return; + } + var k = e.getKey(); + switch(k){ + case e.DOWN: + e.stopEvent(); + this.selectNext(); + break; + case e.UP: + e.stopEvent(); + this.selectPrevious(); + break; + case e.RIGHT: + e.preventDefault(); + if(s.hasChildNodes()){ + if(!s.isExpanded()){ + s.expand(); + }else if(s.firstChild){ + this.select(s.firstChild, e); + } + } + break; + case e.LEFT: + e.preventDefault(); + if(s.hasChildNodes() && s.isExpanded()){ + s.collapse(); + }else if(s.parentNode && (this.tree.rootVisible || s.parentNode != this.tree.getRootNode())){ + this.select(s.parentNode, e); + } + break; + }; + } +}); + +/** + * @class Roo.tree.MultiSelectionModel + * @extends Roo.util.Observable + * Multi selection for a TreePanel. + * @param {Object} cfg Configuration + */ +Roo.tree.MultiSelectionModel = function(){ + this.selNodes = []; + this.selMap = {}; + this.addEvents({ + /** + * @event selectionchange + * Fires when the selected nodes change + * @param {MultiSelectionModel} this + * @param {Array} nodes Array of the selected nodes + */ + "selectionchange" : true + }); + Roo.tree.MultiSelectionModel.superclass.constructor.call(this,cfg); + +}; + +Roo.extend(Roo.tree.MultiSelectionModel, Roo.util.Observable, { + init : function(tree){ + this.tree = tree; + tree.getTreeEl().on("keydown", this.onKeyDown, this); + tree.on("click", this.onNodeClick, this); + }, + + onNodeClick : function(node, e){ + this.select(node, e, e.ctrlKey); + }, + + /** + * Select a node. + * @param {TreeNode} node The node to select + * @param {EventObject} e (optional) An event associated with the selection + * @param {Boolean} keepExisting True to retain existing selections + * @return {TreeNode} The selected node + */ + select : function(node, e, keepExisting){ + if(keepExisting !== true){ + this.clearSelections(true); + } + if(this.isSelected(node)){ + this.lastSelNode = node; + return node; + } + this.selNodes.push(node); + this.selMap[node.id] = node; + this.lastSelNode = node; + node.ui.onSelectedChange(true); + this.fireEvent("selectionchange", this, this.selNodes); + return node; + }, + + /** + * Deselect a node. + * @param {TreeNode} node The node to unselect + */ + unselect : function(node){ + if(this.selMap[node.id]){ + node.ui.onSelectedChange(false); + var sn = this.selNodes; + var index = -1; + if(sn.indexOf){ + index = sn.indexOf(node); + }else{ + for(var i = 0, len = sn.length; i < len; i++){ + if(sn[i] == node){ + index = i; + break; + } + } + } + if(index != -1){ + this.selNodes.splice(index, 1); + } + delete this.selMap[node.id]; + this.fireEvent("selectionchange", this, this.selNodes); + } + }, + + /** + * Clear all selections + */ + clearSelections : function(suppressEvent){ + var sn = this.selNodes; + if(sn.length > 0){ + for(var i = 0, len = sn.length; i < len; i++){ + sn[i].ui.onSelectedChange(false); + } + this.selNodes = []; + this.selMap = {}; + if(suppressEvent !== true){ + this.fireEvent("selectionchange", this, this.selNodes); + } + } + }, + + /** + * Returns true if the node is selected + * @param {TreeNode} node The node to check + * @return {Boolean} + */ + isSelected : function(node){ + return this.selMap[node.id] ? true : false; + }, + + /** + * Returns an array of the selected nodes + * @return {Array} + */ + getSelectedNodes : function(){ + return this.selNodes; + }, + + onKeyDown : Roo.tree.DefaultSelectionModel.prototype.onKeyDown, + + selectNext : Roo.tree.DefaultSelectionModel.prototype.selectNext, + + selectPrevious : Roo.tree.DefaultSelectionModel.prototype.selectPrevious +}); \ No newline at end of file diff --git a/docs2/src/Roo_tree_TreeSorter.js.html b/docs2/src/Roo_tree_TreeSorter.js.html new file mode 100644 index 0000000000..fb1e45821a --- /dev/null +++ b/docs2/src/Roo_tree_TreeSorter.js.html @@ -0,0 +1,75 @@ +/home/alan/gitlive/roojs1/Roo/tree/TreeSorter.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.tree.TreeSorter + * Provides sorting of nodes in a TreePanel + * + * @cfg {Boolean} folderSort True to sort leaf nodes under non leaf nodes + * @cfg {String} property The named attribute on the node to sort by (defaults to text) + * @cfg {String} dir The direction to sort (asc or desc) (defaults to asc) + * @cfg {String} leafAttr The attribute used to determine leaf nodes in folder sort (defaults to "leaf") + * @cfg {Boolean} caseSensitive true for case sensitive sort (defaults to false) + * @cfg {Function} sortType A custom "casting" function used to convert node values before sorting + * @constructor + * @param {TreePanel} tree + * @param {Object} config + */ +Roo.tree.TreeSorter = function(tree, config){ + Roo.apply(this, config); + tree.on("beforechildrenrendered", this.doSort, this); + tree.on("append", this.updateSort, this); + tree.on("insert", this.updateSort, this); + + var dsc = this.dir && this.dir.toLowerCase() == "desc"; + var p = this.property || "text"; + var sortType = this.sortType; + var fs = this.folderSort; + var cs = this.caseSensitive === true; + var leafAttr = this.leafAttr || 'leaf'; + + this.sortFn = function(n1, n2){ + if(fs){ + if(n1.attributes[leafAttr] && !n2.attributes[leafAttr]){ + return 1; + } + if(!n1.attributes[leafAttr] && n2.attributes[leafAttr]){ + return -1; + } + } + var v1 = sortType ? sortType(n1) : (cs ? n1.attributes[p] : n1.attributes[p].toUpperCase()); + var v2 = sortType ? sortType(n2) : (cs ? n2.attributes[p] : n2.attributes[p].toUpperCase()); + if(v1 < v2){ + return dsc ? +1 : -1; + }else if(v1 > v2){ + return dsc ? -1 : +1; + }else{ + return 0; + } + }; +}; + +Roo.tree.TreeSorter.prototype = { + doSort : function(node){ + node.sort(this.sortFn); + }, + + compareNodes : function(n1, n2){ + return (n1.text.toUpperCase() > n2.text.toUpperCase() ? 1 : -1); + }, + + updateSort : function(tree, node){ + if(node.childrenRendered){ + this.doSort.defer(1, this, [node]); + } + } +}; \ No newline at end of file diff --git a/docs2/src/Roo_util_CSS.js.html b/docs2/src/Roo_util_CSS.js.html new file mode 100644 index 0000000000..3593ae00b2 --- /dev/null +++ b/docs2/src/Roo_util_CSS.js.html @@ -0,0 +1,186 @@ +/home/alan/gitlive/roojs1/Roo/util/CSS.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.util.CSS + * Utility class for manipulating CSS rules + * @singleton + */ +Roo.util.CSS = function(){ + var rules = null; + var doc = document; + + var camelRe = /(-[a-z])/gi; + var camelFn = function(m, a){ return a.charAt(1).toUpperCase(); }; + + return { + /** + * Very simple dynamic creation of stylesheets from a text blob of rules. The text will wrapped in a style + * tag and appended to the HEAD of the document. + * @param {String|Object} cssText The text containing the css rules + * @param {String} id An id to add to the stylesheet for later removal + * @return {StyleSheet} + */ + createStyleSheet : function(cssText, id){ + var ss; + var head = doc.getElementsByTagName("head")[0]; + var nrules = doc.createElement("style"); + nrules.setAttribute("type", "text/css"); + if(id){ + nrules.setAttribute("id", id); + } + if (typeof(cssText) != 'string') { + // support object maps.. + // not sure if this a good idea.. + // perhaps it should be merged with the general css handling + // and handle js style props. + var cssTextNew = []; + for(var n in cssText) { + var citems = []; + for(var k in cssText[n]) { + citems.push( k + ' : ' +cssText[n][k] + ';' ); + } + cssTextNew.push( n + ' { ' + citems.join(' ') + '} '); + + } + cssText = cssTextNew.join("\n"); + + } + + + if(Roo.isIE){ + head.appendChild(nrules); + ss = nrules.styleSheet; + ss.cssText = cssText; + }else{ + try{ + nrules.appendChild(doc.createTextNode(cssText)); + }catch(e){ + nrules.cssText = cssText; + } + head.appendChild(nrules); + ss = nrules.styleSheet ? nrules.styleSheet : (nrules.sheet || doc.styleSheets[doc.styleSheets.length-1]); + } + this.cacheStyleSheet(ss); + return ss; + }, + + /** + * Removes a style or link tag by id + * @param {String} id The id of the tag + */ + removeStyleSheet : function(id){ + var existing = doc.getElementById(id); + if(existing){ + existing.parentNode.removeChild(existing); + } + }, + + /** + * Dynamically swaps an existing stylesheet reference for a new one + * @param {String} id The id of an existing link tag to remove + * @param {String} url The href of the new stylesheet to include + */ + swapStyleSheet : function(id, url){ + this.removeStyleSheet(id); + var ss = doc.createElement("link"); + ss.setAttribute("rel", "stylesheet"); + ss.setAttribute("type", "text/css"); + ss.setAttribute("id", id); + ss.setAttribute("href", url); + doc.getElementsByTagName("head")[0].appendChild(ss); + }, + + /** + * Refresh the rule cache if you have dynamically added stylesheets + * @return {Object} An object (hash) of rules indexed by selector + */ + refreshCache : function(){ + return this.getRules(true); + }, + + // private + cacheStyleSheet : function(stylesheet){ + if(!rules){ + rules = {}; + } + try{// try catch for cross domain access issue + var ssRules = stylesheet.cssRules || stylesheet.rules; + for(var j = ssRules.length-1; j >= 0; --j){ + rules[ssRules[j].selectorText] = ssRules[j]; + } + }catch(e){} + }, + + /** + * Gets all css rules for the document + * @param {Boolean} refreshCache true to refresh the internal cache + * @return {Object} An object (hash) of rules indexed by selector + */ + getRules : function(refreshCache){ + if(rules == null || refreshCache){ + rules = {}; + var ds = doc.styleSheets; + for(var i =0, len = ds.length; i < len; i++){ + try{ + this.cacheStyleSheet(ds[i]); + }catch(e){} + } + } + return rules; + }, + + /** + * Gets an an individual CSS rule by selector(s) + * @param {String/Array} selector The CSS selector or an array of selectors to try. The first selector that is found is returned. + * @param {Boolean} refreshCache true to refresh the internal cache if you have recently updated any rules or added styles dynamically + * @return {CSSRule} The CSS rule or null if one is not found + */ + getRule : function(selector, refreshCache){ + var rs = this.getRules(refreshCache); + if(!(selector instanceof Array)){ + return rs[selector]; + } + for(var i = 0; i < selector.length; i++){ + if(rs[selector[i]]){ + return rs[selector[i]]; + } + } + return null; + }, + + + /** + * Updates a rule property + * @param {String/Array} selector If it's an array it tries each selector until it finds one. Stops immediately once one is found. + * @param {String} property The css property + * @param {String} value The new value for the property + * @return {Boolean} true If a rule was found and updated + */ + updateRule : function(selector, property, value){ + if(!(selector instanceof Array)){ + var rule = this.getRule(selector); + if(rule){ + rule.style[property.replace(camelRe, camelFn)] = value; + return true; + } + }else{ + for(var i = 0; i < selector.length; i++){ + if(this.updateRule(selector[i], property, value)){ + return true; + } + } + } + return false; + } + }; +}(); \ No newline at end of file diff --git a/docs2/src/Roo_util_ClickRepeater.js.html b/docs2/src/Roo_util_ClickRepeater.js.html new file mode 100644 index 0000000000..96977c2d10 --- /dev/null +++ b/docs2/src/Roo_util_ClickRepeater.js.html @@ -0,0 +1,174 @@ +/home/alan/gitlive/roojs1/Roo/util/ClickRepeater.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + + +/** + * @class Roo.util.ClickRepeater + * @extends Roo.util.Observable + * + * A wrapper class which can be applied to any element. Fires a "click" event while the + * mouse is pressed. The interval between firings may be specified in the config but + * defaults to 10 milliseconds. + * + * Optionally, a CSS class may be applied to the element during the time it is pressed. + * + * @cfg {String/HTMLElement/Element} el The element to act as a button. + * @cfg {Number} delay The initial delay before the repeating event begins firing. + * Similar to an autorepeat key delay. + * @cfg {Number} interval The interval between firings of the "click" event. Default 10 ms. + * @cfg {String} pressClass A CSS class name to be applied to the element while pressed. + * @cfg {Boolean} accelerate True if autorepeating should start slowly and accelerate. + * "interval" and "delay" are ignored. "immediate" is honored. + * @cfg {Boolean} preventDefault True to prevent the default click event + * @cfg {Boolean} stopDefault True to stop the default click event + * + * @history + * 2007-02-02 jvs Original code contributed by Nige "Animal" White + * 2007-02-02 jvs Renamed to ClickRepeater + * 2007-02-03 jvs Modifications for FF Mac and Safari + * + * @constructor + * @param {String/HTMLElement/Element} el The element to listen on + * @param {Object} config + **/ +Roo.util.ClickRepeater = function(el, config) +{ + this.el = Roo.get(el); + this.el.unselectable(); + + Roo.apply(this, config); + + this.addEvents({ + /** + * @event mousedown + * Fires when the mouse button is depressed. + * @param {Roo.util.ClickRepeater} this + */ + "mousedown" : true, + /** + * @event click + * Fires on a specified interval during the time the element is pressed. + * @param {Roo.util.ClickRepeater} this + */ + "click" : true, + /** + * @event mouseup + * Fires when the mouse key is released. + * @param {Roo.util.ClickRepeater} this + */ + "mouseup" : true + }); + + this.el.on("mousedown", this.handleMouseDown, this); + if(this.preventDefault || this.stopDefault){ + this.el.on("click", function(e){ + if(this.preventDefault){ + e.preventDefault(); + } + if(this.stopDefault){ + e.stopEvent(); + } + }, this); + } + + // allow inline handler + if(this.handler){ + this.on("click", this.handler, this.scope || this); + } + + Roo.util.ClickRepeater.superclass.constructor.call(this); +}; + +Roo.extend(Roo.util.ClickRepeater, Roo.util.Observable, { + interval : 20, + delay: 250, + preventDefault : true, + stopDefault : false, + timer : 0, + + // private + handleMouseDown : function(){ + clearTimeout(this.timer); + this.el.blur(); + if(this.pressClass){ + this.el.addClass(this.pressClass); + } + this.mousedownTime = new Date(); + + Roo.get(document).on("mouseup", this.handleMouseUp, this); + this.el.on("mouseout", this.handleMouseOut, this); + + this.fireEvent("mousedown", this); + this.fireEvent("click", this); + + this.timer = this.click.defer(this.delay || this.interval, this); + }, + + // private + click : function(){ + this.fireEvent("click", this); + this.timer = this.click.defer(this.getInterval(), this); + }, + + // private + getInterval: function(){ + if(!this.accelerate){ + return this.interval; + } + var pressTime = this.mousedownTime.getElapsed(); + if(pressTime < 500){ + return 400; + }else if(pressTime < 1700){ + return 320; + }else if(pressTime < 2600){ + return 250; + }else if(pressTime < 3500){ + return 180; + }else if(pressTime < 4400){ + return 140; + }else if(pressTime < 5300){ + return 80; + }else if(pressTime < 6200){ + return 50; + }else{ + return 10; + } + }, + + // private + handleMouseOut : function(){ + clearTimeout(this.timer); + if(this.pressClass){ + this.el.removeClass(this.pressClass); + } + this.el.on("mouseover", this.handleMouseReturn, this); + }, + + // private + handleMouseReturn : function(){ + this.el.un("mouseover", this.handleMouseReturn); + if(this.pressClass){ + this.el.addClass(this.pressClass); + } + this.click(); + }, + + // private + handleMouseUp : function(){ + clearTimeout(this.timer); + this.el.un("mouseover", this.handleMouseReturn); + this.el.un("mouseout", this.handleMouseOut); + Roo.get(document).un("mouseup", this.handleMouseUp); + this.el.removeClass(this.pressClass); + this.fireEvent("mouseup", this); + } +}); \ No newline at end of file diff --git a/docs2/src/Roo_util_DelayedTask.js.html b/docs2/src/Roo_util_DelayedTask.js.html new file mode 100644 index 0000000000..6e1bf8d654 --- /dev/null +++ b/docs2/src/Roo_util_DelayedTask.js.html @@ -0,0 +1,65 @@ +/home/alan/gitlive/roojs1/Roo/util/DelayedTask.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.util.DelayedTask + * Provides a convenient method of performing setTimeout where a new + * timeout cancels the old timeout. An example would be performing validation on a keypress. + * You can use this class to buffer + * the keypress events for a certain number of milliseconds, and perform only if they stop + * for that amount of time. + * @constructor The parameters to this constructor serve as defaults and are not required. + * @param {Function} fn (optional) The default function to timeout + * @param {Object} scope (optional) The default scope of that timeout + * @param {Array} args (optional) The default Array of arguments + */ +Roo.util.DelayedTask = function(fn, scope, args){ + var id = null, d, t; + + var call = function(){ + var now = new Date().getTime(); + if(now - t >= d){ + clearInterval(id); + id = null; + fn.apply(scope, args || []); + } + }; + /** + * Cancels any pending timeout and queues a new one + * @param {Number} delay The milliseconds to delay + * @param {Function} newFn (optional) Overrides function passed to constructor + * @param {Object} newScope (optional) Overrides scope passed to constructor + * @param {Array} newArgs (optional) Overrides args passed to constructor + */ + this.delay = function(delay, newFn, newScope, newArgs){ + if(id && delay != d){ + this.cancel(); + } + d = delay; + t = new Date().getTime(); + fn = newFn || fn; + scope = newScope || scope; + args = newArgs || args; + if(!id){ + id = setInterval(call, d); + } + }; + + /** + * Cancel the last queued timeout + */ + this.cancel = function(){ + if(id){ + clearInterval(id); + id = null; + } + }; +}; \ No newline at end of file diff --git a/docs2/src/Roo_util_Format.js.html b/docs2/src/Roo_util_Format.js.html new file mode 100644 index 0000000000..1c103e3129 --- /dev/null +++ b/docs2/src/Roo_util_Format.js.html @@ -0,0 +1,253 @@ +/home/alan/gitlive/roojs1/Roo/util/Format.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.util.Format + * Reusable data formatting functions + * @singleton + */ +Roo.util.Format = function(){ + var trimRe = /^\s+|\s+$/g; + return { + /** + * Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length + * @param {String} value The string to truncate + * @param {Number} length The maximum length to allow before truncating + * @return {String} The converted text + */ + ellipsis : function(value, len){ + if(value && value.length > len){ + return value.substr(0, len-3)+"..."; + } + return value; + }, + + /** + * Checks a reference and converts it to empty string if it is undefined + * @param {Mixed} value Reference to check + * @return {Mixed} Empty string if converted, otherwise the original value + */ + undef : function(value){ + return typeof value != "undefined" ? value : ""; + }, + + /** + * Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages. + * @param {String} value The string to encode + * @return {String} The encoded text + */ + htmlEncode : function(value){ + return !value ? value : String(value).replace(/&/g, "&amp;").replace(/>/g, "&gt;").replace(/</g, "&lt;").replace(/"/g, "&quot;"); + }, + + /** + * Convert certain characters (&, <, >, and ') from their HTML character equivalents. + * @param {String} value The string to decode + * @return {String} The decoded text + */ + htmlDecode : function(value){ + return !value ? value : String(value).replace(/&amp;/g, "&").replace(/&gt;/g, ">").replace(/&lt;/g, "<").replace(/&quot;/g, '"'); + }, + + /** + * Trims any whitespace from either side of a string + * @param {String} value The text to trim + * @return {String} The trimmed text + */ + trim : function(value){ + return String(value).replace(trimRe, ""); + }, + + /** + * Returns a substring from within an original string + * @param {String} value The original text + * @param {Number} start The start index of the substring + * @param {Number} length The length of the substring + * @return {String} The substring + */ + substr : function(value, start, length){ + return String(value).substr(start, length); + }, + + /** + * Converts a string to all lower case letters + * @param {String} value The text to convert + * @return {String} The converted text + */ + lowercase : function(value){ + return String(value).toLowerCase(); + }, + + /** + * Converts a string to all upper case letters + * @param {String} value The text to convert + * @return {String} The converted text + */ + uppercase : function(value){ + return String(value).toUpperCase(); + }, + + /** + * Converts the first character only of a string to upper case + * @param {String} value The text to convert + * @return {String} The converted text + */ + capitalize : function(value){ + return !value ? value : value.charAt(0).toUpperCase() + value.substr(1).toLowerCase(); + }, + + // private + call : function(value, fn){ + if(arguments.length > 2){ + var args = Array.prototype.slice.call(arguments, 2); + args.unshift(value); + + return /** eval:var:value */ eval(fn).apply(window, args); + }else{ + /** eval:var:value */ + return /** eval:var:value */ eval(fn).call(window, value); + } + }, + + + /** + * safer version of Math.toFixed..??/ + * @param {Number/String} value The numeric value to format + * @param {Number/String} value Decimal places + * @return {String} The formatted currency string + */ + toFixed : function(v, n) + { + // why not use to fixed - precision is buggered??? + if (!n) { + return Math.round(v-0); + } + var fact = Math.pow(10,n+1); + v = (Math.round((v-0)*fact))/fact; + var z = (''+fact).substring(2); + if (v == Math.floor(v)) { + return Math.floor(v) + '.' + z; + } + + // now just padd decimals.. + var ps = String(v).split('.'); + var fd = (ps[1] + z); + var r = fd.substring(0,n); + var rm = fd.substring(n); + if (rm < 5) { + return ps[0] + '.' + r; + } + r*=1; // turn it into a number; + r++; + if (String(r).length != n) { + ps[0]*=1; + ps[0]++; + r = String(r).substring(1); // chop the end off. + } + + return ps[0] + '.' + r; + + }, + + /** + * Format a number as US currency + * @param {Number/String} value The numeric value to format + * @return {String} The formatted currency string + */ + usMoney : function(v){ + return '$' + Roo.util.Format.number(v); + }, + + /** + * Format a number + * eventually this should probably emulate php's number_format + * @param {Number/String} value The numeric value to format + * @param {Number} decimals number of decimal places + * @param {String} delimiter for thousands (default comma) + * @return {String} The formatted currency string + */ + number : function(v, decimals, thousandsDelimiter) + { + // multiply and round. + decimals = typeof(decimals) == 'undefined' ? 2 : decimals; + thousandsDelimiter = typeof(thousandsDelimiter) == 'undefined' ? ',' : thousandsDelimiter; + + var mul = Math.pow(10, decimals); + var zero = String(mul).substring(1); + v = (Math.round((v-0)*mul))/mul; + + // if it's '0' number.. then + + //v = (v == Math.floor(v)) ? v + "." + zero : ((v*10 == Math.floor(v*10)) ? v + "0" : v); + v = String(v); + var ps = v.split('.'); + var whole = ps[0]; + + var r = /(\d+)(\d{3})/; + // add comma's + + if(thousandsDelimiter.length != 0) { + whole = whole.replace(/\B(?=(\d{3})+(?!\d))/g, thousandsDelimiter ); + } + + var sub = ps[1] ? + // has decimals.. + (decimals ? ('.'+ ps[1] + zero.substring(ps[1].length)) : '') : + // does not have decimals + (decimals ? ('.' + zero) : ''); + + + return whole + sub ; + }, + + /** + * Parse a value into a formatted date using the specified format pattern. + * @param {Mixed} value The value to format + * @param {String} format (optional) Any valid date format string (defaults to 'm/d/Y') + * @return {String} The formatted date string + */ + date : function(v, format){ + if(!v){ + return ""; + } + if(!(v instanceof Date)){ + v = new Date(Date.parse(v)); + } + return v.dateFormat(format || Roo.util.Format.defaults.date); + }, + + /** + * Returns a date rendering function that can be reused to apply a date format multiple times efficiently + * @param {String} format Any valid date format string + * @return {Function} The date formatting function + */ + dateRenderer : function(format){ + return function(v){ + return Roo.util.Format.date(v, format); + }; + }, + + // private + stripTagsRE : /<\/?[^>]+>/gi, + + /** + * Strips all HTML tags + * @param {Mixed} value The text from which to strip tags + * @return {String} The stripped text + */ + stripTags : function(v){ + return !v ? v : String(v).replace(this.stripTagsRE, ""); + } + }; +}(); +Roo.util.Format.defaults = { + date : 'd/M/Y' +}; \ No newline at end of file diff --git a/docs2/src/Roo_util_JSON.js.html b/docs2/src/Roo_util_JSON.js.html new file mode 100644 index 0000000000..d2ae40b9d1 --- /dev/null +++ b/docs2/src/Roo_util_JSON.js.html @@ -0,0 +1,150 @@ +/home/alan/gitlive/roojs1/Roo/util/JSON.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ +/** + * @class Roo.util.JSON + * Modified version of Douglas Crockford"s json.js that doesn"t + * mess with the Object prototype + * http://www.json.org/js.html + * @singleton + */ +Roo.util.JSON = new (function(){ + var useHasOwn = {}.hasOwnProperty ? true : false; + + // crashes Safari in some instances + //var validRE = /^("(\\.|[^"\\\n\r])*?"|[,:{}\[\]0-9.\-+Eaeflnr-u \n\r\t])+?$/; + + var pad = function(n) { + return n < 10 ? "0" + n : n; + }; + + var m = { + "\b": '\\b', + "\t": '\\t', + "\n": '\\n', + "\f": '\\f', + "\r": '\\r', + '"' : '\\"', + "\\": '\\\\' + }; + + var encodeString = function(s){ + if (/["\\\x00-\x1f]/.test(s)) { + return '"' + s.replace(/([\x00-\x1f\\"])/g, function(a, b) { + var c = m[b]; + if(c){ + return c; + } + c = b.charCodeAt(); + return "\\u00" + + Math.floor(c / 16).toString(16) + + (c % 16).toString(16); + }) + '"'; + } + return '"' + s + '"'; + }; + + var encodeArray = function(o){ + var a = ["["], b, i, l = o.length, v; + for (i = 0; i < l; i += 1) { + v = o[i]; + switch (typeof v) { + case "undefined": + case "function": + case "unknown": + break; + default: + if (b) { + a.push(','); + } + a.push(v === null ? "null" : Roo.util.JSON.encode(v)); + b = true; + } + } + a.push("]"); + return a.join(""); + }; + + var encodeDate = function(o){ + return '"' + o.getFullYear() + "-" + + pad(o.getMonth() + 1) + "-" + + pad(o.getDate()) + "T" + + pad(o.getHours()) + ":" + + pad(o.getMinutes()) + ":" + + pad(o.getSeconds()) + '"'; + }; + + /** + * Encodes an Object, Array or other value + * @param {Mixed} o The variable to encode + * @return {String} The JSON string + */ + this.encode = function(o) + { + // should this be extended to fully wrap stringify.. + + if(typeof o == "undefined" || o === null){ + return "null"; + }else if(o instanceof Array){ + return encodeArray(o); + }else if(o instanceof Date){ + return encodeDate(o); + }else if(typeof o == "string"){ + return encodeString(o); + }else if(typeof o == "number"){ + return isFinite(o) ? String(o) : "null"; + }else if(typeof o == "boolean"){ + return String(o); + }else { + var a = ["{"], b, i, v; + for (i in o) { + if(!useHasOwn || o.hasOwnProperty(i)) { + v = o[i]; + switch (typeof v) { + case "undefined": + case "function": + case "unknown": + break; + default: + if(b){ + a.push(','); + } + a.push(this.encode(i), ":", + v === null ? "null" : this.encode(v)); + b = true; + } + } + } + a.push("}"); + return a.join(""); + } + }; + + /** + * Decodes (parses) a JSON string to an object. If the JSON is invalid, this function throws a SyntaxError. + * @param {String} json The JSON string + * @return {Object} The resulting object + */ + this.decode = function(json){ + + return /** eval:var:json */ eval("(" + json + ')'); + }; +})(); +/** + * Shorthand for {@link Roo.util.JSON#encode} + * @member Roo encode + * @method */ +Roo.encode = typeof(JSON) != 'undefined' && JSON.stringify ? JSON.stringify : Roo.util.JSON.encode; +/** + * Shorthand for {@link Roo.util.JSON#decode} + * @member Roo decode + * @method */ +Roo.decode = typeof(JSON) != 'undefined' && JSON.parse ? JSON.parse : Roo.util.JSON.decode; + \ No newline at end of file diff --git a/docs2/src/Roo_util_MixedCollection.js.html b/docs2/src/Roo_util_MixedCollection.js.html new file mode 100644 index 0000000000..dd039d6c9b --- /dev/null +++ b/docs2/src/Roo_util_MixedCollection.js.html @@ -0,0 +1,524 @@ +/home/alan/gitlive/roojs1/Roo/util/MixedCollection.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.util.MixedCollection + * @extends Roo.util.Observable + * A Collection class that maintains both numeric indexes and keys and exposes events. + * @constructor + * @param {Boolean} allowFunctions True if the addAll function should add function references to the + * collection (defaults to false) + * @param {Function} keyFn A function that can accept an item of the type(s) stored in this MixedCollection + * and return the key value for that item. This is used when available to look up the key on items that + * were passed without an explicit key parameter to a MixedCollection method. Passing this parameter is + * equivalent to providing an implementation for the {@link #getKey} method. + */ +Roo.util.MixedCollection = function(allowFunctions, keyFn){ + this.items = []; + this.map = {}; + this.keys = []; + this.length = 0; + this.addEvents({ + /** + * @event clear + * Fires when the collection is cleared. + */ + "clear" : true, + /** + * @event add + * Fires when an item is added to the collection. + * @param {Number} index The index at which the item was added. + * @param {Object} o The item added. + * @param {String} key The key associated with the added item. + */ + "add" : true, + /** + * @event replace + * Fires when an item is replaced in the collection. + * @param {String} key he key associated with the new added. + * @param {Object} old The item being replaced. + * @param {Object} new The new item. + */ + "replace" : true, + /** + * @event remove + * Fires when an item is removed from the collection. + * @param {Object} o The item being removed. + * @param {String} key (optional) The key associated with the removed item. + */ + "remove" : true, + "sort" : true + }); + this.allowFunctions = allowFunctions === true; + if(keyFn){ + this.getKey = keyFn; + } + Roo.util.MixedCollection.superclass.constructor.call(this); +}; + +Roo.extend(Roo.util.MixedCollection, Roo.util.Observable, { + allowFunctions : false, + +/** + * Adds an item to the collection. + * @param {String} key The key to associate with the item + * @param {Object} o The item to add. + * @return {Object} The item added. + */ + add : function(key, o){ + if(arguments.length == 1){ + o = arguments[0]; + key = this.getKey(o); + } + if(typeof key == "undefined" || key === null){ + this.length++; + this.items.push(o); + this.keys.push(null); + }else{ + var old = this.map[key]; + if(old){ + return this.replace(key, o); + } + this.length++; + this.items.push(o); + this.map[key] = o; + this.keys.push(key); + } + this.fireEvent("add", this.length-1, o, key); + return o; + }, + +/** + * MixedCollection has a generic way to fetch keys if you implement getKey. +<pre><code> +// normal way +var mc = new Roo.util.MixedCollection(); +mc.add(someEl.dom.id, someEl); +mc.add(otherEl.dom.id, otherEl); +//and so on + +// using getKey +var mc = new Roo.util.MixedCollection(); +mc.getKey = function(el){ + return el.dom.id; +}; +mc.add(someEl); +mc.add(otherEl); + +// or via the constructor +var mc = new Roo.util.MixedCollection(false, function(el){ + return el.dom.id; +}); +mc.add(someEl); +mc.add(otherEl); +</code></pre> + * @param o {Object} The item for which to find the key. + * @return {Object} The key for the passed item. + */ + getKey : function(o){ + return o.id; + }, + +/** + * Replaces an item in the collection. + * @param {String} key The key associated with the item to replace, or the item to replace. + * @param o {Object} o (optional) If the first parameter passed was a key, the item to associate with that key. + * @return {Object} The new item. + */ + replace : function(key, o){ + if(arguments.length == 1){ + o = arguments[0]; + key = this.getKey(o); + } + var old = this.item(key); + if(typeof key == "undefined" || key === null || typeof old == "undefined"){ + return this.add(key, o); + } + var index = this.indexOfKey(key); + this.items[index] = o; + this.map[key] = o; + this.fireEvent("replace", key, old, o); + return o; + }, + +/** + * Adds all elements of an Array or an Object to the collection. + * @param {Object/Array} objs An Object containing properties which will be added to the collection, or + * an Array of values, each of which are added to the collection. + */ + addAll : function(objs){ + if(arguments.length > 1 || objs instanceof Array){ + var args = arguments.length > 1 ? arguments : objs; + for(var i = 0, len = args.length; i < len; i++){ + this.add(args[i]); + } + }else{ + for(var key in objs){ + if(this.allowFunctions || typeof objs[key] != "function"){ + this.add(key, objs[key]); + } + } + } + }, + +/** + * Executes the specified function once for every item in the collection, passing each + * item as the first and only parameter. returning false from the function will stop the iteration. + * @param {Function} fn The function to execute for each item. + * @param {Object} scope (optional) The scope in which to execute the function. + */ + each : function(fn, scope){ + var items = [].concat(this.items); // each safe for removal + for(var i = 0, len = items.length; i < len; i++){ + if(fn.call(scope || items[i], items[i], i, len) === false){ + break; + } + } + }, + +/** + * Executes the specified function once for every key in the collection, passing each + * key, and its associated item as the first two parameters. + * @param {Function} fn The function to execute for each item. + * @param {Object} scope (optional) The scope in which to execute the function. + */ + eachKey : function(fn, scope){ + for(var i = 0, len = this.keys.length; i < len; i++){ + fn.call(scope || window, this.keys[i], this.items[i], i, len); + } + }, + +/** + * Returns the first item in the collection which elicits a true return value from the + * passed selection function. + * @param {Function} fn The selection function to execute for each item. + * @param {Object} scope (optional) The scope in which to execute the function. + * @return {Object} The first item in the collection which returned true from the selection function. + */ + find : function(fn, scope){ + for(var i = 0, len = this.items.length; i < len; i++){ + if(fn.call(scope || window, this.items[i], this.keys[i])){ + return this.items[i]; + } + } + return null; + }, + +/** + * Inserts an item at the specified index in the collection. + * @param {Number} index The index to insert the item at. + * @param {String} key The key to associate with the new item, or the item itself. + * @param {Object} o (optional) If the second parameter was a key, the new item. + * @return {Object} The item inserted. + */ + insert : function(index, key, o){ + if(arguments.length == 2){ + o = arguments[1]; + key = this.getKey(o); + } + if(index >= this.length){ + return this.add(key, o); + } + this.length++; + this.items.splice(index, 0, o); + if(typeof key != "undefined" && key != null){ + this.map[key] = o; + } + this.keys.splice(index, 0, key); + this.fireEvent("add", index, o, key); + return o; + }, + +/** + * Removed an item from the collection. + * @param {Object} o The item to remove. + * @return {Object} The item removed. + */ + remove : function(o){ + return this.removeAt(this.indexOf(o)); + }, + +/** + * Remove an item from a specified index in the collection. + * @param {Number} index The index within the collection of the item to remove. + */ + removeAt : function(index){ + if(index < this.length && index >= 0){ + this.length--; + var o = this.items[index]; + this.items.splice(index, 1); + var key = this.keys[index]; + if(typeof key != "undefined"){ + delete this.map[key]; + } + this.keys.splice(index, 1); + this.fireEvent("remove", o, key); + } + }, + +/** + * Removed an item associated with the passed key fom the collection. + * @param {String} key The key of the item to remove. + */ + removeKey : function(key){ + return this.removeAt(this.indexOfKey(key)); + }, + +/** + * Returns the number of items in the collection. + * @return {Number} the number of items in the collection. + */ + getCount : function(){ + return this.length; + }, + +/** + * Returns index within the collection of the passed Object. + * @param {Object} o The item to find the index of. + * @return {Number} index of the item. + */ + indexOf : function(o){ + if(!this.items.indexOf){ + for(var i = 0, len = this.items.length; i < len; i++){ + if(this.items[i] == o) { + return i; + } + } + return -1; + }else{ + return this.items.indexOf(o); + } + }, + +/** + * Returns index within the collection of the passed key. + * @param {String} key The key to find the index of. + * @return {Number} index of the key. + */ + indexOfKey : function(key){ + if(!this.keys.indexOf){ + for(var i = 0, len = this.keys.length; i < len; i++){ + if(this.keys[i] == key) { + return i; + } + } + return -1; + }else{ + return this.keys.indexOf(key); + } + }, + +/** + * Returns the item associated with the passed key OR index. Key has priority over index. + * @param {String/Number} key The key or index of the item. + * @return {Object} The item associated with the passed key. + */ + item : function(key){ + var item = typeof this.map[key] != "undefined" ? this.map[key] : this.items[key]; + return typeof item != 'function' || this.allowFunctions ? item : null; // for prototype! + }, + +/** + * Returns the item at the specified index. + * @param {Number} index The index of the item. + * @return {Object} + */ + itemAt : function(index){ + return this.items[index]; + }, + +/** + * Returns the item associated with the passed key. + * @param {String/Number} key The key of the item. + * @return {Object} The item associated with the passed key. + */ + key : function(key){ + return this.map[key]; + }, + +/** + * Returns true if the collection contains the passed Object as an item. + * @param {Object} o The Object to look for in the collection. + * @return {Boolean} True if the collection contains the Object as an item. + */ + contains : function(o){ + return this.indexOf(o) != -1; + }, + +/** + * Returns true if the collection contains the passed Object as a key. + * @param {String} key The key to look for in the collection. + * @return {Boolean} True if the collection contains the Object as a key. + */ + containsKey : function(key){ + return typeof this.map[key] != "undefined"; + }, + +/** + * Removes all items from the collection. + */ + clear : function(){ + this.length = 0; + this.items = []; + this.keys = []; + this.map = {}; + this.fireEvent("clear"); + }, + +/** + * Returns the first item in the collection. + * @return {Object} the first item in the collection.. + */ + first : function(){ + return this.items[0]; + }, + +/** + * Returns the last item in the collection. + * @return {Object} the last item in the collection.. + */ + last : function(){ + return this.items[this.length-1]; + }, + + _sort : function(property, dir, fn){ + var dsc = String(dir).toUpperCase() == "DESC" ? -1 : 1; + fn = fn || function(a, b){ + return a-b; + }; + var c = [], k = this.keys, items = this.items; + for(var i = 0, len = items.length; i < len; i++){ + c[c.length] = {key: k[i], value: items[i], index: i}; + } + c.sort(function(a, b){ + var v = fn(a[property], b[property]) * dsc; + if(v == 0){ + v = (a.index < b.index ? -1 : 1); + } + return v; + }); + for(var i = 0, len = c.length; i < len; i++){ + items[i] = c[i].value; + k[i] = c[i].key; + } + this.fireEvent("sort", this); + }, + + /** + * Sorts this collection with the passed comparison function + * @param {String} direction (optional) "ASC" or "DESC" + * @param {Function} fn (optional) comparison function + */ + sort : function(dir, fn){ + this._sort("value", dir, fn); + }, + + /** + * Sorts this collection by keys + * @param {String} direction (optional) "ASC" or "DESC" + * @param {Function} fn (optional) a comparison function (defaults to case insensitive string) + */ + keySort : function(dir, fn){ + this._sort("key", dir, fn || function(a, b){ + return String(a).toUpperCase()-String(b).toUpperCase(); + }); + }, + + /** + * Returns a range of items in this collection + * @param {Number} startIndex (optional) defaults to 0 + * @param {Number} endIndex (optional) default to the last item + * @return {Array} An array of items + */ + getRange : function(start, end){ + var items = this.items; + if(items.length < 1){ + return []; + } + start = start || 0; + end = Math.min(typeof end == "undefined" ? this.length-1 : end, this.length-1); + var r = []; + if(start <= end){ + for(var i = start; i <= end; i++) { + r[r.length] = items[i]; + } + }else{ + for(var i = start; i >= end; i--) { + r[r.length] = items[i]; + } + } + return r; + }, + + /** + * Filter the <i>objects</i> in this collection by a specific property. + * Returns a new collection that has been filtered. + * @param {String} property A property on your objects + * @param {String/RegExp} value Either string that the property values + * should start with or a RegExp to test against the property + * @return {MixedCollection} The new filtered collection + */ + filter : function(property, value){ + if(!value.exec){ // not a regex + value = String(value); + if(value.length == 0){ + return this.clone(); + } + value = new RegExp("^" + Roo.escapeRe(value), "i"); + } + return this.filterBy(function(o){ + return o && value.test(o[property]); + }); + }, + + /** + * Filter by a function. * Returns a new collection that has been filtered. + * The passed function will be called with each + * object in the collection. If the function returns true, the value is included + * otherwise it is filtered. + * @param {Function} fn The function to be called, it will receive the args o (the object), k (the key) + * @param {Object} scope (optional) The scope of the function (defaults to this) + * @return {MixedCollection} The new filtered collection + */ + filterBy : function(fn, scope){ + var r = new Roo.util.MixedCollection(); + r.getKey = this.getKey; + var k = this.keys, it = this.items; + for(var i = 0, len = it.length; i < len; i++){ + if(fn.call(scope||this, it[i], k[i])){ + r.add(k[i], it[i]); + } + } + return r; + }, + + /** + * Creates a duplicate of this collection + * @return {MixedCollection} + */ + clone : function(){ + var r = new Roo.util.MixedCollection(); + var k = this.keys, it = this.items; + for(var i = 0, len = it.length; i < len; i++){ + r.add(k[i], it[i]); + } + r.getKey = this.getKey; + return r; + } +}); +/** + * Returns the item associated with the passed key or index. + * @method + * @param {String/Number} key The key or index of the item. + * @return {Object} The item associated with the passed key. + */ +Roo.util.MixedCollection.prototype.get = Roo.util.MixedCollection.prototype.item; \ No newline at end of file diff --git a/docs2/src/Roo_util_Observable.js.html b/docs2/src/Roo_util_Observable.js.html new file mode 100644 index 0000000000..b3f51deec4 --- /dev/null +++ b/docs2/src/Roo_util_Observable.js.html @@ -0,0 +1,372 @@ +/home/alan/gitlive/roojs1/Roo/util/Observable.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +/** + * @class Roo.util.Observable + * Base class that provides a common interface for publishing events. Subclasses are expected to + * to have a property "events" with all the events defined.<br> + * For example: + * <pre><code> + Employee = function(name){ + this.name = name; + this.addEvents({ + "fired" : true, + "quit" : true + }); + } + Roo.extend(Employee, Roo.util.Observable); +</code></pre> + * @param {Object} config properties to use (incuding events / listeners) + */ + +Roo.util.Observable = function(cfg){ + + cfg = cfg|| {}; + this.addEvents(cfg.events || {}); + if (cfg.events) { + delete cfg.events; // make sure + } + + Roo.apply(this, cfg); + + if(this.listeners){ + this.on(this.listeners); + delete this.listeners; + } +}; +Roo.util.Observable.prototype = { + /** + * @cfg {Object} listeners list of events and functions to call for this object, + * For example : + * <pre><code> + listeners : { + 'click' : function(e) { + ..... + } , + .... + } + </code></pre> + */ + + + /** + * Fires the specified event with the passed parameters (minus the event name). + * @param {String} eventName + * @param {Object...} args Variable number of parameters are passed to handlers + * @return {Boolean} returns false if any of the handlers return false otherwise it returns true + */ + fireEvent : function(){ + var ce = this.events[arguments[0].toLowerCase()]; + if(typeof ce == "object"){ + return ce.fire.apply(ce, Array.prototype.slice.call(arguments, 1)); + }else{ + return true; + } + }, + + // private + filterOptRe : /^(?:scope|delay|buffer|single)$/, + + /** + * Appends an event handler to this component + * @param {String} eventName The type of event to listen for + * @param {Function} handler The method the event invokes + * @param {Object} scope (optional) The scope in which to execute the handler + * function. The handler function's "this" context. + * @param {Object} options (optional) An object containing handler configuration + * properties. This may contain any of the following properties:<ul> + * <li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li> + * <li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li> + * <li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li> + * <li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed + * by the specified number of milliseconds. If the event fires again within that time, the original + * handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li> + * </ul><br> + * <p> + * <b>Combining Options</b><br> + * Using the options argument, it is possible to combine different types of listeners:<br> + * <br> + * A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId) + <pre><code> + el.on('click', this.onClick, this, { + single: true, + delay: 100, + forumId: 4 + }); + </code></pre> + * <p> + * <b>Attaching multiple handlers in 1 call</b><br> + * The method also allows for a single argument to be passed which is a config object containing properties + * which specify multiple handlers. + * <pre><code> + el.on({ + 'click': { + fn: this.onClick, + scope: this, + delay: 100 + }, + 'mouseover': { + fn: this.onMouseOver, + scope: this + }, + 'mouseout': { + fn: this.onMouseOut, + scope: this + } + }); + </code></pre> + * <p> + * Or a shorthand syntax which passes the same scope object to all handlers: + <pre><code> + el.on({ + 'click': this.onClick, + 'mouseover': this.onMouseOver, + 'mouseout': this.onMouseOut, + scope: this + }); + </code></pre> + */ + addListener : function(eventName, fn, scope, o){ + if(typeof eventName == "object"){ + o = eventName; + for(var e in o){ + if(this.filterOptRe.test(e)){ + continue; + } + if(typeof o[e] == "function"){ + // shared options + this.addListener(e, o[e], o.scope, o); + }else{ + // individual options + this.addListener(e, o[e].fn, o[e].scope, o[e]); + } + } + return; + } + o = (!o || typeof o == "boolean") ? {} : o; + eventName = eventName.toLowerCase(); + var ce = this.events[eventName] || true; + if(typeof ce == "boolean"){ + ce = new Roo.util.Event(this, eventName); + this.events[eventName] = ce; + } + ce.addListener(fn, scope, o); + }, + + /** + * Removes a listener + * @param {String} eventName The type of event to listen for + * @param {Function} handler The handler to remove + * @param {Object} scope (optional) The scope (this object) for the handler + */ + removeListener : function(eventName, fn, scope){ + var ce = this.events[eventName.toLowerCase()]; + if(typeof ce == "object"){ + ce.removeListener(fn, scope); + } + }, + + /** + * Removes all listeners for this object + */ + purgeListeners : function(){ + for(var evt in this.events){ + if(typeof this.events[evt] == "object"){ + this.events[evt].clearListeners(); + } + } + }, + + relayEvents : function(o, events){ + var createHandler = function(ename){ + return function(){ + return this.fireEvent.apply(this, Roo.combine(ename, Array.prototype.slice.call(arguments, 0))); + }; + }; + for(var i = 0, len = events.length; i < len; i++){ + var ename = events[i]; + if(!this.events[ename]){ this.events[ename] = true; }; + o.on(ename, createHandler(ename), this); + } + }, + + /** + * Used to define events on this Observable + * @param {Object} object The object with the events defined + */ + addEvents : function(o){ + if(!this.events){ + this.events = {}; + } + Roo.applyIf(this.events, o); + }, + + /** + * Checks to see if this object has any listeners for a specified event + * @param {String} eventName The name of the event to check for + * @return {Boolean} True if the event is being listened for, else false + */ + hasListener : function(eventName){ + var e = this.events[eventName]; + return typeof e == "object" && e.listeners.length > 0; + } +}; +/** + * Appends an event handler to this element (shorthand for addListener) + * @param {String} eventName The type of event to listen for + * @param {Function} handler The method the event invokes + * @param {Object} scope (optional) The scope in which to execute the handler + * function. The handler function's "this" context. + * @param {Object} options (optional) + * @method + */ +Roo.util.Observable.prototype.on = Roo.util.Observable.prototype.addListener; +/** + * Removes a listener (shorthand for removeListener) + * @param {String} eventName The type of event to listen for + * @param {Function} handler The handler to remove + * @param {Object} scope (optional) The scope (this object) for the handler + * @method + */ +Roo.util.Observable.prototype.un = Roo.util.Observable.prototype.removeListener; + +/** + * Starts capture on the specified Observable. All events will be passed + * to the supplied function with the event name + standard signature of the event + * <b>before</b> the event is fired. If the supplied function returns false, + * the event will not fire. + * @param {Observable} o The Observable to capture + * @param {Function} fn The function to call + * @param {Object} scope (optional) The scope (this object) for the fn + * @static + */ +Roo.util.Observable.capture = function(o, fn, scope){ + o.fireEvent = o.fireEvent.createInterceptor(fn, scope); +}; + +/** + * Removes <b>all</b> added captures from the Observable. + * @param {Observable} o The Observable to release + * @static + */ +Roo.util.Observable.releaseCapture = function(o){ + o.fireEvent = Roo.util.Observable.prototype.fireEvent; +}; + +(function(){ + + var createBuffered = function(h, o, scope){ + var task = new Roo.util.DelayedTask(); + return function(){ + task.delay(o.buffer, h, scope, Array.prototype.slice.call(arguments, 0)); + }; + }; + + var createSingle = function(h, e, fn, scope){ + return function(){ + e.removeListener(fn, scope); + return h.apply(scope, arguments); + }; + }; + + var createDelayed = function(h, o, scope){ + return function(){ + var args = Array.prototype.slice.call(arguments, 0); + setTimeout(function(){ + h.apply(scope, args); + }, o.delay || 10); + }; + }; + + Roo.util.Event = function(obj, name){ + this.name = name; + this.obj = obj; + this.listeners = []; + }; + + Roo.util.Event.prototype = { + addListener : function(fn, scope, options){ + var o = options || {}; + scope = scope || this.obj; + if(!this.isListening(fn, scope)){ + var l = {fn: fn, scope: scope, options: o}; + var h = fn; + if(o.delay){ + h = createDelayed(h, o, scope); + } + if(o.single){ + h = createSingle(h, this, fn, scope); + } + if(o.buffer){ + h = createBuffered(h, o, scope); + } + l.fireFn = h; + if(!this.firing){ // if we are currently firing this event, don't disturb the listener loop + this.listeners.push(l); + }else{ + this.listeners = this.listeners.slice(0); + this.listeners.push(l); + } + } + }, + + findListener : function(fn, scope){ + scope = scope || this.obj; + var ls = this.listeners; + for(var i = 0, len = ls.length; i < len; i++){ + var l = ls[i]; + if(l.fn == fn && l.scope == scope){ + return i; + } + } + return -1; + }, + + isListening : function(fn, scope){ + return this.findListener(fn, scope) != -1; + }, + + removeListener : function(fn, scope){ + var index; + if((index = this.findListener(fn, scope)) != -1){ + if(!this.firing){ + this.listeners.splice(index, 1); + }else{ + this.listeners = this.listeners.slice(0); + this.listeners.splice(index, 1); + } + return true; + } + return false; + }, + + clearListeners : function(){ + this.listeners = []; + }, + + fire : function(){ + var ls = this.listeners, scope, len = ls.length; + if(len > 0){ + this.firing = true; + var args = Array.prototype.slice.call(arguments, 0); + for(var i = 0; i < len; i++){ + var l = ls[i]; + if(l.fireFn.apply(l.scope||this.obj||window, arguments) === false){ + this.firing = false; + return false; + } + } + this.firing = false; + } + return true; + } + }; +})(); \ No newline at end of file diff --git a/docs2/src/Roo_util_TaskRunner.js.html b/docs2/src/Roo_util_TaskRunner.js.html new file mode 100644 index 0000000000..3034b21da6 --- /dev/null +++ b/docs2/src/Roo_util_TaskRunner.js.html @@ -0,0 +1,98 @@ +/home/alan/gitlive/roojs1/Roo/util/TaskRunner.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +Roo.util.TaskRunner = function(interval){ + interval = interval || 10; + var tasks = [], removeQueue = []; + var id = 0; + var running = false; + + var stopThread = function(){ + running = false; + clearInterval(id); + id = 0; + }; + + var startThread = function(){ + if(!running){ + running = true; + id = setInterval(runTasks, interval); + } + }; + + var removeTask = function(task){ + removeQueue.push(task); + if(task.onStop){ + task.onStop(); + } + }; + + var runTasks = function(){ + if(removeQueue.length > 0){ + for(var i = 0, len = removeQueue.length; i < len; i++){ + tasks.remove(removeQueue[i]); + } + removeQueue = []; + if(tasks.length < 1){ + stopThread(); + return; + } + } + var now = new Date().getTime(); + for(var i = 0, len = tasks.length; i < len; ++i){ + var t = tasks[i]; + var itime = now - t.taskRunTime; + if(t.interval <= itime){ + var rt = t.run.apply(t.scope || t, t.args || [++t.taskRunCount]); + t.taskRunTime = now; + if(rt === false || t.taskRunCount === t.repeat){ + removeTask(t); + return; + } + } + if(t.duration && t.duration <= (now - t.taskStartTime)){ + removeTask(t); + } + } + }; + + /** + * Queues a new task. + * @param {Object} task + */ + this.start = function(task){ + tasks.push(task); + task.taskStartTime = new Date().getTime(); + task.taskRunTime = 0; + task.taskRunCount = 0; + startThread(); + return task; + }; + + this.stop = function(task){ + removeTask(task); + return task; + }; + + this.stopAll = function(){ + stopThread(); + for(var i = 0, len = tasks.length; i < len; i++){ + if(tasks[i].onStop){ + tasks[i].onStop(); + } + } + tasks = []; + removeQueue = []; + }; +}; + +Roo.TaskMgr = new Roo.util.TaskRunner(); \ No newline at end of file diff --git a/docs2/src/Roo_util_TextMetrics.js.html b/docs2/src/Roo_util_TextMetrics.js.html new file mode 100644 index 0000000000..a87a747633 --- /dev/null +++ b/docs2/src/Roo_util_TextMetrics.js.html @@ -0,0 +1,132 @@ +/home/alan/gitlive/roojs1/Roo/util/TextMetrics.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + + +/** + * @class Roo.util.TextMetrics + * Provides precise pixel measurements for blocks of text so that you can determine exactly how high and + * wide, in pixels, a given block of text will be. + * @singleton + */ +Roo.util.TextMetrics = function(){ + var shared; + return { + /** + * Measures the size of the specified text + * @param {String/HTMLElement} el The element, dom node or id from which to copy existing CSS styles + * that can affect the size of the rendered text + * @param {String} text The text to measure + * @param {Number} fixedWidth (optional) If the text will be multiline, you have to set a fixed width + * in order to accurately measure the text height + * @return {Object} An object containing the text's size {width: (width), height: (height)} + */ + measure : function(el, text, fixedWidth){ + if(!shared){ + shared = Roo.util.TextMetrics.Instance(el, fixedWidth); + } + shared.bind(el); + shared.setFixedWidth(fixedWidth || 'auto'); + return shared.getSize(text); + }, + + /** + * Return a unique TextMetrics instance that can be bound directly to an element and reused. This reduces + * the overhead of multiple calls to initialize the style properties on each measurement. + * @param {String/HTMLElement} el The element, dom node or id that the instance will be bound to + * @param {Number} fixedWidth (optional) If the text will be multiline, you have to set a fixed width + * in order to accurately measure the text height + * @return {Roo.util.TextMetrics.Instance} instance The new instance + */ + createInstance : function(el, fixedWidth){ + return Roo.util.TextMetrics.Instance(el, fixedWidth); + } + }; +}(); + + + +Roo.util.TextMetrics.Instance = function(bindTo, fixedWidth){ + var ml = new Roo.Element(document.createElement('div')); + document.body.appendChild(ml.dom); + ml.position('absolute'); + ml.setLeftTop(-1000, -1000); + ml.hide(); + + if(fixedWidth){ + ml.setWidth(fixedWidth); + } + + var instance = { + /** + * Returns the size of the specified text based on the internal element's style and width properties + * @memberOf Roo.util.TextMetrics.Instance# + * @param {String} text The text to measure + * @return {Object} An object containing the text's size {width: (width), height: (height)} + */ + getSize : function(text){ + ml.update(text); + var s = ml.getSize(); + ml.update(''); + return s; + }, + + /** + * Binds this TextMetrics instance to an element from which to copy existing CSS styles + * that can affect the size of the rendered text + * @memberOf Roo.util.TextMetrics.Instance# + * @param {String/HTMLElement} el The element, dom node or id + */ + bind : function(el){ + ml.setStyle( + Roo.fly(el).getStyles('font-size','font-style', 'font-weight', 'font-family','line-height') + ); + }, + + /** + * Sets a fixed width on the internal measurement element. If the text will be multiline, you have + * to set a fixed width in order to accurately measure the text height. + * @memberOf Roo.util.TextMetrics.Instance# + * @param {Number} width The width to set on the element + */ + setFixedWidth : function(width){ + ml.setWidth(width); + }, + + /** + * Returns the measured width of the specified text + * @memberOf Roo.util.TextMetrics.Instance# + * @param {String} text The text to measure + * @return {Number} width The width in pixels + */ + getWidth : function(text){ + ml.dom.style.width = 'auto'; + return this.getSize(text).width; + }, + + /** + * Returns the measured height of the specified text. For multiline text, be sure to call + * {@link #setFixedWidth} if necessary. + * @memberOf Roo.util.TextMetrics.Instance# + * @param {String} text The text to measure + * @return {Number} height The height in pixels + */ + getHeight : function(text){ + return this.getSize(text).height; + } + }; + + instance.bind(bindTo); + + return instance; +}; + +// backwards compat +Roo.Element.measureText = Roo.util.TextMetrics.measure; \ No newline at end of file diff --git a/docs2/src/String.js.html b/docs2/src/String.js.html new file mode 100644 index 0000000000..f4dc4dd729 --- /dev/null +++ b/docs2/src/String.js.html @@ -0,0 +1,117 @@ +/home/alan/gitlive/roojs1/String.js/* + * Based on: + * Ext JS Library 1.1.1 + * Copyright(c) 2006-2007, Ext JS, LLC. + * + * Originally Released Under LGPL - original licence link has changed is not relivant. + * + * Fork - LGPL + * <script type="text/javascript"> + */ + +Roo.applyIf(String, { + + /** @scope String */ + + /** + * Escapes the passed string for ' and \ + * @param {String} string The string to escape + * @return {String} The escaped string + * @static + */ + escape : function(string) { + return string.replace(/('|\\)/g, "\\$1"); + }, + + /** + * Pads the left side of a string with a specified character. This is especially useful + * for normalizing number and date strings. Example usage: + * <pre><code> +var s = String.leftPad('123', 5, '0'); +// s now contains the string: '00123' +</code></pre> + * @param {String} string The original string + * @param {Number} size The total length of the output string + * @param {String} char (optional) The character with which to pad the original string (defaults to empty string " ") + * @return {String} The padded string + * @static + */ + leftPad : function (val, size, ch) { + var result = new String(val); + if(ch === null || ch === undefined || ch === '') { + ch = " "; + } + while (result.length < size) { + result = ch + result; + } + return result; + }, + + /** + * Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens. Each + * token must be unique, and must increment in the format {0}, {1}, etc. Example usage: + * <pre><code> +var cls = 'my-class', text = 'Some text'; +var s = String.format('<div class="{0}">{1}</div>', cls, text); +// s now contains the string: '<div class="my-class">Some text</div>' +</code></pre> + * @param {String} string The tokenized string to be formatted + * @param {String} value1 The value to replace token {0} + * @param {String} value2 Etc... + * @return {String} The formatted string + * @static + */ + format : function(format){ + var args = Array.prototype.slice.call(arguments, 1); + return format.replace(/\{(\d+)\}/g, function(m, i){ + return Roo.util.Format.htmlEncode(args[i]); + }); + } + + +}); + +/** + * Utility function that allows you to easily switch a string between two alternating values. The passed value + * is compared to the current string, and if they are equal, the other value that was passed in is returned. If + * they are already different, the first value passed in is returned. Note that this method returns the new value + * but does not change the current string. + * <pre><code> +// alternate sort directions +sort = sort.toggle('ASC', 'DESC'); + +// instead of conditional logic: +sort = (sort == 'ASC' ? 'DESC' : 'ASC'); +</code></pre> + * @param {String} value The value to compare to the current string + * @param {String} other The new value to use if the string already equals the first value passed in + * @return {String} The new value + */ + +String.prototype.toggle = function(value, other){ + return this == value ? other : value; +}; + + +/** + * Remove invalid unicode characters from a string + * + * @return {String} The clean string + */ +String.prototype.unicodeClean = function () { + return this.replace(/[\s\S]/g, + function(character) { + if (character.charCodeAt()< 256) { + return character; + } + try { + encodeURIComponent(character); + } catch(e) { + return ''; + } + return character; + } + ); +}; + + \ No newline at end of file diff --git a/docs2/symbols/Array.json b/docs2/symbols/Array.json new file mode 100644 index 0000000000..fef993c004 --- /dev/null +++ b/docs2/symbols/Array.json @@ -0,0 +1,86 @@ +{ + "name" : "Array", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : true, + "config" : [ + ], + "methods" : [ + { + "name" : "indexOf", + "desc" : "Checks whether or not the specified object exists in the array.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Array", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "The object to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of o in the array (or -1 if it is not found)" + } + ] + }, + { + "name" : "map", + "desc" : "Map (JS 1.6 compatibility)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Array", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "function", + "type" : "Function", + "desc" : "to call", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Removes the specified object from the array. If the object is not found nothing happens.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Array", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "The object to remove", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Date.json b/docs2/symbols/Date.json new file mode 100644 index 0000000000..74091c3803 --- /dev/null +++ b/docs2/symbols/Date.json @@ -0,0 +1,435 @@ +{ + "name" : "Date", + "augments" : [ + ], + "desc" : "The date parsing and format syntax is a subset of\nPHP's date() function, and the formats that are\nsupported will provide results equivalent to their PHP versions.\n\nFollowing is the list of all currently supported formats:\n
\nSample date:\n'Wed Jan 10 2007 15:05:01 GMT-0600 (Central Standard Time)'\n\nFormat  Output      Description\n------  ----------  --------------------------------------------------------------\n  d      10         Day of the month, 2 digits with leading zeros\n  D      Wed        A textual representation of a day, three letters\n  j      10         Day of the month without leading zeros\n  l      Wednesday  A full textual representation of the day of the week\n  S      th         English ordinal day of month suffix, 2 chars (use with j)\n  w      3          Numeric representation of the day of the week\n  z      9          The julian date, or day of the year (0-365)\n  W      01         ISO-8601 2-digit week number of year, weeks starting on Monday (00-52)\n  F      January    A full textual representation of the month\n  m      01         Numeric representation of a month, with leading zeros\n  M      Jan        Month name abbreviation, three letters\n  n      1          Numeric representation of a month, without leading zeros\n  t      31         Number of days in the given month\n  L      0          Whether it's a leap year (1 if it is a leap year, else 0)\n  Y      2007       A full numeric representation of a year, 4 digits\n  y      07         A two digit representation of a year\n  a      pm         Lowercase Ante meridiem and Post meridiem\n  A      PM         Uppercase Ante meridiem and Post meridiem\n  g      3          12-hour format of an hour without leading zeros\n  G      15         24-hour format of an hour without leading zeros\n  h      03         12-hour format of an hour with leading zeros\n  H      15         24-hour format of an hour with leading zeros\n  i      05         Minutes with leading zeros\n  s      01         Seconds, with leading zeros\n  O      -0600      Difference to Greenwich time (GMT) in hours (Allows +08, without minutes)\n  P      -06:00     Difference to Greenwich time (GMT) with colon between hours and minutes\n  T      CST        Timezone setting of the machine running the code\n  Z      -21600     Timezone offset in seconds (negative if west of UTC, positive if east)\n
\n\nExample usage (note that you must escape format specifiers with '\\\\' to render them as character literals):\n
\nvar dt = new Date('1/10/2007 03:05:01 PM GMT-0600');\ndocument.write(dt.format('Y-m-d'));                         //2007-01-10\ndocument.write(dt.format('F j, Y, g:i a'));                 //January 10, 2007, 3:05 pm\ndocument.write(dt.format('l, \\\\t\\\\he dS of F Y h:i:s A'));  //Wednesday, the 10th of January 2007 03:05:01 PM\n 
\n\nHere are some standard date/time patterns that you might find helpful. They\nare not part of the source of Date.js, but to use them you can simply copy this\nblock of code into any script that is included after Date.js and they will also become\nglobally available on the Date object. Feel free to add or remove patterns as needed in your code.\n
\nDate.patterns = {\n    ISO8601Long:\"Y-m-d H:i:s\",\n    ISO8601Short:\"Y-m-d\",\n    ShortDate: \"n/j/Y\",\n    LongDate: \"l, F d, Y\",\n    FullDateTime: \"l, F d, Y g:i:s A\",\n    MonthDay: \"F d\",\n    ShortTime: \"g:i A\",\n    LongTime: \"g:i:s A\",\n    SortableDateTime: \"Y-m-d\\\\TH:i:s\",\n    UniversalSortableDateTime: \"Y-m-d H:i:sO\",\n    YearMonth: \"F, Y\"\n};\n
\n\nExample usage:\n
\nvar dt = new Date();\ndocument.write(dt.format(Date.patterns.ShortDate));\n 
", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : true, + "config" : [ + ], + "methods" : [ + { + "name" : "getDayOfYear", + "desc" : "Get the numeric day number of the year, adjusted for leap year.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Date", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "0 through 364 (365 in leap years)" + } + ] + }, + { + "name" : "getFirstDateOfMonth", + "desc" : "Get the first date of this date's month", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Date", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Date", + "desc" : "" + } + ] + }, + { + "name" : "format", + "desc" : "Formats a date given the supplied format string", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Date", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "format", + "type" : "String", + "desc" : "The format string", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The formatted date" + } + ] + }, + { + "name" : "clearTime", + "desc" : "Clears any time information from this date", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Date", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "clone", + "type" : "Boolean", + "desc" : "true to create a clone of this date, clear the time and return it", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Date", + "desc" : "this or the clone" + } + ] + }, + { + "name" : "getGMTColonOffset", + "desc" : "Get the offset from GMT of the current date (equivalent to the format specifier 'P').", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Date", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "2-characters representing hours and 2-characters representing minutes\nseperated by a colon and prefixed with + or - (e.g. '-06:00')" + } + ] + }, + { + "name" : "getLastDateOfMonth", + "desc" : "Get the last date of this date's month", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Date", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Date", + "desc" : "" + } + ] + }, + { + "name" : "getTimezone", + "desc" : "Get the timezone abbreviation of the current date (equivalent to the format specifier 'T').", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Date", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The abbreviated timezone name (e.g. 'CST')" + } + ] + }, + { + "name" : "getElapsed", + "desc" : "Returns the number of milliseconds between this date and date", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Date", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "date", + "type" : "Date", + "desc" : "(optional) Defaults to now", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The diff in milliseconds" + } + ] + }, + { + "name" : "add", + "desc" : "Provides a convenient method of performing basic date arithmetic. This method\ndoes not modify the Date instance being called - it creates and returns\na new Date instance containing the resulting date value.\n\nExamples:\n
\n//Basic usage:\nvar dt = new Date('10/29/2006').add(Date.DAY, 5);\ndocument.write(dt); //returns 'Fri Oct 06 2006 00:00:00'\n\n//Negative values will subtract correctly:\nvar dt2 = new Date('10/1/2006').add(Date.DAY, -5);\ndocument.write(dt2); //returns 'Tue Sep 26 2006 00:00:00'\n\n//You can even chain several calls together in one line!\nvar dt3 = new Date('10/1/2006').add(Date.DAY, 5).add(Date.HOUR, 8).add(Date.MINUTE, -30);\ndocument.write(dt3); //returns 'Fri Oct 06 2006 07:30:00'\n 
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Date", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "interval", + "type" : "String", + "desc" : "A valid date interval enum value", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Number", + "desc" : "The amount to add to the current date", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Date", + "desc" : "The new Date instance" + } + ] + }, + { + "name" : "getSuffix", + "desc" : "Get the English ordinal suffix of the current day (equivalent to the format specifier 'S').", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Date", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "'st, 'nd', 'rd' or 'th'" + } + ] + }, + { + "name" : "getFirstDayOfMonth", + "desc" : "Get the first day of the current month, adjusted for leap year. The returned value\nis the numeric day index within the week (0-6) which can be used in conjunction with\nthe {@link #monthNames} array to retrieve the textual day name.\nExample:\n
\nvar dt = new Date('1/10/2007');\ndocument.write(Date.dayNames[dt.getFirstDayOfMonth()]); //output: 'Monday'\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Date", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The day number (0-6)" + } + ] + }, + { + "name" : "getGMTOffset", + "desc" : "Get the offset from GMT of the current date (equivalent to the format specifier 'O').", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Date", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The 4-character offset string prefixed with + or - (e.g. '-0600')" + } + ] + }, + { + "name" : "getDaysInMonth", + "desc" : "Get the number of days in the current month, adjusted for leap year.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Date", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The number of days in the month" + } + ] + }, + { + "name" : "clone", + "desc" : "Creates and returns a new Date instance with the exact same date value as the called instance.\nDates are copied and passed by reference, so if a copied date variable is modified later, the original\nvariable will also be changed. When the intention is to create a new variable that will not\nmodify the original instance, you should create a clone.\n\nExample of correctly cloning a date:\n
\n//wrong way:\nvar orig = new Date('10/1/2006');\nvar copy = orig;\ncopy.setDate(5);\ndocument.write(orig);  //returns 'Thu Oct 05 2006'!\n\n//correct way:\nvar orig = new Date('10/1/2006');\nvar copy = orig.clone();\ncopy.setDate(5);\ndocument.write(orig);  //returns 'Thu Oct 01 2006'\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Date", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Date", + "desc" : "The new Date instance" + } + ] + }, + { + "name" : "getWeekOfYear", + "desc" : "Get the string representation of the numeric week number of the year\n(equivalent to the format specifier 'W').", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Date", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "'00' through '52'" + } + ] + }, + { + "name" : "isLeapYear", + "desc" : "Whether or not the current date is in a leap year.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Date", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the current date is in a leap year, else false" + } + ] + }, + { + "name" : "getLastDayOfMonth", + "desc" : "Get the last day of the current month, adjusted for leap year. The returned value\nis the numeric day index within the week (0-6) which can be used in conjunction with\nthe {@link #monthNames} array to retrieve the textual day name.\nExample:\n
\nvar dt = new Date('1/10/2007');\ndocument.write(Date.dayNames[dt.getLastDayOfMonth()]); //output: 'Wednesday'\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Date", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The day number (0-6)" + } + ] + }, + { + "name" : "parseDate", + "desc" : "Parses the passed string using the specified format. Note that this function expects dates in normal calendar\nformat, meaning that months are 1-based (1 = January) and not zero-based like in JavaScript dates. Any part of\nthe date format that is not specified will default to the current date value for that part. Time parts can also\nbe specified, but default to 0. Keep in mind that the input date string must precisely match the specified format\nstring or the parse operation will fail.\nExample Usage:\n
\n//dt = Fri May 25 2007 (current date)\nvar dt = new Date();\n\n//dt = Thu May 25 2006 (today's month/day in 2006)\ndt = Date.parseDate(\"2006\", \"Y\");\n\n//dt = Sun Jan 15 2006 (all date parts specified)\ndt = Date.parseDate(\"2006-1-15\", \"Y-m-d\");\n\n//dt = Sun Jan 15 2006 15:20:01 GMT-0600 (CST)\ndt = Date.parseDate(\"2006-1-15 3:20:01 PM\", \"Y-m-d h:i:s A\" );\n
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Date", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "input", + "type" : "String", + "desc" : "The unparsed date as a string", + "isOptional" : false + }, + { + "name" : "format", + "type" : "String", + "desc" : "The format the date is in", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Date", + "desc" : "The parsed date" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Function.json b/docs2/symbols/Function.json new file mode 100644 index 0000000000..d79284631e --- /dev/null +++ b/docs2/symbols/Function.json @@ -0,0 +1,186 @@ +{ + "name" : "Function", + "augments" : [ + ], + "desc" : "These functions are available on every Function object (any JavaScript function).", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : true, + "config" : [ + ], + "methods" : [ + { + "name" : "createDelegate", + "desc" : "Creates a delegate (callback) that sets the scope to obj.\nCall directly on any function. Example: this.myFunction.createDelegate(this)\nWill create a function that is automatically scoped to this.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Function", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "obj", + "type" : "Object", + "desc" : "(optional) The object for which the scope is set", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) Overrides arguments for the call. (Defaults to the arguments passed by the caller)", + "isOptional" : false + }, + { + "name" : "appendArgs", + "type" : "Boolean/Number", + "desc" : "(optional) if True args are appended to call args instead of overriding,\n if a number the args are inserted at the specified position", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Function", + "desc" : "The new function" + } + ] + }, + { + "name" : "defer", + "desc" : "Calls this function after the number of millseconds specified.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Function", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "millis", + "type" : "Number", + "desc" : "The number of milliseconds for the setTimeout call (if 0 the function is executed immediately)", + "isOptional" : false + }, + { + "name" : "obj", + "type" : "Object", + "desc" : "(optional) The object for which the scope is set", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) Overrides arguments for the call. (Defaults to the arguments passed by the caller)", + "isOptional" : false + }, + { + "name" : "appendArgs", + "type" : "Boolean/Number", + "desc" : "(optional) if True args are appended to call args instead of overriding,\n if a number the args are inserted at the specified position", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The timeout id that can be used with clearTimeout" + } + ] + }, + { + "name" : "createSequence", + "desc" : "Create a combined function call sequence of the original function + the passed function.\nThe resulting function returns the results of the original function.\nThe passed fcn is called with the parameters of the original function", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Function", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fcn", + "type" : "Function", + "desc" : "The function to sequence", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the passed fcn (Defaults to scope of original function or window)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Function", + "desc" : "The new function" + } + ] + }, + { + "name" : "createInterceptor", + "desc" : "Creates an interceptor function. The passed fcn is called before the original one. If it returns false, the original one is not called.\nThe resulting function returns the results of the original function.\nThe passed fcn is called with the parameters of the original function.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Function", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fcn", + "type" : "Function", + "desc" : "The function to call before the original", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the passed fcn (Defaults to scope of original function or window)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Function", + "desc" : "The new function" + } + ] + }, + { + "name" : "createCallback", + "desc" : "Creates a callback that passes arguments[0], arguments[1], arguments[2], ...\nCall directly on any function. Example: myFunction.createCallback(myarg, myarg2)\nWill create a function that is bound to those 2 args.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Function", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Function", + "desc" : "The new function" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Number.json b/docs2/symbols/Number.json new file mode 100644 index 0000000000..8121e97ff1 --- /dev/null +++ b/docs2/symbols/Number.json @@ -0,0 +1,48 @@ +{ + "name" : "Number", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : true, + "config" : [ + ], + "methods" : [ + { + "name" : "constrain", + "desc" : "Checks whether or not the current number is within a desired range. If the number is already within the\nrange it is returned, otherwise the min or max value is returned depending on which side of the range is\nexceeded. Note that this method returns the constrained value but does not change the current number.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Number", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "min", + "type" : "Number", + "desc" : "The minimum number in the range", + "isOptional" : false + }, + { + "name" : "max", + "type" : "Number", + "desc" : "The maximum number in the range", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The constrained value if outside the range, otherwise the current value" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Ajax.json b/docs2/symbols/Roo.Ajax.json new file mode 100644 index 0000000000..836bd4258c --- /dev/null +++ b/docs2/symbols/Roo.Ajax.json @@ -0,0 +1,546 @@ +{ + "name" : "Roo.Ajax", + "augments" : [ + "Roo.data.Connection", + "Roo.util.Observable" + ], + "desc" : "Global Ajax request class.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "method", + "type" : "String", + "desc" : "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)", + "memberOf" : "Roo.Ajax", + "values" : [ + ] + }, + { + "name" : "timeout", + "type" : "Number", + "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)", + "memberOf" : "Roo.Ajax", + "values" : [ + ] + }, + { + "name" : "autoAbort", + "type" : "Boolean", + "desc" : "(Optional) Whether a new request should abort any pending requests. (defaults to false)", + "memberOf" : "Roo.Ajax", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "The default URL to be used for requests to the server. (defaults to undefined)", + "memberOf" : "Roo.Ajax", + "values" : [ + ] + }, + { + "name" : "extraParams", + "type" : "Object", + "desc" : "An object containing properties which are used as extra parameters to each request made by this object. (defaults to undefined)", + "memberOf" : "Roo.Ajax", + "values" : [ + ] + }, + { + "name" : "disableCaching", + "type" : "Boolean", + "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)", + "memberOf" : "Roo.Ajax", + "values" : [ + ] + }, + { + "name" : "defaultHeaders", + "type" : "Object", + "desc" : "An object containing request headers which are added to each request made by this object. (defaults to undefined)", + "memberOf" : "Roo.Ajax", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "isLoading", + "desc" : "Determine whether this object has a request outstanding.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Connection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "transactionId", + "type" : "Number", + "desc" : "(Optional) defaults to the last transaction", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if there is an outstanding request." + } + ] + }, + { + "name" : "request", + "desc" : "Sends an HTTP request to a remote server.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Connection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "An object which may contain the following properties:", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "transactionId" + } + ] + }, + { + "name" : "abort", + "desc" : "Aborts any outstanding request.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Connection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "transactionId", + "type" : "Number", + "desc" : "(Optional) defaults to the last transaction", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "requestcomplete", + "desc" : "Fires if the request was successfully completed.", + "memberOf" : "Roo.data.Connection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "conn", + "type" : "Connection", + "desc" : "This Connection object.", + "isOptional" : false + }, + { + "name" : "response", + "type" : "Object", + "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The options config object passed to the {@link #request} method.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerequest", + "desc" : "Fires before a network request is made to retrieve a data object.", + "memberOf" : "Roo.data.Connection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "conn", + "type" : "Connection", + "desc" : "This Connection object.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The options config object passed to the {@link #request} method.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "requestexception", + "desc" : "Fires if an error HTTP status was returned from the server.\nSee {@link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html} for details of HTTP status codes.", + "memberOf" : "Roo.data.Connection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "conn", + "type" : "Connection", + "desc" : "This Connection object.", + "isOptional" : false + }, + { + "name" : "response", + "type" : "Object", + "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The options config object passed to the {@link #request} method.", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.BasicDialog.json b/docs2/symbols/Roo.BasicDialog.json new file mode 100644 index 0000000000..de8119377c --- /dev/null +++ b/docs2/symbols/Roo.BasicDialog.json @@ -0,0 +1,1320 @@ +{ + "name" : "Roo.BasicDialog", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "Lightweight Dialog Class. The code below shows the creation of a typical dialog using existing HTML markup:\n
\nvar dlg = new Roo.BasicDialog(\"my-dlg\", {\n    height: 200,\n    width: 300,\n    minHeight: 100,\n    minWidth: 150,\n    modal: true,\n    proxyDrag: true,\n    shadow: true\n});\ndlg.addKeyListener(27, dlg.hide, dlg); // ESC can also close the dialog\ndlg.addButton('OK', dlg.hide, dlg);    // Could call a save function instead of hiding\ndlg.addButton('Cancel', dlg.hide, dlg);\ndlg.show();\n
\n A Dialog should always be a direct child of the body element.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "y", + "type" : "Number", + "desc" : "The default top page coordinate of the dialog (defaults to center screen)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "modal", + "type" : "Boolean", + "desc" : "True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "animateTarget", + "type" : "String/Element", + "desc" : "Id or element from which the dialog should animate while opening\n(defaults to null with no animation)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right\nshadow (defaults to false)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "collapsible", + "type" : "Boolean", + "desc" : "False to remove the built-in top-right corner collapse button (defaults to true)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "autoTabs", + "type" : "Boolean", + "desc" : "If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "shadowOffset", + "type" : "Number", + "desc" : "The number of pixels to offset the shadow if displayed (defaults to 5)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "buttons", + "type" : "Array", + "desc" : "Array of buttons", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "minButtonWidth", + "type" : "Number", + "desc" : "Minimum width of all dialog buttons (defaults to 75)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "Default text to display in the title bar (defaults to null)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum allowable width for a resizable dialog (defaults to 200)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "buttonAlign", + "type" : "String", + "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "Boolean/DomHelper", + "desc" : "True to auto create from scratch, or using a DomHelper Object (defaults to false)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "minHeight", + "type" : "Number", + "desc" : "The minimum allowable height for a resizable dialog (defaults to 80)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "proxyDrag", + "type" : "Boolean", + "desc" : "True to drag a lightweight proxy element rather than the dialog itself, used when\ndraggable = true (defaults to false)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "shim", + "type" : "Boolean", + "desc" : "True to create an iframe shim that prevents selects from showing through (defaults to false)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "Width of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "constraintoviewport", + "type" : "Boolean", + "desc" : "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "syncHeightBeforeShow", + "type" : "Boolean", + "desc" : "True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "tabTag", + "type" : "String", + "desc" : "The tag name of tab elements, used when autoTabs = true (defaults to 'div')", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "resizable", + "type" : "Boolean", + "desc" : "False to disable manual dialog resizing (defaults to true)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "False to remove the built-in top-right corner close button (defaults to true)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "fixedcenter", + "type" : "Boolean", + "desc" : "True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "Height of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "resizeHandles", + "type" : "String", + "desc" : "Which resize handles to display - see the {@link Roo.Resizable} handles config\nproperty for valid values (defaults to 'all')", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The default left page coordinate of the dialog (defaults to center screen)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "draggable", + "type" : "Boolean", + "desc" : "False to disable dragging of the dialog within the viewport (defaults to true)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "expand", + "desc" : "Expands a collapsed dialog back to its normal state. Equivalent to the user\nclicking the expand dialog button.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "alignTo", + "desc" : "Aligns the dialog to the specified element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to.", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details).", + "isOptional" : false + }, + { + "name" : "offsets", + "type" : "Array", + "desc" : "(optional) Offset the positioning by [x, y]", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "setTitle", + "desc" : "Sets the dialog title text", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The title text to display", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if the dialog is visible", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "resizeTo", + "desc" : "Resizes the dialog.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "center", + "desc" : "Centers this dialog in the viewport", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "collapse", + "desc" : "Collapses the dialog to its minimized state (only the title bar is visible).\nEquivalent to the user clicking the collapse dialog button.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initTabs", + "desc" : "Reinitializes the tabs component, clearing out old tabs and finding new ones.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanel", + "desc" : "The tabs component" + } + ] + }, + { + "name" : "toFront", + "desc" : "Brings this dialog to the front of any other visible dialogs", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "moveTo", + "desc" : "Moves the dialog's top-left corner to the specified point", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "hide", + "desc" : "Hides the dialog.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Function to call when the dialog is hidden", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this dialog and all its supporting elements (including any tabs, shim,\nshadow, proxy, mask, etc.) Also removes all event listeners.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "removeEl", + "type" : "Boolean", + "desc" : "(optional) true to remove the element from the DOM", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Shows the dialog.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "animateTarget", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "(optional) Reset the animation target", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "anchorTo", + "desc" : "Anchors an element to another element and realigns it when the window is resized.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to.", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details)", + "isOptional" : false + }, + { + "name" : "offsets", + "type" : "Array", + "desc" : "(optional) Offset the positioning by [x, y]", + "isOptional" : false + }, + { + "name" : "monitorScroll", + "type" : "Boolean/Number", + "desc" : "(optional) true to monitor body scroll and reposition. If this parameter\nis a number, it is used as the buffer delay (defaults to 50ms).", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "addButton", + "desc" : "Adds a button to the footer section of the dialog.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "String/Object", + "desc" : "A string becomes the button text, an object can either be a Button config\nobject or a valid Roo.DomHelper element config", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The function called when the button is clicked", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the handler function (accepts position as a property)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Button", + "desc" : "The new button" + } + ] + }, + { + "name" : "addKeyListener", + "desc" : "Adds a key listener for when this dialog is displayed. This allows you to hook in a function that will be\nexecuted in response to a particular key being pressed while the dialog is active.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "key", + "type" : "Number/Array/Object", + "desc" : "Either the numeric key code, array of key codes or an object with the following options:\n {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Focuses the dialog. If a defaultButton is set, it will receive focus, otherwise the\ndialog itself will receive focus.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getTabs", + "desc" : "Returns the TabPanel component (creates it if it doesn't exist).\nNote: If you wish to simply check for the existence of tabs without creating them,\ncheck for a null 'tabs' property.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanel", + "desc" : "The tabs component" + } + ] + }, + { + "name" : "setDefaultButton", + "desc" : "Sets the default button to be focused when the dialog is displayed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "btn", + "type" : "Roo.BasicDialog.Button", + "desc" : "The button object returned by {@link #addButton}", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "toBack", + "desc" : "Sends this dialog to the back (under) of any other visible dialogs", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "setContentSize", + "desc" : "Resizes the dialog to fit the specified content size.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "restoreState", + "desc" : "Restores the previous state of the dialog if Roo.state is configured.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the element for this dialog", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The underlying dialog Element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "move", + "desc" : "Fires when this dialog is moved by the user.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.BasicDialog", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new page X", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new page Y", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires when this dialog is resized by the user.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.BasicDialog", + "desc" : "", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before this dialog is hidden.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.BasicDialog", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before this dialog is shown.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.BasicDialog", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires when this dialog is hidden.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.BasicDialog", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires when this dialog is shown.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.BasicDialog", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keydown", + "desc" : "Fires when a key is pressed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.BasicDialog", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.BasicLayoutRegion.json b/docs2/symbols/Roo.BasicLayoutRegion.json new file mode 100644 index 0000000000..42323f062e --- /dev/null +++ b/docs2/symbols/Roo.BasicLayoutRegion.json @@ -0,0 +1,843 @@ +{ + "name" : "Roo.BasicLayoutRegion", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "This class represents a lightweight region in a layout manager. This region does not move dom nodes\nand does not have a titlebar, tabs or any other features. All it does is size and position \npanels. To create a BasicLayoutRegion, add lightweight:true or basic:true to your regions config.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "isVisible", + "desc" : "Returns true if this region is currently visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the container element for this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "hasPanel", + "desc" : "Returns true if the panel is in this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getActivePanel", + "desc" : "Get the active panel for this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The active panel or null" + } + ] + }, + { + "name" : "resizeTo", + "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new width or height", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "showPanel", + "desc" : "Show the specified panel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panelId", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The shown panel or null" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Returns this regions position (north/south/east/west/center).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "add", + "desc" : "Add the passed ContentPanel(s)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "ContentPanel...", + "desc" : "The ContentPanel(s) to add (you can pass more than one)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel added (if only one was added)" + } + ] + }, + { + "name" : "remove", + "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + }, + { + "name" : "preservePanel", + "type" : "Boolean", + "desc" : "Overrides the config preservePanel option", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel that was removed" + } + ] + }, + { + "name" : "getPanel", + "desc" : "Returns the panel specified or null if it's not in this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "paneladded", + "desc" : "Fires when a panel is added.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalidated", + "desc" : "Fires when the layout for this region is changed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "expanded", + "desc" : "Fires when this region is expanded.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeremove", + "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The cancel event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collapsed", + "desc" : "Fires when this region is collapsed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "panelremoved", + "desc" : "Fires when a panel is removed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforecollapse", + "desc" : "Fires when this region before collapse.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "slidehide", + "desc" : "Fires when this region slides out of view.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "visibilitychange", + "desc" : "Fires when this region is shown or hidden", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "visibility", + "type" : "Boolean", + "desc" : "true or false", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "slideshow", + "desc" : "Fires when this region is slid into view.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "panelactivated", + "desc" : "Fires when a panel is activated.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The activated panel", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resized", + "desc" : "Fires when the user resizes this region.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size (width for east/west, height for north/south)", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.BorderLayout.json b/docs2/symbols/Roo.BorderLayout.json new file mode 100644 index 0000000000..d35fd4276b --- /dev/null +++ b/docs2/symbols/Roo.BorderLayout.json @@ -0,0 +1,800 @@ +{ + "name" : "Roo.BorderLayout", + "augments" : [ + "Roo.LayoutManager", + "Roo.util.Observable" + ], + "desc" : "This class represents a common layout manager used in desktop applications. For screenshots and more details,\nplease see:

\nCross Browser Layouts - Part 1
\nCross Browser Layouts - Part 2

\nExample:\n
\n var layout = new Roo.BorderLayout(document.body, {\n    north: {\n        initialSize: 25,\n        titlebar: false\n    },\n    west: {\n        split:true,\n        initialSize: 200,\n        minSize: 175,\n        maxSize: 400,\n        titlebar: true,\n        collapsible: true\n    },\n    east: {\n        split:true,\n        initialSize: 202,\n        minSize: 175,\n        maxSize: 400,\n        titlebar: true,\n        collapsible: true\n    },\n    south: {\n        split:true,\n        initialSize: 100,\n        minSize: 100,\n        maxSize: 200,\n        titlebar: true,\n        collapsible: true\n    },\n    center: {\n        titlebar: true,\n        autoScroll:true,\n        resizeTabs: true,\n        minTabWidth: 50,\n        preferredTabWidth: 150\n    }\n});\n\n// shorthand\nvar CP = Roo.ContentPanel;\n\nlayout.beginUpdate();\nlayout.add(\"north\", new CP(\"north\", \"North\"));\nlayout.add(\"south\", new CP(\"south\", {title: \"South\", closable: true}));\nlayout.add(\"west\", new CP(\"west\", {title: \"West\"}));\nlayout.add(\"east\", new CP(\"autoTabs\", {title: \"Auto Tabs\", closable: true}));\nlayout.add(\"center\", new CP(\"center1\", {title: \"Close Me\", closable: true}));\nlayout.add(\"center\", new CP(\"center2\", {title: \"Center Panel\", closable: false}));\nlayout.getRegion(\"center\").showPanel(\"center1\");\nlayout.endUpdate();\n
\n\nThe container the layout is rendered into can be either the body element or any other element.\nIf it is not the body element, the container needs to either be an absolute positioned element,\nor you will need to add \"position:relative\" to the css of the container. You will also need to specify\nthe container size if it is not the body element.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "create", + "desc" : "Shortcut for creating a new BorderLayout object and adding one or more ContentPanels to it in a single step, handling\nthe beginUpdate and endUpdate calls internally. The key to this method is the panels property that can be\nprovided with each region config, which allows you to add ContentPanel configs in addition to the region configs\nduring creation. The following code is equivalent to the constructor-based example at the beginning of this class:\n
\n// shorthand\nvar CP = Roo.ContentPanel;\n\nvar layout = Roo.BorderLayout.create({\n    north: {\n        initialSize: 25,\n        titlebar: false,\n        panels: [new CP(\"north\", \"North\")]\n    },\n    west: {\n        split:true,\n        initialSize: 200,\n        minSize: 175,\n        maxSize: 400,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"west\", {title: \"West\"})]\n    },\n    east: {\n        split:true,\n        initialSize: 202,\n        minSize: 175,\n        maxSize: 400,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"autoTabs\", {title: \"Auto Tabs\", closable: true})]\n    },\n    south: {\n        split:true,\n        initialSize: 100,\n        minSize: 100,\n        maxSize: 200,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"south\", {title: \"South\", closable: true})]\n    },\n    center: {\n        titlebar: true,\n        autoScroll:true,\n        resizeTabs: true,\n        minTabWidth: 50,\n        preferredTabWidth: 150,\n        panels: [\n            new CP(\"center1\", {title: \"Close Me\", closable: true}),\n            new CP(\"center2\", {title: \"Center Panel\", closable: false})\n        ]\n    }\n}, document.body);\n\nlayout.getRegion(\"center\").showPanel(\"center1\");\n
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "", + "desc" : "", + "isOptional" : false + }, + { + "name" : "targetEl", + "type" : "", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "restoreState", + "desc" : "Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "provider", + "type" : "Roo.state.Provider", + "desc" : "(optional) An alternate state provider", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addRegion", + "desc" : "Creates and adds a new region if it doesn't already exist.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The target region key (north, south, east, west or center).", + "isOptional" : false + }, + { + "name" : "config", + "type" : "Object", + "desc" : "The regions config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BorderLayoutRegion", + "desc" : "The new region" + } + ] + }, + { + "name" : "showPanel", + "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panelId", + "type" : "String/ContentPanel", + "desc" : "The panels id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The shown panel or null" + } + ] + }, + { + "name" : "batchAdd", + "desc" : "Adds a batch of multiple ContentPanels dynamically by passing a special regions config object. This config\nobject should contain properties for each region to add ContentPanels to, and each property's value should be\na valid ContentPanel config object. Example:\n
\n// Create the main layout\nvar layout = new Roo.BorderLayout('main-ct', {\n    west: {\n        split:true,\n        minSize: 175,\n        titlebar: true\n    },\n    center: {\n        title:'Components'\n    }\n}, 'main-ct');\n\n// Create and add multiple ContentPanels at once via configs\nlayout.batchAdd({\n   west: {\n       id: 'source-files',\n       autoCreate:true,\n       title:'Ext Source Files',\n       autoScroll:true,\n       fitToFrame:true\n   },\n   center : {\n       el: cview,\n       autoScroll:true,\n       fitToFrame:true,\n       toolbar: tb,\n       resizeEl:'cbody'\n   }\n});\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "regions", + "type" : "Object", + "desc" : "An object containing ContentPanel configs by region name", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Remove a ContentPanel (or subclass) to this layout.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The target region key (north, south, east, west or center).", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Number/String/Roo.ContentPanel", + "desc" : "The index, id or panel to remove", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The removed panel" + } + ] + }, + { + "name" : "findPanel", + "desc" : "Searches all regions for a panel with the specified id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panelId", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel or null if it wasn't found" + } + ] + }, + { + "name" : "layout", + "desc" : "Performs a layout update.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "addxtype", + "desc" : "Adds a xtype elements to the layout.\n
\n\nlayout.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\nlayout.addxtype({\n        xtype : 'NestedLayoutPanel',\n        region: 'west',\n        layout: {\n           center: { },\n           west: { }   \n        },\n        items : [ ... list of content panels or nested layout panels.. ]\n   }\n);\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cfg", + "type" : "Object", + "desc" : "Xtype definition of item to add.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "add", + "desc" : "Adds a ContentPanel (or subclass) to this layout.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The target region key (north, south, east, west or center).", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The added panel" + } + ] + }, + { + "name" : "getRegion", + "desc" : "Returns the specified region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.LayoutRegion", + "desc" : "" + } + ] + }, + { + "name" : "beginUpdate", + "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isUpdating", + "desc" : "Returns true if this layout is currently being updated", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getViewSize", + "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The size as an object {width: (the width), height: (the height)}" + } + ] + }, + { + "name" : "endUpdate", + "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "noLayout", + "type" : "Boolean", + "desc" : "true to disable a layout update", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns the Element this layout is bound to.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "layout", + "desc" : "Fires when a layout is performed.", + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutManager", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "regionexpanded", + "desc" : "Fires when a region is expanded.", + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The expanded region", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "regionresized", + "desc" : "Fires when the user resizes a region.", + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The resized region", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size (width for east/west, height for north/south)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "regioncollapsed", + "desc" : "Fires when a region is collapsed.", + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The collapsed region", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.BoxComponent.json b/docs2/symbols/Roo.BoxComponent.json new file mode 100644 index 0000000000..f26ab2b83d --- /dev/null +++ b/docs2/symbols/Roo.BoxComponent.json @@ -0,0 +1,1162 @@ +{ + "name" : "Roo.BoxComponent", + "augments" : [ + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Base class for any visual {@link Roo.Component} that uses a box container. BoxComponent provides automatic box\nmodel adjustments for sizing and positioning and will work correctly withnin the Component rendering model. All\ncontainer classes should subclass BoxComponent so that they will work consistently when nested within other Ext\nlayout containers.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Button.json b/docs2/symbols/Roo.Button.json new file mode 100644 index 0000000000..7115f89b49 --- /dev/null +++ b/docs2/symbols/Roo.Button.json @@ -0,0 +1,883 @@ +{ + "name" : "Roo.Button", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "Simple Button class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "String/Object", + "desc" : "The tooltip for the button - can be a string or QuickTips config object", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "text", + "type" : "String", + "desc" : "The button text", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "renderTo", + "type" : "String/HTMLElement/Element", + "desc" : "The element to append the button to", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to start hidden (defaults to false)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "toggleGroup", + "type" : "String", + "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "handleMouseEvents", + "type" : "Boolean", + "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "menu", + "type" : "Mixed", + "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "enableToggle", + "type" : "Boolean", + "desc" : "True to enable pressed/not pressed toggling (defaults to false)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function called when the button is clicked (can be used instead of click event)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "The scope of the handler", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum width for this button (used to give a set of buttons a common width)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to start disabled (defaults to false)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "pressed", + "type" : "Boolean", + "desc" : "True to start pressed (only if enableToggle = true)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "template", + "type" : "Roo.Template", + "desc" : "(Optional)\nAn {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the button's main element.", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The DOM tabIndex for this button (defaults to undefined)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "iconCls", + "type" : "String", + "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "menuAlign", + "type" : "String", + "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "icon", + "type" : "String", + "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "tooltipType", + "type" : "String", + "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "clickEvent", + "type" : "String", + "desc" : "The type of event to map to the button's event handler (defaults to 'click')", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "repeat", + "type" : "Boolean/Object", + "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "type", + "type" : "String", + "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).", + "memberOf" : "Roo.Button", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "show", + "desc" : "Show this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Focus the button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setHandler", + "desc" : "Assigns this button's click handler", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "handler", + "type" : "Function", + "desc" : "The function to call when the button is clicked", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) Scope for the function passed in", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Disable this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Enable this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns the button's underlying element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for boolean enable/disable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "enabled", + "type" : "Boolean", + "desc" : "True to enable, false to disable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function for boolean show/hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this Button and removes any listeners.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getText", + "desc" : "Gets the text for this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The button text" + } + ] + }, + { + "name" : "setText", + "desc" : "Sets this button's text", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The button text", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toggle", + "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "state", + "type" : "Boolean", + "desc" : "(optional) Force a particular state", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "render", + "desc" : "Fires when the button is rendered", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fires when this button is clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "EventObject", + "desc" : "The click event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseover", + "desc" : "Fires when the mouse hovers over the button", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toggle", + "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "pressed", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseout", + "desc" : "Fires when the mouse exits the button", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.CalendarPanel.json b/docs2/symbols/Roo.CalendarPanel.json new file mode 100644 index 0000000000..6658d4546b --- /dev/null +++ b/docs2/symbols/Roo.CalendarPanel.json @@ -0,0 +1,951 @@ +{ + "name" : "Roo.CalendarPanel", + "augments" : [ + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Calendar class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "monthchange", + "desc" : "Fires when the displayed month changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "DatePicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Date", + "desc" : "The selected month", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "evententer", + "desc" : "Fires when mouse over an event", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Calendar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "Event", + "type" : "event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "eventleave", + "desc" : "Fires when the mouse leaves an", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Calendar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "", + "type" : "event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "eventclick", + "desc" : "Fires when the mouse click an", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Calendar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "", + "type" : "event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rendered", + "desc" : "Fires when the grid is rendered", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Calendar", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "select", + "desc" : "Fires when a date is selected", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "DatePicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Date", + "desc" : "The selected date", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.ColorPalette.json b/docs2/symbols/Roo.ColorPalette.json new file mode 100644 index 0000000000..382f60b752 --- /dev/null +++ b/docs2/symbols/Roo.ColorPalette.json @@ -0,0 +1,878 @@ +{ + "name" : "Roo.ColorPalette", + "augments" : [ + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Simple color palette class for choosing colors. The palette can be rendered to any container.
\nHere's an example of typical usage:\n
\nvar cp = new Roo.ColorPalette({value:'993300'});  // initial selected color\ncp.render('my-div');\n\ncp.on('select', function(palette, selColor){\n    // do something with selColor\n});\n
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "allowReselect", + "type" : "Boolean", + "desc" : "If set to true then reselecting a color that is already selected fires the selection event", + "memberOf" : "Roo.ColorPalette", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "value", + "type" : "String", + "desc" : "The initial color to highlight (should be a valid 6-digit color hex code without the # symbol). Note that\nthe hex codes are case-sensitive.", + "memberOf" : "Roo.ColorPalette", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "itemCls", + "type" : "String", + "desc" : "The CSS class to apply to the containing element (defaults to \"x-color-palette\")", + "memberOf" : "Roo.ColorPalette", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "select", + "desc" : "Selects the specified color in the palette (fires the select event)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ColorPalette", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "color", + "type" : "String", + "desc" : "A valid 6-digit color hex code (# will be stripped if included)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "select", + "desc" : "Fires when a color is selected", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "ColorPalette", + "desc" : "", + "isOptional" : false + }, + { + "name" : "color", + "type" : "String", + "desc" : "The 6-digit color hex code (without the # symbol)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Component.json b/docs2/symbols/Roo.Component.json new file mode 100644 index 0000000000..e16fea31aa --- /dev/null +++ b/docs2/symbols/Roo.Component.json @@ -0,0 +1,806 @@ +{ + "name" : "Roo.Component", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "Base class for all major Roo components. All subclasses of Component can automatically participate in the standard\nRoo component lifecycle of creation, rendering and destruction. They also have automatic support for basic hide/show\nand enable/disable behavior. Component allows any subclass to be lazy-rendered into any {@link Roo.Container} and\nto be automatically registered with the {@link Roo.ComponentMgr} so that it can be referenced at any time via {@link Roo.getCmp}.\nAll visual components (widgets) that require rendering into a layout should subclass Component.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.ComponentMgr.json b/docs2/symbols/Roo.ComponentMgr.json new file mode 100644 index 0000000000..005ad98411 --- /dev/null +++ b/docs2/symbols/Roo.ComponentMgr.json @@ -0,0 +1,115 @@ +{ + "name" : "Roo.ComponentMgr", + "augments" : [ + ], + "desc" : "Provides a common registry of all components on a page so that they can be easily accessed by component id (see {@link Roo.getCmp}).", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "onAvailable", + "desc" : "Registers a function that will be called when a specified component is added to ComponentMgr", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ComponentMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The component id", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Funtction", + "desc" : "The callback function", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "The scope of the callback", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "get", + "desc" : "Returns a component by id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ComponentMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The component id", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "register", + "desc" : "Registers a component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ComponentMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "c", + "type" : "Roo.Component", + "desc" : "The component", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "unregister", + "desc" : "Unregisters a component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ComponentMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "c", + "type" : "Roo.Component", + "desc" : "The component", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.CompositeElement.json b/docs2/symbols/Roo.CompositeElement.json new file mode 100644 index 0000000000..f7608fe938 --- /dev/null +++ b/docs2/symbols/Roo.CompositeElement.json @@ -0,0 +1,355 @@ +{ + "name" : "Roo.CompositeElement", + "augments" : [ + ], + "desc" : "Standard composite class. Creates a Roo.Element for every element in the collection.\n

\nNOTE: Although they are not listed, this class supports all of the set/update methods of Roo.Element. All Roo.Element\nactions will be performed on all the elements in this collection.\n

\nAll methods return this and can be chained.\n
\n var els = Roo.select(\"#some-el div.some-class\", true);\n // or select directly from an existing element\n var el = Roo.get('some-el');\n el.select('div.some-class', true);\n\n els.setWidth(100); // all elements become 100 width\n els.hide(true); // all elements fade out and hide\n // or\n els.setWidth(100).hide(true);\n 
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "add", + "desc" : "Adds elements to this composite.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "els", + "type" : "String/Array", + "desc" : "A string CSS selector, an array of elements or an element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "CompositeElement", + "desc" : "this" + } + ] + }, + { + "name" : "contains", + "desc" : "Returns true if this composite contains the passed element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] + }, + { + "name" : "each", + "desc" : "Calls the passed function passing (el, this, index) for each element in this composite.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The this object (defaults to the element)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "CompositeElement", + "desc" : "this" + } + ] + }, + { + "name" : "replaceElement", + "desc" : "Replaces the specified element with the passed element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element/Number", + "desc" : "The id of an element, the Element itself, the index of the element in this composite\nto replace.", + "isOptional" : false + }, + { + "name" : "replacement", + "type" : "String/HTMLElement/Element", + "desc" : "The id of an element or the Element itself.", + "isOptional" : false + }, + { + "name" : "domReplace", + "type" : "Boolean", + "desc" : "(Optional) True to remove and replace the element in the document too.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "CompositeElement", + "desc" : "this" + } + ] + }, + { + "name" : "fill", + "desc" : "Clears this composite and adds the elements returned by the passed selector.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "els", + "type" : "String/Array", + "desc" : "A string CSS selector, an array of elements or an element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "CompositeElement", + "desc" : "this" + } + ] + }, + { + "name" : "clear", + "desc" : "Removes all elements.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "filter", + "desc" : "Filters this composite to only elements that match the passed selector.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "A string CSS selector", + "isOptional" : false + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "return inverse filter (not matches)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "CompositeElement", + "desc" : "this" + } + ] + }, + { + "name" : "item", + "desc" : "Returns the Element object at the specified index", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "last", + "desc" : "Returns the last Element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "removeElement", + "desc" : "Removes the specified element(s).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "Mixed", + "desc" : "The id of an element, the Element itself, the index of the element in this composite\nor an array of any of those.", + "isOptional" : false + }, + { + "name" : "removeDom", + "type" : "Boolean", + "desc" : "(optional) True to also remove the element from the document", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "CompositeElement", + "desc" : "this" + } + ] + }, + { + "name" : "indexOf", + "desc" : "Returns true if this composite contains the passed element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] + }, + { + "name" : "getCount", + "desc" : "Returns the number of elements in this composite", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Number" + } + ] + }, + { + "name" : "first", + "desc" : "Returns the first Element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.CompositeElementLite.json b/docs2/symbols/Roo.CompositeElementLite.json new file mode 100644 index 0000000000..9906b49278 --- /dev/null +++ b/docs2/symbols/Roo.CompositeElementLite.json @@ -0,0 +1,356 @@ +{ + "name" : "Roo.CompositeElementLite", + "augments" : [ + "Roo.CompositeElement" + ], + "desc" : "Flyweight composite class. Reuses the same Roo.Element for element operations.\n
\n var els = Roo.select(\"#some-el div.some-class\");\n // or select directly from an existing element\n var el = Roo.get('some-el');\n el.select('div.some-class');\n\n els.setWidth(100); // all elements become 100 width\n els.hide(true); // all elements fade out and hide\n // or\n els.setWidth(100).hide(true);\n 


\nNOTE: Although they are not listed, this class supports all of the set/update methods of Roo.Element. All Roo.Element\nactions will be performed on all the elements in this collection.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "each", + "desc" : "Calls the passed function passing (el, this, index) for each element in this composite. The element\npassed is the flyweight (shared) Roo.Element instance, so if you require a\na reference to the dom node, use el.dom.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElementLite", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The this object (defaults to the element)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "CompositeElement", + "desc" : "this" + } + ] + }, + { + "name" : "item", + "desc" : "Returns a flyweight Element of the dom element object at the specified index", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElementLite", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "add", + "desc" : "Adds elements to this composite.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "els", + "type" : "String/Array", + "desc" : "A string CSS selector, an array of elements or an element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "CompositeElement", + "desc" : "this" + } + ] + }, + { + "name" : "contains", + "desc" : "Returns true if this composite contains the passed element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] + }, + { + "name" : "replaceElement", + "desc" : "Replaces the specified element with the passed element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element/Number", + "desc" : "The id of an element, the Element itself, the index of the element in this composite\nto replace.", + "isOptional" : false + }, + { + "name" : "replacement", + "type" : "String/HTMLElement/Element", + "desc" : "The id of an element or the Element itself.", + "isOptional" : false + }, + { + "name" : "domReplace", + "type" : "Boolean", + "desc" : "(Optional) True to remove and replace the element in the document too.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "CompositeElement", + "desc" : "this" + } + ] + }, + { + "name" : "fill", + "desc" : "Clears this composite and adds the elements returned by the passed selector.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "els", + "type" : "String/Array", + "desc" : "A string CSS selector, an array of elements or an element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "CompositeElement", + "desc" : "this" + } + ] + }, + { + "name" : "clear", + "desc" : "Removes all elements.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "filter", + "desc" : "Filters this composite to only elements that match the passed selector.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "A string CSS selector", + "isOptional" : false + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "return inverse filter (not matches)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "CompositeElement", + "desc" : "this" + } + ] + }, + { + "name" : "last", + "desc" : "Returns the last Element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "removeElement", + "desc" : "Removes the specified element(s).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "Mixed", + "desc" : "The id of an element, the Element itself, the index of the element in this composite\nor an array of any of those.", + "isOptional" : false + }, + { + "name" : "removeDom", + "type" : "Boolean", + "desc" : "(optional) True to also remove the element from the document", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "CompositeElement", + "desc" : "this" + } + ] + }, + { + "name" : "indexOf", + "desc" : "Returns true if this composite contains the passed element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] + }, + { + "name" : "getCount", + "desc" : "Returns the number of elements in this composite", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Number" + } + ] + }, + { + "name" : "first", + "desc" : "Returns the first Element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.CompositeElement", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.ContentPanel.json b/docs2/symbols/Roo.ContentPanel.json new file mode 100644 index 0000000000..4ffa45ae10 --- /dev/null +++ b/docs2/symbols/Roo.ContentPanel.json @@ -0,0 +1,853 @@ +{ + "name" : "Roo.ContentPanel", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "A basic ContentPanel element.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "fitToFrame", + "type" : "Boolean", + "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "background", + "type" : "Boolean", + "desc" : "True if the panel should not be activated when it is added (defaults to false)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "toolbar", + "type" : "Toolbar", + "desc" : "A toolbar for this panel", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "region", + "type" : "String", + "desc" : "which region to put this panel on (when used with xtype constructors)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + "(center", + "north", + "south", + "east", + "west)" + ] + }, + { + "name" : "content", + "type" : "String", + "desc" : "Raw content to fill content panel with (uses setContent on construction.)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title for this panel", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "fitContainer", + "type" : "Boolean", + "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "True if the panel can be closed/removed", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "adjustments", + "type" : "Array", + "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "Calls {@link #setUrl} with this value", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "resizeEl", + "type" : "String/HTMLElement/Element", + "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "load", + "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "Object/String/Function", + "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n
\npanel.load({\n    url: \"your-url.php\",\n    params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n    callback: yourFunction,\n    scope: yourObject, //(optional scope)\n    discardUrl: false,\n    nocache: false,\n    text: \"Loading...\",\n    timeout: 30,\n    scripts: false\n});\n
\nThe only required property is url. The optional properties nocache, text and scripts\nare shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this panel UpdateManager instance.", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)", + "isOptional" : false + }, + { + "name" : "discardUrl", + "type" : "Boolean", + "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "this" + } + ] + }, + { + "name" : "getUpdateManager", + "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "isClosable", + "desc" : "Returns true is this panel was configured to be closable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this panel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns this panel's element - used by regiosn to add.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "setContent", + "desc" : "Updates this panel's element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "content", + "type" : "String", + "desc" : "The new content", + "isOptional" : false + }, + { + "name" : "loadScripts", + "type" : "Boolean", + "desc" : "(optional) true to look for and process scripts", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns this panel's id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "addxtype", + "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cfg", + "type" : "Object", + "desc" : "Xtype definition of item to add.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "refresh", + "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getTitle", + "desc" : "Returns this panel's title", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "setTitle", + "desc" : "Set this panel's title", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getToolbar", + "desc" : "Returns the toolbar for this Panel if one was configured.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar", + "desc" : "" + } + ] + }, + { + "name" : "setUrl", + "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "String/Function", + "desc" : "The URL to load the content from or a function to call to get the URL", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)", + "isOptional" : false + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "deactivate", + "desc" : "Fires when this panel is activated.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires when this panel is resized if fitToFrame is true.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The width after any component adjustments", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The height after any component adjustments", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires when this tab is created", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Fires when this panel is activated.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.DDView.json b/docs2/symbols/Roo.DDView.json new file mode 100644 index 0000000000..f3314f8648 --- /dev/null +++ b/docs2/symbols/Roo.DDView.json @@ -0,0 +1,256 @@ +{ + "name" : "Roo.DDView", + "augments" : [ + ], + "desc" : "A DnD enabled version of Roo.View.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "dropGroup", + "type" : "String/Array", + "desc" : "The ddgroup name(s) for the View's DropZone.", + "memberOf" : "Roo.DDView", + "values" : [ + ] + }, + { + "name" : "allowCopy", + "type" : "Boolean", + "desc" : "Causes ctrl/drag operations to copy nodes rather than move.", + "memberOf" : "Roo.DDView", + "values" : [ + ] + }, + { + "name" : "copy", + "type" : "Boolean", + "desc" : "Causes drag operations to copy nodes rather than move.", + "memberOf" : "Roo.DDView", + "values" : [ + ] + }, + { + "name" : "dragGroup", + "type" : "String/Array", + "desc" : "The ddgroup name(s) for the View's DragZone.", + "memberOf" : "Roo.DDView", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getDropPoint", + "desc" : "Decide whether to drop above or below a View node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DDView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DDView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "a parenthesised list of the ids of the Records in the View." + } + ] + }, + { + "name" : "setDeletable", + "desc" : "Utility method. Add a delete option to the DDView's context menu.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DDView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "imageUrl", + "type" : "String", + "desc" : "The URL of the \"delete\" icon image.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setValue", + "desc" : "Loads the View from a JSON string representing the Records to put into the Store.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DDView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getTargetFromEvent", + "desc" : "Part of the Roo.dd.DropZone interface. If no target node is found, the\n\twhole Element becomes the target, and this causes the drop gesture to append.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DDView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onDblClick", + "desc" : "Double click fires the event, but also, if this is draggable, and there is only one other\n\trelated DropZone, it transfers the selected node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DDView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getDragData", + "desc" : "Create the drag data which consists of an object which has the property \"ddel\" as\n\tthe drag proxy element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DDView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDraggable", + "desc" : "Specify to which ddGroup items in this DDView may be dragged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DDView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Allows this class to be an Roo.form.Field so it can be found using {@link Roo.form.BasicForm#findField}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DDView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Remove {@link Roo.data.Record}s at the specified indices.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DDView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectedIndices", + "type" : "Array/Number", + "desc" : "The index (or Array of indices) of Records to remove.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getContextMenu", + "desc" : "Return the context menu for this DDView.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DDView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDroppable", + "desc" : "Specify from which ddGroup this DDView accepts drops.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DDView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.DatePicker.json b/docs2/symbols/Roo.DatePicker.json new file mode 100644 index 0000000000..13cb9c4b28 --- /dev/null +++ b/docs2/symbols/Roo.DatePicker.json @@ -0,0 +1,1068 @@ +{ + "name" : "Roo.DatePicker", + "augments" : [ + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Simple date picker class.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "startDay", + "type" : "Number", + "desc" : "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "monthYearText", + "type" : "String", + "desc" : "The header month selector tooltip (defaults to 'Choose a month (Control+Up/Down to move years)')", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "monthNames", + "type" : "Array", + "desc" : "An array of textual month names which can be overriden for localization support (defaults to Date.monthNames)", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "format", + "type" : "String", + "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "nextText", + "type" : "String", + "desc" : "The next month navigation button tooltip (defaults to 'Next Month (Control+Right)')", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "maxText", + "type" : "String", + "desc" : "The error text to display if the maxDate validation fails (defaults to \"This date is after the maximum date\")", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "constrainToViewport", + "type" : "Boolean", + "desc" : "True to constrain the date picker to the viewport (defaults to true)", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "minText", + "type" : "String", + "desc" : "The error text to display if the minDate validation fails (defaults to \"This date is before the minimum date\")", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "disabledDatesText", + "type" : "String", + "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to \"\")", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "todayTip", + "type" : "String", + "desc" : "The tooltip to display for the button that selects the current date (defaults to \"{current date} (Spacebar)\")", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "todayText", + "type" : "String", + "desc" : "The text to display on the button that selects the current date (defaults to \"Today\")", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "cancelText", + "type" : "String", + "desc" : "The text to display on the cancel button", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "showClear", + "type" : "Bool", + "desc" : "Show a clear button (usefull for date form elements that can be blank.)", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "prevText", + "type" : "String", + "desc" : "The previous month navigation button tooltip (defaults to 'Previous Month (Control+Left)')", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "dayNames", + "type" : "Array", + "desc" : "An array of textual day names which can be overriden for localization support (defaults to Date.dayNames)", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "disabledDaysText", + "type" : "String", + "desc" : "The tooltip to display when the date falls on a disabled day (defaults to \"\")", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "disabledDatesRE", + "type" : "RegExp", + "desc" : "JavaScript regular expression used to disable a pattern of dates (defaults to null)", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "minDate", + "type" : "Date", + "desc" : "Minimum allowable date (JavaScript date object, defaults to null)", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "disabledDays", + "type" : "Array", + "desc" : "An array of days to disable, 0-based. For example, [0, 6] disables Sunday and Saturday (defaults to null).", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "okText", + "type" : "String", + "desc" : "The text to display on the ok button", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "maxDate", + "type" : "Date", + "desc" : "Maximum allowable date (JavaScript date object, defaults to null)", + "memberOf" : "Roo.DatePicker", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getValue", + "desc" : "Gets the current selected value of the date field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DatePicker", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Date", + "desc" : "The selected date" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets the value of the date field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DatePicker", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Date", + "desc" : "The date to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "select", + "desc" : "Fires when a date is selected", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "DatePicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Date", + "desc" : "The selected date", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "monthchange", + "desc" : "Fires when the displayed month changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "DatePicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Date", + "desc" : "The selected month", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.DialogManager.json b/docs2/symbols/Roo.DialogManager.json new file mode 100644 index 0000000000..6adad09fa8 --- /dev/null +++ b/docs2/symbols/Roo.DialogManager.json @@ -0,0 +1,112 @@ +{ + "name" : "Roo.DialogManager", + "augments" : [ + ], + "desc" : "Provides global access to BasicDialogs that have been created and\nsupport for z-indexing (layering) multiple open dialogs.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "bringToFront", + "desc" : "Brings the specified dialog to the front", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DialogManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "dlg", + "type" : "String/Object", + "desc" : "The id of the dialog or a dialog", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "sendToBack", + "desc" : "Sends the specified dialog to the back", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DialogManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "dlg", + "type" : "String/Object", + "desc" : "The id of the dialog or a dialog", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "hideAll", + "desc" : "Hides all dialogs", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DialogManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "get", + "desc" : "Gets a registered dialog by id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DialogManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Object", + "desc" : "The id of the dialog or a dialog", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Document.json b/docs2/symbols/Roo.Document.json new file mode 100644 index 0000000000..c8e38f21fe --- /dev/null +++ b/docs2/symbols/Roo.Document.json @@ -0,0 +1,326 @@ +{ + "name" : "Roo.Document", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "This is a convience class to wrap up the main document loading code.. , rather than adding Roo.onReady(......)", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.DomHelper.json b/docs2/symbols/Roo.DomHelper.json new file mode 100644 index 0000000000..8bd9e32489 --- /dev/null +++ b/docs2/symbols/Roo.DomHelper.json @@ -0,0 +1,331 @@ +{ + "name" : "Roo.DomHelper", + "augments" : [ + ], + "desc" : "Utility class for working with DOM and/or Templates. It transparently supports using HTML fragments or DOM.\nFor more information see this blog post with examples.", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "insertHtml", + "desc" : "Inserts an HTML fragment into the Dom", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomHelper", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "where", + "type" : "String", + "desc" : "Where to insert the html in relation to el - beforeBegin, afterBegin, beforeEnd, afterEnd.", + "isOptional" : false + }, + { + "name" : "el", + "type" : "HTMLElement", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "The HTML fragmenet", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "The new node" + } + ] + }, + { + "name" : "createTemplate", + "desc" : "Creates a new Roo.DomHelper.Template from the Dom object spec", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomHelper", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "The Dom object spec (and children)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.DomHelper.Template", + "desc" : "The new template" + } + ] + }, + { + "name" : "insertAfter", + "desc" : "Creates new Dom element(s) and inserts them after el", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomHelper", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object", + "desc" : "The Dom object spec (and children)", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node" + } + ] + }, + { + "name" : "insertFirst", + "desc" : "Creates new Dom element(s) and inserts them as the first child of el", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomHelper", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object/String", + "desc" : "The Dom object spec (and children) or raw HTML blob", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node" + } + ] + }, + { + "name" : "append", + "desc" : "Creates new Dom element(s) and appends them to el", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomHelper", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object/String", + "desc" : "The Dom object spec (and children) or raw HTML blob", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node" + } + ] + }, + { + "name" : "applyStyles", + "desc" : "Applies a style specification to an element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomHelper", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement", + "desc" : "The element to apply styles to", + "isOptional" : false + }, + { + "name" : "styles", + "type" : "String/Object/Function", + "desc" : "A style specification string eg \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "markup", + "desc" : "Returns the markup for the passed Element(s) config", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomHelper", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "The Dom object spec (and children)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "overwrite", + "desc" : "Creates new Dom element(s) and overwrites the contents of el with them", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomHelper", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object/String", + "desc" : "The Dom object spec (and children) or raw HTML blob", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node" + } + ] + }, + { + "name" : "insertBefore", + "desc" : "Creates new Dom element(s) and inserts them before el", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomHelper", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object/String", + "desc" : "The Dom object spec (and children) or raw HTML blob", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.DomQuery.json b/docs2/symbols/Roo.DomQuery.json new file mode 100644 index 0000000000..0aad497c7e --- /dev/null +++ b/docs2/symbols/Roo.DomQuery.json @@ -0,0 +1,259 @@ +{ + "name" : "Roo.DomQuery", + "augments" : [ + ], + "desc" : "Provides high performance selector/xpath processing by compiling queries into reusable functions. New pseudo classes and matchers can be plugged. It works on HTML and XML documents (if a content node is passed in).\n

\nDomQuery supports most of the CSS3 selectors spec, along with some custom selectors and basic XPath.

\n\n

\nAll selectors, attribute filters and pseudos below can be combined infinitely in any order. For example \"div.foo:nth-child(odd)[@foo=bar].bar:first\" would be a perfectly valid selector. Node filters are processed in the order in which they appear, which allows you to optimize your queries for your document structure.\n

\n

Element Selectors:

\n\n

Attribute Selectors:

\n

The use of @ and quotes are optional. For example, div[@foo='bar'] is also a valid attribute selector.

\n\n

Pseudo Classes:

\n\n

CSS Value Selectors:

\n", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "selectNumber", + "desc" : "Selects the value of a node, parsing integers and floats.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomQuery", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The selector/xpath query", + "isOptional" : false + }, + { + "name" : "root", + "type" : "Node", + "desc" : "(optional) The start of the query (defaults to document).", + "isOptional" : false + }, + { + "name" : "defaultValue", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "is", + "desc" : "Returns true if the passed element(s) match the passed simple selector (e.g. div.some-class or span:first-child)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomQuery", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Array", + "desc" : "An element id, element or array of elements", + "isOptional" : false + }, + { + "name" : "selector", + "type" : "String", + "desc" : "The simple selector to test", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "selectValue", + "desc" : "Selects the value of a node, optionally replacing null with the defaultValue.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomQuery", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The selector/xpath query", + "isOptional" : false + }, + { + "name" : "root", + "type" : "Node", + "desc" : "(optional) The start of the query (defaults to document).", + "isOptional" : false + }, + { + "name" : "defaultValue", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "filter", + "desc" : "Filters an array of elements to only include matches of a simple selector (e.g. div.some-class or span:first-child)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomQuery", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "Array", + "desc" : "An array of elements to filter", + "isOptional" : false + }, + { + "name" : "selector", + "type" : "String", + "desc" : "The simple selector to test", + "isOptional" : false + }, + { + "name" : "nonMatches", + "type" : "Boolean", + "desc" : "If true, it returns the elements that DON'T match\nthe selector instead of the ones that match", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "" + } + ] + }, + { + "name" : "select", + "desc" : "Selects a group of elements.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomQuery", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The selector/xpath query (can be a comma separated list of selectors)", + "isOptional" : false + }, + { + "name" : "root", + "type" : "Node", + "desc" : "(optional) The start of the query (defaults to document).", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "" + } + ] + }, + { + "name" : "selectNode", + "desc" : "Selects a single element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomQuery", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The selector/xpath query", + "isOptional" : false + }, + { + "name" : "root", + "type" : "Node", + "desc" : "(optional) The start of the query (defaults to document).", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "" + } + ] + }, + { + "name" : "compile", + "desc" : "Compiles a selector/xpath query into a reusable function. The returned function\ntakes one parameter \"root\" (optional), which is the context node from where the query should start.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomQuery", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The selector/xpath query", + "isOptional" : false + }, + { + "name" : "type", + "type" : "String", + "desc" : "(optional) Either \"select\" (the default) or \"simple\" for a simple selector match", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Function", + "desc" : "" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.DomTemplate.json b/docs2/symbols/Roo.DomTemplate.json new file mode 100644 index 0000000000..8ff6e95002 --- /dev/null +++ b/docs2/symbols/Roo.DomTemplate.json @@ -0,0 +1,391 @@ +{ + "name" : "Roo.DomTemplate", + "augments" : [ + "Roo.Template" + ], + "desc" : "An effort at a dom based template engine..\n\nSimilar to XTemplate, except it uses dom parsing to create the template..\n\nSupported features:\n\n Tags:\n\n
\n      {a_variable} - output encoded.\n      {a_variable.format:(\"Y-m-d\")} - call a method on the variable\n      {a_variable:raw} - unencoded output\n      {a_variable:toFixed(1,2)} - Roo.util.Format.\"toFixed\"\n      {a_variable:this.method_on_template(...)} - call a method on the template object.\n \n
\n The tpl tag:\n
\n        <div roo-for=\"a_variable or condition..\"></div>\n        <div roo-if=\"a_variable or condition\"></div>\n        <div roo-exec=\"some javascript\"></div>\n        <div roo-name=\"named_template\"></div> \n  \n
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "html", + "type" : "String", + "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")", + "memberOf" : "Roo.Template", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...", + "memberOf" : "Roo.Template", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "applySubTemplate", + "desc" : "same as applyTemplate, except it's done to one of the subTemplates\nwhen using named templates, you can do:\n\nvar str = pl.applySubTemplate('your-name', values);", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomTemplate", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "Number", + "desc" : "of the template", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "to apply to template", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Object", + "desc" : "(normaly the instance of this object)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "compile", + "desc" : "compile the template\n\nThis is not recursive, so I'm not sure how nested templates are really going to be handled..", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomTemplate", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "compileTpl", + "desc" : "Compile a segment of the template into a 'sub-template'", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.DomTemplate", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "insertFirst", + "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "overwrite", + "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "insertBefore", + "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "applyTemplate", + "desc" : "Returns an HTML fragment of this template with the specified values applied.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The HTML fragment" + } + ] + }, + { + "name" : "set", + "desc" : "Sets the HTML used as the template and optionally compiles it.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "compile", + "type" : "Boolean", + "desc" : "(optional) True to compile the template (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Template", + "desc" : "this" + } + ] + }, + { + "name" : "from", + "desc" : "Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement", + "desc" : "A DOM element or its id", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "insertAfter", + "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "append", + "desc" : "Applies the supplied values to the template and appends the new node(s) to el.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "apply", + "desc" : "Alias for {@link #applyTemplate}", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Editor.json b/docs2/symbols/Roo.Editor.json new file mode 100644 index 0000000000..7d875b635c --- /dev/null +++ b/docs2/symbols/Roo.Editor.json @@ -0,0 +1,1197 @@ +{ + "name" : "Roo.Editor", + "augments" : [ + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "A base editor field that handles displaying/hiding on demand and has some built-in sizing and event handling logic.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "hideEl", + "type" : "Boolean", + "desc" : "False to keep the bound element visible while the editor is displayed (defaults to true)", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "alignment", + "type" : "String", + "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"c-c?\").", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "constrain", + "type" : "Boolean", + "desc" : "True to constrain the editor to the viewport", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "\"sides\" for sides/bottom only, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"frame\")", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The data value of the underlying field (defaults to \"\")", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cancelOnEsc", + "type" : "Boolean", + "desc" : "True to cancel the edit when the escape key is pressed (defaults to false)", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "completeOnEnter", + "type" : "Boolean", + "desc" : "True to complete the edit when the enter key is pressed (defaults to false)", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "revertInvalid", + "type" : "Boolean", + "desc" : "True to automatically revert the field value and cancel the edit when the user completes an edit and the field\nvalidation fails (defaults to true)", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "ignoreNoChange", + "type" : "Boolean", + "desc" : "True to skip the the edit completion process (no save, no events fired) if the user completes an edit and\nthe value has not changed (defaults to false). Applies only to string values - edits for other data types\nwill never be ignored.", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "autosize", + "type" : "Boolean/String", + "desc" : "True for the editor to automatically adopt the size of the underlying field, \"width\" to adopt the width only,\nor \"height\" to adopt the height only (defaults to false)", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "updateEl", + "type" : "Boolean", + "desc" : "True to update the innerHTML of the bound element when the update completes (defaults to false)", + "memberOf" : "Roo.Editor", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "cancelEdit", + "desc" : "Cancels the editing process and hides the editor without persisting any changes. The field value will be\nreverted to the original starting value.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "remainVisible", + "type" : "Boolean", + "desc" : "Override the default behavior and keep the editor visible after\ncancel (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the height and width of this editor.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "realign", + "desc" : "Realigns the editor to the bound field based on the current alignment config value.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Gets the data value of the editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "The data value" + } + ] + }, + { + "name" : "completeEdit", + "desc" : "Ends the editing process, persists the changed value to the underlying field, and hides the editor.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "remainVisible", + "type" : "Boolean", + "desc" : "Override the default behavior and keep the editor visible after edit (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setValue", + "desc" : "Sets the data value of the editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "Any valid value supported by the underlying field", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "startEdit", + "desc" : "Starts the editing process and shows the editor.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The element to edit", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String", + "desc" : "(optional) A value to initialize the editor with. If a value is not provided, it defaults\nto the innerHTML of el.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforestartedit", + "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Editor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "boundEl", + "type" : "Roo.Element", + "desc" : "The underlying element bound to this editor", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The field value being set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforecomplete", + "desc" : "Fires after a change has been made to the field, but before the change is reflected in the underlying\nfield. Saving the change to the field can be canceled by returning false from the handler of this event.\nNote that if the value has not changed and ignoreNoChange = true, the editing will still end but this\nevent will not fire since no edit actually occurred.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Editor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The current field value", + "isOptional" : false + }, + { + "name" : "startValue", + "type" : "Mixed", + "desc" : "The original field value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "complete", + "desc" : "Fires after editing is complete and any changed value has been written to the underlying field.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Editor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The current field value", + "isOptional" : false + }, + { + "name" : "startValue", + "type" : "Mixed", + "desc" : "The original field value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "startedit", + "desc" : "Fires when this editor is displayed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "boundEl", + "type" : "Roo.Element", + "desc" : "The underlying element bound to this editor", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The starting field value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Element.json b/docs2/symbols/Roo.Element.json new file mode 100644 index 0000000000..37a2465bb8 --- /dev/null +++ b/docs2/symbols/Roo.Element.json @@ -0,0 +1,4155 @@ +{ + "name" : "Roo.Element", + "augments" : [ + ], + "desc" : "Represents an Element in the DOM.

\nUsage:
\n
\nvar el = Roo.get(\"my-div\");\n\n// or with getEl\nvar el = getEl(\"my-div\");\n\n// or with a DOM element\nvar el = Roo.get(myDivElement);\n
\nUsing Roo.get() or getEl() instead of calling the constructor directly ensures you get the same object\neach call instead of constructing a new one.

\nAnimations
\nMany of the functions for manipulating an element have an optional \"animate\" parameter. The animate parameter\nshould either be a boolean (true) or an object literal with animation options. The animation options are:\n
\nOption    Default   Description\n--------- --------  ---------------------------------------------\nduration  .35       The duration of the animation in seconds\neasing    easeOut   The YUI easing method\ncallback  none      A function to execute when the anim completes\nscope     this      The scope (this) of the callback function\n
\nAlso, the Anim object being used for the animation will be set on your options object as \"anim\", which allows you to stop or\nmanipulate the animation. Here's an example:\n
\nvar el = Roo.get(\"my-div\");\n\n// no animation\nel.setWidth(100);\n\n// default animation\nel.setWidth(100, true);\n\n// animation with some options set\nel.setWidth(100, {\n    duration: 1,\n    callback: this.foo,\n    scope: this\n});\n\n// using the \"anim\" property to get the Anim object\nvar opt = {\n    duration: 1,\n    callback: this.foo,\n    scope: this\n};\nel.setWidth(100, opt);\n...\nif(opt.anim.isAnimated()){\n    opt.anim.stop();\n}\n
\n Composite (Collections of) Elements
\nFor working with collections of Elements, see Roo.CompositeElement", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "getCenterXY", + "desc" : "Calculates the x, y to center this element on the screen", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The x, y values [x, y]" + } + ] + }, + { + "name" : "getScroll", + "desc" : "Returns the current scroll position of the element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the scroll position in the format {left: (scrollLeft), top: (scrollTop)}" + } + ] + }, + { + "name" : "createShim", + "desc" : "Creates an iframe shim for this element to keep selects and other windowed objects from\nshowing through.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The new shim element" + } + ] + }, + { + "name" : "scrollTo", + "desc" : "Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it will try to do it. For auto bounds checking, use scroll().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "side", + "type" : "String", + "desc" : "Either \"left\" for scrollLeft values or \"top\" for scrollTop values.", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Number", + "desc" : "The new scroll value", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "this" + } + ] + }, + { + "name" : "removeAllListeners", + "desc" : "Removes all previous added listeners from this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setStyle", + "desc" : "Wrapper for setting style properties, also takes single object parameter of multiple styles.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "property", + "type" : "String/Object", + "desc" : "The style property to be set, or an object of multiple styles.", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String", + "desc" : "(optional) The value to apply to the given property, or null if an object was passed.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler (Shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to append", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) of the fn", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)An object with standard {@link Roo.EventManager#addListener} options", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addClassOnClick", + "desc" : "Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "className", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getBorderWidth", + "desc" : "Gets the width of the border(s) for the specified side(s)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "side", + "type" : "String", + "desc" : "Can be t, l, r, b or any combination of those to add multiple values. For example,\npassing lr would get the border (l)eft width + the border (r)ight width.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The width of the sides passed added together" + } + ] + }, + { + "name" : "scroll", + "desc" : "Scrolls this element the specified direction. Does bounds checking to make sure the scroll is\nwithin this element's scrollable range.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "direction", + "type" : "String", + "desc" : "Possible values are: \"l\",\"left\" - \"r\",\"right\" - \"t\",\"top\",\"up\" - \"b\",\"bottom\",\"down\".", + "isOptional" : false + }, + { + "name" : "distance", + "type" : "Number", + "desc" : "How far to scroll the element in pixels", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "Returns true if a scroll was triggered or false if the element\nwas scrolled as far as it could go." + } + ] + }, + { + "name" : "addKeyMap", + "desc" : "Creates a KeyMap for this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "The KeyMap config. See {@link Roo.KeyMap} for more details", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.KeyMap", + "desc" : "The KeyMap created" + } + ] + }, + { + "name" : "createChild", + "desc" : "Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be\nautomatically generated with the specified attributes.", + "isOptional" : false + }, + { + "name" : "insertBefore", + "type" : "HTMLElement", + "desc" : "(optional) a child element of this element", + "isOptional" : false + }, + { + "name" : "returnDom", + "type" : "Boolean", + "desc" : "(optional) true to return the dom node instead of creating an Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The new child element" + } + ] + }, + { + "name" : "addClass", + "desc" : "Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "className", + "type" : "String/Array", + "desc" : "The CSS class to add, or an array of classes", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "attr", + "desc" : "Sets or Returns the value the dom attribute value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "name", + "type" : "String|Object", + "desc" : "The attribute name (or object to set multiple attributes)", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String", + "desc" : "(optional) The value to set the attribute to", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The attribute value" + } + ] + }, + { + "name" : "setOpacity", + "desc" : "Set the opacity of the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "opacity", + "type" : "Float", + "desc" : "The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setSize", + "desc" : "Set the size of the element. If animation is true, both width an height will be animated concurrently.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "un", + "desc" : "Removes an event handler from this element (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "the type of event to remove", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "the method the event invokes", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "up", + "desc" : "Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child).\nThis is a shortcut for findParentNode() that always returns an Roo.Element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The simple selector to test", + "isOptional" : false + }, + { + "name" : "maxDepth", + "type" : "Number/String/HTMLElement/Element", + "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The matching DOM node (or null if no match was found)" + } + ] + }, + { + "name" : "repaint", + "desc" : "Forces the browser to repaint this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "translatePoints", + "desc" : "Translates the passed page coordinates into left/top css values for this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number/Array", + "desc" : "The page x or an array containing [x, y]", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The page y", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object with left and top properties. e.g. {left: (value), top: (value)}" + } + ] + }, + { + "name" : "createProxy", + "desc" : "Creates a proxy element of this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "String/Object", + "desc" : "The class name of the proxy element or a DomHelper config object", + "isOptional" : false + }, + { + "name" : "renderTo", + "type" : "String/HTMLElement", + "desc" : "(optional) The element or element id to render the proxy to (defaults to document.body)", + "isOptional" : false + }, + { + "name" : "matchBox", + "type" : "Boolean", + "desc" : "(optional) True to align and size the proxy to this element now (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The new proxy element" + } + ] + }, + { + "name" : "down", + "desc" : "Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The CSS selector", + "isOptional" : false + }, + { + "name" : "returnDom", + "type" : "Boolean", + "desc" : "(optional) True to return the DOM node instead of Roo.Element (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The child Roo.Element (or DOM node if returnDom = true)" + } + ] + }, + { + "name" : "getBox", + "desc" : "Return a box {x, y, width, height} that can be used to set another elements\nsize/location to match this element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "contentBox", + "type" : "Boolean", + "desc" : "(optional) If true a box for the content of the element is returned.", + "isOptional" : false + }, + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page x/y.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "box An object in the format {x, y, width, height}" + } + ] + }, + { + "name" : "toggle", + "desc" : "Toggles the element's visibility or display, depending on visibility mode.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) True for the default animation, or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setBounds", + "desc" : "Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "X value for new position (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "Y value for new position (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getX", + "desc" : "Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The X position of the element" + } + ] + }, + { + "name" : "getY", + "desc" : "Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The Y position of the element" + } + ] + }, + { + "name" : "focus", + "desc" : "Tries to focus the element. Any exceptions are caught and ignored.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "get", + "desc" : "Static method to retrieve Element objects. Uses simple caching to consistently return the same object.\nAutomatically fixes if an object was recreated with the same id via AJAX or DOM.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM Node or an existing Element.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The Element object" + } + ] + }, + { + "name" : "autoHeight", + "desc" : "Measures the element's content height and updates height to match. Note: this function uses setTimeout so\nthe new height may not be available immediately.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "animate", + "type" : "Boolean", + "desc" : "(optional) Animate the transition (defaults to false)", + "isOptional" : false + }, + { + "name" : "duration", + "type" : "Float", + "desc" : "(optional) Length of the animation in seconds (defaults to .35)", + "isOptional" : false + }, + { + "name" : "onComplete", + "type" : "Function", + "desc" : "(optional) Function to call when animation completes", + "isOptional" : false + }, + { + "name" : "easing", + "type" : "String", + "desc" : "(optional) Easing method to use (defaults to easeOut)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "scrollIntoView", + "desc" : "Scrolls this element into view within the passed container.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The container element to scroll (defaults to document.body)", + "isOptional" : false + }, + { + "name" : "hscroll", + "type" : "Boolean", + "desc" : "(optional) False to disable horizontal scroll (defaults to true)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getAlignToXY", + "desc" : "Gets the x,y coordinates to align this element with another element. See {@link #alignTo} for more info on the\nsupported position values.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to.", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "The position to align to.", + "isOptional" : false + }, + { + "name" : "offsets", + "type" : "Array", + "desc" : "(optional) Offset the positioning by [x, y]", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "[x, y]" + } + ] + }, + { + "name" : "clearOpacity", + "desc" : "Clears any opacity settings from this element. Required in some cases for IE.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setPositioning", + "desc" : "Set positioning with an object returned by getPositioning().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "posCfg", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getMargins", + "desc" : "Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed,\nthen it returns the calculated width of the sides (see getPadding)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sides", + "type" : "String", + "desc" : "(optional) Any combination of l, r, t, b to get the sum of those sides", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object/Number", + "desc" : "" + } + ] + }, + { + "name" : "setRegion", + "desc" : "Sets the element's position and size the the specified region. If animation is true then width, height, x and y will be animated concurrently.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.lib.Region", + "desc" : "The region to fill", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getAttributeNS", + "desc" : "Returns the value of a namespaced attribute from the element's underlying DOM node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "namespace", + "type" : "String", + "desc" : "The namespace in which to look for the attribute", + "isOptional" : false + }, + { + "name" : "name", + "type" : "String", + "desc" : "The attribute name", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The attribute value" + } + ] + }, + { + "name" : "setLeft", + "desc" : "Sets the element's left position directly using CSS style (instead of {@link #setX}).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "String", + "desc" : "The left CSS property value", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "load", + "desc" : "Direct access to the UpdateManager update() method (takes the same parameters).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "String/Function", + "desc" : "The url for this request or a function to call to get the url", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The parameters to pass as either a url encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)", + "isOptional" : false + }, + { + "name" : "discardUrl", + "type" : "Boolean", + "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "replaceClass", + "desc" : "Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "oldClassName", + "type" : "String", + "desc" : "The CSS class to replace", + "isOptional" : false + }, + { + "name" : "newClassName", + "type" : "String", + "desc" : "The replacement CSS class", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "initDDTarget", + "desc" : "Initializes a {@link Roo.dd.DDTarget} object for this element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "group", + "type" : "String", + "desc" : "The group the DDTarget object is member of", + "isOptional" : false + }, + { + "name" : "config", + "type" : "Object", + "desc" : "The DDTarget config object", + "isOptional" : false + }, + { + "name" : "overrides", + "type" : "Object", + "desc" : "An object containing methods to override/implement on the DDTarget object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.dd.DDTarget", + "desc" : "The DDTarget object" + } + ] + }, + { + "name" : "setHeight", + "desc" : "Set the height of the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "height", + "type" : "Number", + "desc" : "The new height", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "clean", + "desc" : "Removes worthless text nodes", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "forceReclean", + "type" : "Boolean", + "desc" : "(optional) By default the element\nkeeps track if it has been cleaned already so\nyou can call this over and over. However, if you update the element and\nneed to force a reclean, you can pass true.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getPositioning", + "desc" : "Gets an object with all CSS positioning properties. Useful along with setPostioning to get\nsnapshot before performing an update and then restoring the element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] + }, + { + "name" : "update", + "desc" : "Update the innerHTML of this element, optionally searching for and processing scripts", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "html", + "type" : "String", + "desc" : "The new HTML", + "isOptional" : false + }, + { + "name" : "loadScripts", + "type" : "Boolean", + "desc" : "(optional) true to look for and process scripts", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "For async script loading you can be noticed when the update completes", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "contains", + "desc" : "Returns true if this element is an ancestor of the passed element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "HTMLElement/String", + "desc" : "The element to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if this element is an ancestor of el, else false" + } + ] + }, + { + "name" : "appendChild", + "desc" : "Appends the passed element(s) to this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Array/Element/CompositeElement", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getValue", + "desc" : "Returns the value of the \"value\" attribute", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "asNumber", + "type" : "Boolean", + "desc" : "true to parse the value as a number", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String/Number", + "desc" : "" + } + ] + }, + { + "name" : "getRegion", + "desc" : "Returns the region of the given element.\nThe element must be part of the DOM tree to have a region (display:none or elements not appended return false).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Region", + "desc" : "A Roo.lib.Region containing \"top, left, bottom, right\" member data." + } + ] + }, + { + "name" : "anchorTo", + "desc" : "Anchors an element to another element and realigns it when the window is resized.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to.", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "The position to align to.", + "isOptional" : false + }, + { + "name" : "offsets", + "type" : "Array", + "desc" : "(optional) Offset the positioning by [x, y]", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) True for the default animation or a standard Element animation config object", + "isOptional" : false + }, + { + "name" : "monitorScroll", + "type" : "Boolean/Number", + "desc" : "(optional) True to monitor body scroll and reposition. If this parameter\nis a number, it is used as the buffer delay (defaults to 50ms).", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "The function to call after the animation finishes", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "removeClass", + "desc" : "Removes one or more CSS classes from the element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "className", + "type" : "String/Array", + "desc" : "The CSS class to remove, or an array of classes", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "radioClass", + "desc" : "Adds one or more CSS classes to this element and removes the same class(es) from all siblings.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "className", + "type" : "String/Array", + "desc" : "The CSS class to add, or an array of classes", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getWidth", + "desc" : "Returns the offset width of the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "contentWidth", + "type" : "Boolean", + "desc" : "(optional) true to get the width minus borders and padding", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The element's width" + } + ] + }, + { + "name" : "insertBefore", + "desc" : "Inserts this element before the passed element in the DOM", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The element to insert before", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getHeight", + "desc" : "Returns the offset height of the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "contentHeight", + "type" : "Boolean", + "desc" : "(optional) true to get the height minus borders and padding", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The element's height" + } + ] + }, + { + "name" : "setTop", + "desc" : "Sets the element's top position directly using CSS style (instead of {@link #setY}).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "top", + "type" : "String", + "desc" : "The top CSS property value", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "toggleClass", + "desc" : "Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "className", + "type" : "String", + "desc" : "The CSS class to toggle", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "wrap", + "desc" : "Creates and wraps this element with another element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "(optional) DomHelper element config object for the wrapper element or null for an empty div", + "isOptional" : false + }, + { + "name" : "returnDom", + "type" : "Boolean", + "desc" : "(optional) True to return the raw DOM element instead of Roo.Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Element", + "desc" : "The newly created wrapper element" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use\nthe display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "Whether the element is visible", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) True for the default animation, or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to append", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) of the fn", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)An object with standard {@link Roo.EventManager#addListener} options", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setWidth", + "desc" : "Set the width of the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "center", + "desc" : "Centers the Element in either the viewport, or another Element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "centerIn", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "(optional) The element in which to center the element.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Checks whether the element is currently visible using both visibility and display properties.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to walk the dom and see if parent elements are hidden (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the element is currently visible, else false" + } + ] + }, + { + "name" : "findParent", + "desc" : "Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The simple selector to test", + "isOptional" : false + }, + { + "name" : "maxDepth", + "type" : "Number/String/HTMLElement/Element", + "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)", + "isOptional" : false + }, + { + "name" : "returnEl", + "type" : "Boolean", + "desc" : "(optional) True to return a Roo.Element object instead of DOM node", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "The matching DOM node (or null if no match was found)" + } + ] + }, + { + "name" : "addKeyListener", + "desc" : "Convenience method for constructing a KeyMap", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "key", + "type" : "Number/Array/Object/String", + "desc" : "Either a string with the keys to listen for, the numeric key code, array of key codes or an object with the following options:\n {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.KeyMap", + "desc" : "The KeyMap created" + } + ] + }, + { + "name" : "swallowEvent", + "desc" : "Stops the specified event from bubbling and optionally prevents the default action", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : "(optional) true to prevent the default action too", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getStyles", + "desc" : "Returns an object with properties matching the styles requested.\nFor example, el.getStyles('color', 'font-size', 'width') might return\n{'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "style1", + "type" : "String", + "desc" : "A style name", + "isOptional" : false + }, + { + "name" : "style2", + "type" : "String", + "desc" : "A style name", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The style object" + } + ] + }, + { + "name" : "getSize", + "desc" : "Returns the size of the element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "contentSize", + "type" : "Boolean", + "desc" : "(optional) true to get the width/size minus borders and padding", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "endMeasure", + "desc" : "Restores displays to before beginMeasure was called", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getViewSize", + "desc" : "Returns the width and height of the viewport.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the viewport's size {width: (viewport width), height: (viewport height)}" + } + ] + }, + { + "name" : "addClassOnFocus", + "desc" : "Sets up event handlers to add and remove a css class when this element has the focus", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "className", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "alignTo", + "desc" : "Aligns this element with another element relative to the specified anchor points. If the other element is the\ndocument it aligns it to the viewport.\nThe position parameter is optional, and can be specified in any one of the following formats:\n\nIn addition to the anchor points, the position parameter also supports the \"?\" character. If \"?\" is passed at the end of\nthe position string, the element will attempt to align as specified, but the position will be adjusted to constrain to\nthe viewport if necessary. Note that the element being aligned might be swapped to align to a different position than\nthat specified in order to enforce the viewport constraints.\nFollowing are all of the supported anchor positions:\n
\n    Value  Description\n    -----  -----------------------------\n    tl     The top left corner (default)\n    t      The center of the top edge\n    tr     The top right corner\n    l      The center of the left edge\n    c      In the center of the element\n    r      The center of the right edge\n    bl     The bottom left corner\n    b      The center of the bottom edge\n    br     The bottom right corner\n    
\n Example Usage:\n
\n    // align el to other-el using the default positioning (\"tl-bl\", non-constrained)\n    el.alignTo(\"other-el\");\n\n    // align the top left corner of el with the top right corner of other-el (constrained to viewport)\n    el.alignTo(\"other-el\", \"tr?\");\n\n    // align the bottom right corner of el with the center left edge of other-el\n    el.alignTo(\"other-el\", \"br-l?\");\n\n    // align the center of el with the bottom left corner of other-el and\n    // adjust the x position by -6 pixels (and the y position by 0)\n    el.alignTo(\"other-el\", \"c-bl\", [-6, 0]);\n    
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to.", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "The position to align to.", + "isOptional" : false + }, + { + "name" : "offsets", + "type" : "Array", + "desc" : "(optional) Offset the positioning by [x, y]", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "insertAfter", + "desc" : "Inserts this element after the passed element in the DOM", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The element to insert after", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setBottom", + "desc" : "Sets the element's CSS bottom style.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "bottom", + "type" : "String", + "desc" : "The bottom CSS property value", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "clearPositioning", + "desc" : "Clear positioning back to the default when the document was loaded", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "(optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "isDisplayed", + "desc" : "Returns true if display is not \"none\"", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "show", + "desc" : "Show this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setLeftTop", + "desc" : "Quick set left and top adding default units", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "String", + "desc" : "The left CSS property value", + "isOptional" : false + }, + { + "name" : "top", + "type" : "String", + "desc" : "The top CSS property value", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "child", + "desc" : "Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The CSS selector", + "isOptional" : false + }, + { + "name" : "returnDom", + "type" : "Boolean", + "desc" : "(optional) True to return the DOM node instead of Roo.Element (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The child Roo.Element (or DOM node if returnDom = true)" + } + ] + }, + { + "name" : "unmask", + "desc" : "Removes a previously applied mask. If removeEl is true the mask overlay is destroyed, otherwise\nit is cached for reuse.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "moveTo", + "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "X value for new position (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "Y value for new position (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) True for the default animation, or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "addClassOnOver", + "desc" : "Sets up event handlers to add and remove a css class when the mouse is over this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "className", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "preventFlicker", + "type" : "Boolean", + "desc" : "(optional) If set to true, it prevents flickering by filtering\nmouseout events for children elements", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getLeft", + "desc" : "Gets the left X coordinate", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "True to get the local css position instead of page coordinate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "isScrollable", + "desc" : "Returns true if this element is scrollable.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "boxWrap", + "desc" : "Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a\ngradient background, rounded corners and a 4-way shadow.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "class", + "type" : "String", + "desc" : "(optional) A base CSS class to apply to the containing wrapper element (defaults to 'x-box').\nNote that there are a number of CSS rules that are dependent on this name to make the overall effect work,\nso if you supply an alternate base class, make sure you also supply all of the necessary rules.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "replace", + "desc" : "Replaces the passed element with this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The element to replace", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "select", + "desc" : "Creates a {@link Roo.CompositeElement} for child nodes based on the passed CSS selector (the selector should not contain an id).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The CSS selector", + "isOptional" : false + }, + { + "name" : "unique", + "type" : "Boolean", + "desc" : "(optional) True to create a unique Roo.Element for each child (defaults to false, which creates a single shared flyweight object)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "CompositeElement/CompositeElementLite", + "desc" : "The composite element" + } + ] + }, + { + "name" : "isMasked", + "desc" : "Returns true if this element is masked", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getUpdateManager", + "desc" : "Gets this element's UpdateManager", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "insertHtml", + "desc" : "Inserts an html fragment into this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "where", + "type" : "String", + "desc" : "Where to insert the html in relation to the this element - beforeBegin, afterBegin, beforeEnd, afterEnd.", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "The HTML fragment", + "isOptional" : false + }, + { + "name" : "returnEl", + "type" : "Boolean", + "desc" : "True to return an Roo.Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The inserted node (or nearest related if more than 1 inserted)" + } + ] + }, + { + "name" : "mask", + "desc" : "Puts a mask over this element to disable user interaction. Requires core.css.\nThis method can only be applied to elements which accept child nodes.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "(optional) A message to display in the mask", + "isOptional" : false + }, + { + "name" : "msgCls", + "type" : "String", + "desc" : "(optional) A css class to apply to the msg element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The mask element" + } + ] + }, + { + "name" : "getTop", + "desc" : "Gets the top Y coordinate", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "True to get the local css position instead of page coordinate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "getBottom", + "desc" : "Gets the bottom Y coordinate of the element (element Y position + element height)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "True to get the local css position instead of page coordinate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "getRight", + "desc" : "Gets the right X coordinate of the element (element X position + element width)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "True to get the local css position instead of page coordinate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "beginMeasure", + "desc" : "Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "appendTo", + "desc" : "Appends this element to the passed element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The new parent element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "fly", + "desc" : "Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -\nthe dom node can be overwritten by other code.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement", + "desc" : "The dom node or id", + "isOptional" : false + }, + { + "name" : "named", + "type" : "String", + "desc" : "(optional) Allows for creation of named reusable flyweights to\n prevent conflicts (e.g. internally Roo uses \"_internal\")", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The shared Element object" + } + ] + }, + { + "name" : "hasClass", + "desc" : "Checks if the specified CSS class exists on this element's DOM node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "className", + "type" : "String", + "desc" : "The CSS class to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the class exists, else false" + } + ] + }, + { + "name" : "findScrollableParent", + "desc" : "Looks at the scrollable parent element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "fitToParent", + "desc" : "Sizes this element to its parent element's dimensions performing\nneccessary box adjustments.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "monitorResize", + "type" : "Boolean", + "desc" : "(optional) If true maintains the fit when the browser window is resized.", + "isOptional" : false + }, + { + "name" : "targetParent", + "type" : "String/HTMLElment/Element", + "desc" : "(optional) The target parent, default to the parentNode.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setXY", + "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "pos", + "type" : "Array", + "desc" : "Contains X & Y [x, y] values for new position (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) True for the default animation, or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getXY", + "desc" : "Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element" + } + ] + }, + { + "name" : "unselectable", + "desc" : "Disables text selection for this element (normalized across browsers)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "blur", + "desc" : "Tries to blur the element. Any exceptions are caught and ignored.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setRight", + "desc" : "Sets the element's CSS right style.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "right", + "type" : "String", + "desc" : "The right CSS property value", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "findParentNode", + "desc" : "Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The simple selector to test", + "isOptional" : false + }, + { + "name" : "maxDepth", + "type" : "Number/String/HTMLElement/Element", + "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)", + "isOptional" : false + }, + { + "name" : "returnEl", + "type" : "Boolean", + "desc" : "(optional) True to return a Roo.Element object instead of DOM node", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "The matching DOM node (or null if no match was found)" + } + ] + }, + { + "name" : "position", + "desc" : "Initializes positioning on this element. If a desired position is not passed, it will make the\nthe element positioned relative IF it is not already positioned.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "pos", + "type" : "String", + "desc" : "(optional) Positioning to use \"relative\", \"absolute\" or \"fixed\"", + "isOptional" : false + }, + { + "name" : "zIndex", + "type" : "Number", + "desc" : "(optional) The zIndex to apply", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "(optional) Set the page X position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "(optional) Set the page Y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getFrameWidth", + "desc" : "Returns the sum width of the padding and borders for the passed \"sides\". See getBorderWidth()\n for more information about the sides.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sides", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "setLocation", + "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "X value for new position (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "Y value for new position (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) True for the default animation, or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "unclip", + "desc" : "Return clipping (overflow) to original clipping before clip() was called", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "set", + "desc" : "Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "The object with the attributes", + "isOptional" : false + }, + { + "name" : "useSet", + "type" : "Boolean", + "desc" : "(optional) false to override the default setAttribute to use expandos.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setDisplayed", + "desc" : "Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean", + "desc" : "Boolean value to display the element using its default display, or a string to set the display directly", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "insertFirst", + "desc" : "Inserts (or creates) an element (or DomHelper config) as the first child of the this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element/Object", + "desc" : "The id or element to insert or a DomHelper config to create and insert", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The new child" + } + ] + }, + { + "name" : "animate", + "desc" : "Perform animation on this element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "args", + "type" : "Object", + "desc" : "The YUI animation control args", + "isOptional" : false + }, + { + "name" : "duration", + "type" : "Float", + "desc" : "(optional) How long the animation lasts in seconds (defaults to .35)", + "isOptional" : false + }, + { + "name" : "onComplete", + "type" : "Function", + "desc" : "(optional) Function to call when animation completes", + "isOptional" : false + }, + { + "name" : "easing", + "type" : "String", + "desc" : "(optional) Easing method to use (defaults to 'easeOut')", + "isOptional" : false + }, + { + "name" : "animType", + "type" : "String", + "desc" : "(optional) 'run' is the default. Can also be 'color', 'motion', or 'scroll'", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "enableDisplayMode", + "desc" : "Convenience method for setVisibilityMode(Element.DISPLAY)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "display", + "type" : "String", + "desc" : "(optional) What to set display to when visible", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getComputedWidth", + "desc" : "Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders\nwhen needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements\nif a width has not been set using CSS.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "clip", + "desc" : "Store the current overflow setting and clip overflow on the element - use {@link #unclip} to remove", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setVisibilityMode", + "desc" : "Sets the element's visibility mode. When setVisible() is called it\nwill use this to determine whether to set the visibility or the display property.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visMode", + "type" : "", + "desc" : "Element.VISIBILITY or Element.DISPLAY", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getColor", + "desc" : "Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values\nare convert to standard 6 digit hex color.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "attr", + "type" : "String", + "desc" : "The css attribute", + "isOptional" : false + }, + { + "name" : "defaultValue", + "type" : "String", + "desc" : "The default value to use when a valid color isn't found", + "isOptional" : false + }, + { + "name" : "prefix", + "type" : "String", + "desc" : "(optional) defaults to #. Use an empty string when working with\nYUI color anims.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "insertSibling", + "desc" : "Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element/Object", + "desc" : "The id or element to insert or a DomHelper config to create and insert", + "isOptional" : false + }, + { + "name" : "where", + "type" : "String", + "desc" : "(optional) 'before' or 'after' defaults to before", + "isOptional" : false + }, + { + "name" : "returnDom", + "type" : "Boolean", + "desc" : "(optional) True to return the raw DOM element instead of Roo.Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "the inserted Element" + } + ] + }, + { + "name" : "removeListener", + "desc" : "Removes an event handler from this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "the type of event to remove", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "the method the event invokes", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "applyStyles", + "desc" : "More flexible version of {@link #setStyle} for setting style properties.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "styles", + "type" : "String/Object/Function", + "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getPrevSibling", + "desc" : "Gets the previous sibling, skipping text nodes", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "The previous sibling or null" + } + ] + }, + { + "name" : "setBox", + "desc" : "Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x and y will be animated concurrently.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "The box to fill {x, y, width, height}", + "isOptional" : false + }, + { + "name" : "adjust", + "type" : "Boolean", + "desc" : "(optional) Whether to adjust for box-model issues automatically", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "initDDProxy", + "desc" : "Initializes a {@link Roo.dd.DDProxy} object for this element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "group", + "type" : "String", + "desc" : "The group the DDProxy object is member of", + "isOptional" : false + }, + { + "name" : "config", + "type" : "Object", + "desc" : "The DDProxy config object", + "isOptional" : false + }, + { + "name" : "overrides", + "type" : "Object", + "desc" : "An object containing methods to override/implement on the DDProxy object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.dd.DDProxy", + "desc" : "The DDProxy object" + } + ] + }, + { + "name" : "setX", + "desc" : "Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "The", + "type" : "Number", + "desc" : "X position of the element", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) True for the default animation, or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setY", + "desc" : "Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "The", + "type" : "Number", + "desc" : "Y position of the element", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) True for the default animation, or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "query", + "desc" : "Selects child nodes based on the passed CSS selector (the selector should not contain an id).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The CSS selector", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "An array of the matched nodes" + } + ] + }, + { + "name" : "getAnchorXY", + "desc" : "Gets the x,y coordinates specified by the anchor position on the element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "anchor", + "type" : "String", + "desc" : "(optional) The specified anchor position (defaults to \"c\"). See {@link #alignTo} for details on supported anchor positions.", + "isOptional" : false + }, + { + "name" : "size", + "type" : "Object", + "desc" : "(optional) An object containing the size to use for calculating anchor position\n {width: (target width), height: (target height)} (defaults to the element's current size)", + "isOptional" : false + }, + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) True to get the local (element top/left-relative) anchor position instead of page coordinates", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "[x, y] An array containing the element's x and y coordinates" + } + ] + }, + { + "name" : "initDD", + "desc" : "Initializes a {@link Roo.dd.DD} drag drop object for this element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "group", + "type" : "String", + "desc" : "The group the DD object is member of", + "isOptional" : false + }, + { + "name" : "config", + "type" : "Object", + "desc" : "The DD config object", + "isOptional" : false + }, + { + "name" : "overrides", + "type" : "Object", + "desc" : "An object containing methods to override/implement on the DD object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.dd.DD", + "desc" : "The DD object" + } + ] + }, + { + "name" : "getComputedHeight", + "desc" : "Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders\nwhen needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements\nif a height has not been set using CSS.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "is", + "desc" : "Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The simple selector to test", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if this element matches the selector, else false" + } + ] + }, + { + "name" : "move", + "desc" : "Move this element relative to its current position.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "direction", + "type" : "String", + "desc" : "Possible values are: \"l\",\"left\" - \"r\",\"right\" - \"t\",\"top\",\"up\" - \"b\",\"bottom\",\"down\".", + "isOptional" : false + }, + { + "name" : "distance", + "type" : "Number", + "desc" : "How far to move the element in pixels", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "remove", + "desc" : "Removes this element from the DOM and deletes it from the cache", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getNextSibling", + "desc" : "Gets the next sibling, skipping text nodes", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "The next sibling or null" + } + ] + }, + { + "name" : "getStyle", + "desc" : "Normalizes currentStyle and computedStyle. This is not YUI getStyle, it is an optimised version.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "property", + "type" : "String", + "desc" : "The style property whose value is returned.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The current value of the style property for this element." + } + ] + }, + { + "name" : "isBorderBox", + "desc" : "Tests various css rules/browsers to determine if this element uses a border box", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getPadding", + "desc" : "Gets the width of the padding(s) for the specified side(s)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "side", + "type" : "String", + "desc" : "Can be t, l, r, b or any combination of those to add multiple values. For example,\npassing lr would get the padding (l)eft + the padding (r)ight.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The padding of the sides passed added together" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.EventManager.json b/docs2/symbols/Roo.EventManager.json new file mode 100644 index 0000000000..f53655af40 --- /dev/null +++ b/docs2/symbols/Roo.EventManager.json @@ -0,0 +1,315 @@ +{ + "name" : "Roo.EventManager", + "augments" : [ + ], + "desc" : "Registers event handlers that want to receive a normalized EventObject instead of the standard browser event and provides \nseveral useful events directly.\nSee {@link Roo.EventObject} for more details on normalized event objects.", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "addListener", + "desc" : "Appends an event handler to an element (shorthand for addListener)", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement", + "desc" : "The html element or id to assign the", + "isOptional" : false + }, + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)

\nCode:
\nel.on('click', this.onClick, this, {\n    single: true,\n    delay: 100,\n    stopEvent : true,\n    forumId: 4\n});
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\nCode:

\nel.on({\n    'click' : {\n        fn: this.onClick\n        scope: this,\n        delay: 100\n    },\n    'mouseover' : {\n        fn: this.onMouseOver\n        scope: this\n    },\n    'mouseout' : {\n        fn: this.onMouseOut\n        scope: this\n    }\n});
\n

\nOr a shorthand syntax:
\nCode:

\nel.on({\n    'click' : this.onClick,\n    'mouseover' : this.onMouseOver,\n    'mouseout' : this.onMouseOut\n    scope: this\n});
", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDocumentReady", + "desc" : "Fires when the document is ready (before onload and before images are loaded). Can be \naccessed shorthanded Roo.onReady().", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "An object that becomes the scope of the handler", + "isOptional" : false + }, + { + "name" : "options", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onTextResize", + "desc" : "Fires when the user changes the active text size. Handler gets called with 2 params, the old size and the new size.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "An object that becomes the scope of the handler", + "isOptional" : false + }, + { + "name" : "options", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to an element (shorthand for addListener)", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement", + "desc" : "The html element or id to assign the", + "isOptional" : false + }, + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)

\nCode:
\nel.on('click', this.onClick, this, {\n    single: true,\n    delay: 100,\n    stopEvent : true,\n    forumId: 4\n});
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\nCode:

\nel.on({\n    'click' : {\n        fn: this.onClick\n        scope: this,\n        delay: 100\n    },\n    'mouseover' : {\n        fn: this.onMouseOver\n        scope: this\n    },\n    'mouseout' : {\n        fn: this.onMouseOut\n        scope: this\n    }\n});
\n

\nOr a shorthand syntax:
\nCode:

\nel.on({\n    'click' : this.onClick,\n    'mouseover' : this.onMouseOver,\n    'mouseout' : this.onMouseOut\n    scope: this\n});
", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeResizeListener", + "desc" : "Removes the passed window resize listener.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "The scope of handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onWindowResize", + "desc" : "Fires when the window is resized and provides resize event buffering (50 milliseconds), passes new viewport width and height to handlers.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "An object that becomes the scope of the handler", + "isOptional" : false + }, + { + "name" : "options", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "wrap", + "desc" : "This is no longer needed and is deprecated. Places a simple wrapper around an event handler to override the browser event\nobject with a Roo.EventObject", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventManager", + "example" : "", + "deprecated" : "This has been deprecated: ", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "An object that becomes the scope of the handler", + "isOptional" : false + }, + { + "name" : "override", + "type" : "boolean", + "desc" : "If true, the obj passed in becomes\n the execution scope of the listener", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Function", + "desc" : "The wrapped function" + } + ] + }, + { + "name" : "removeListener", + "desc" : "Removes an event handler", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement", + "desc" : "The id or html element to remove the \n event from", + "isOptional" : false + }, + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if a listener was actually removed" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.EventObject.json b/docs2/symbols/Roo.EventObject.json new file mode 100644 index 0000000000..88069e4f1d --- /dev/null +++ b/docs2/symbols/Roo.EventObject.json @@ -0,0 +1,324 @@ +{ + "name" : "Roo.EventObject", + "augments" : [ + ], + "desc" : "EventObject exposes the Yahoo! UI Event functionality directly on the object\npassed to your event handler. It exists mostly for convenience. It also fixes the annoying null checks automatically to cleanup your code \nExample:\n
\n function handleClick(e){ // e is not a standard event object, it is a Roo.EventObject\n    e.preventDefault();\n    var target = e.getTarget();\n    ...\n }\n var myDiv = Roo.get(\"myDiv\");\n myDiv.on(\"click\", handleClick);\n //or\n Roo.EventManager.on(\"myDiv\", 'click', handleClick);\n Roo.EventManager.addListener(\"myDiv\", 'click', handleClick);\n 
", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "getPageX", + "desc" : "Gets the x coordinate of the event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventObject", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "getPageY", + "desc" : "Gets the y coordinate of the event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventObject", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "getTime", + "desc" : "Gets the time of the event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventObject", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "getXY", + "desc" : "Gets the page coordinates of the event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventObject", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The xy values like [x, y]" + } + ] + }, + { + "name" : "getRelatedTarget", + "desc" : "Gets the related target.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventObject", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "" + } + ] + }, + { + "name" : "getWheelDelta", + "desc" : "Normalizes mouse wheel delta across browsers", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventObject", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The delta" + } + ] + }, + { + "name" : "stopPropagation", + "desc" : "Cancels bubbling of the event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventObject", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "stopEvent", + "desc" : "Stop the event (preventDefault and stopPropagation)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventObject", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "within", + "desc" : "Returns true if the target of this event equals el or is a child of el", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventObject", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "related", + "type" : "Boolean", + "desc" : "(optional) true to test if the related target is within el instead of the target", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "hasModifier", + "desc" : "Returns true if the control, meta, shift or alt key was pressed during this event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventObject", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getTarget", + "desc" : "Gets the target for the event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventObject", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "(optional) A simple selector to filter the target or look for an ancestor of the target", + "isOptional" : false + }, + { + "name" : "maxDepth", + "type" : "Number/String/HTMLElement/Element", + "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)", + "isOptional" : false + }, + { + "name" : "returnEl", + "type" : "Boolean", + "desc" : "(optional) True to return a Roo.Element object instead of DOM node", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLelement", + "desc" : "" + } + ] + }, + { + "name" : "preventDefault", + "desc" : "Prevents the browsers default handling of the event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventObject", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getCharCode", + "desc" : "Gets the key code for the event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventObject", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "getKey", + "desc" : "Returns a normalized keyCode for the event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.EventObject", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The key code" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Fx.json b/docs2/symbols/Roo.Fx.json new file mode 100644 index 0000000000..b6a414e65c --- /dev/null +++ b/docs2/symbols/Roo.Fx.json @@ -0,0 +1,580 @@ +{ + "name" : "Roo.Fx", + "augments" : [ + ], + "desc" : "

A class to provide basic animation and visual effects support. Note: This class is automatically applied\nto the {@link Roo.Element} interface when included, so all effects calls should be performed via Element.\nConversely, since the effects are not actually defined in Element, Roo.Fx must be included in order for the \nElement effects to work.


\n\n

It is important to note that although the Fx methods and many non-Fx Element methods support \"method chaining\" in that\nthey return the Element object itself as the method return value, it is not always possible to mix the two in a single\nmethod chain. The Fx methods use an internal effects queue so that each effect can be properly timed and sequenced.\nNon-Fx methods, on the other hand, have no such internal queueing and will always execute immediately. For this reason,\nwhile it may be possible to mix certain Fx and non-Fx method calls in a single chain, it may not always provide the\nexpected results and should be done with care.


\n\n

Motion effects support 8-way anchoring, meaning that you can choose one of 8 different anchor points on the Element\nthat will serve as either the start or end point of the animation. Following are all of the supported anchor positions:

\n
\nValue  Description\n-----  -----------------------------\ntl     The top left corner\nt      The center of the top edge\ntr     The top right corner\nl      The center of the left edge\nr      The center of the right edge\nbl     The bottom left corner\nb      The center of the bottom edge\nbr     The bottom right corner\n
\nAlthough some Fx methods accept specific custom config parameters, the ones shown in the Config Options section\nbelow are common options that can be passed to any Fx method.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "easing", + "type" : "String", + "desc" : "A valid Easing value for the effect", + "memberOf" : "Roo.Fx", + "values" : [ + ] + }, + { + "name" : "afterCls", + "type" : "String", + "desc" : "A css class to apply after the effect", + "memberOf" : "Roo.Fx", + "values" : [ + ] + }, + { + "name" : "useDisplay", + "type" : "Boolean", + "desc" : "Whether to use the display CSS property instead of visibility when hiding Elements (only applies to \neffects that end with the element being visually hidden, ignored otherwise)", + "memberOf" : "Roo.Fx", + "values" : [ + ] + }, + { + "name" : "stopFx", + "type" : "Boolean", + "desc" : "Whether subsequent effects should be stopped and removed after the current effect finishes", + "memberOf" : "Roo.Fx", + "values" : [ + ] + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "A function called when the effect is finished", + "memberOf" : "Roo.Fx", + "values" : [ + ] + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "The scope of the effect function", + "memberOf" : "Roo.Fx", + "values" : [ + ] + }, + { + "name" : "remove", + "type" : "Boolean", + "desc" : "Whether the Element should be removed from the DOM and destroyed after the effect finishes", + "memberOf" : "Roo.Fx", + "values" : [ + ] + }, + { + "name" : "concurrent", + "type" : "Boolean", + "desc" : "Whether to allow subsequently-queued effects to run at the same time as the current effect, or to ensure that they run in sequence", + "memberOf" : "Roo.Fx", + "values" : [ + ] + }, + { + "name" : "duration", + "type" : "Number", + "desc" : "The length of time (in seconds) that the effect should last", + "memberOf" : "Roo.Fx", + "values" : [ + ] + }, + { + "name" : "afterStyle", + "type" : "String/Object/Function", + "desc" : "A style specification string, e.g. \"width:100px\", or an object in the form {width:\"100px\"}, or\na function which returns such a specification that will be applied to the Element after the effect finishes", + "memberOf" : "Roo.Fx", + "values" : [ + ] + }, + { + "name" : "block", + "type" : "Boolean", + "desc" : "Whether the effect should block other effects from queueing while it runs", + "memberOf" : "Roo.Fx", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "fadeOut", + "desc" : "Fade an element out (from opaque to transparent). The ending opacity can be specified\nusing the \"endOpacity\" config option.\nUsage:\n
\n// default: fade out from the element's current opacity to 0\nel.fadeOut();\n\n// custom: fade out from the element's current opacity to 25% over 2 seconds\nel.fadeOut({ endOpacity: .25, duration: 2});\n\n// common config options shown with default values\nel.fadeOut({\n    endOpacity: 0, //can be any value between 0 and 1 (e.g. .5)\n    easing: 'easeOut',\n    duration: .5\n    remove: false,\n    useDisplay: false\n});\n
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Fx", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) Object literal with any of the Fx config options", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The Element" + } + ] + }, + { + "name" : "stopFx", + "desc" : "Stops any running effects and clears the element's internal effects queue if it contains\nany additional effects that haven't started yet.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Fx", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The Element" + } + ] + }, + { + "name" : "frame", + "desc" : "Shows a ripple of exploding, attenuating borders to draw attention to an Element.\nUsage:\n
\n// default: a single light blue ripple\nel.frame();\n\n// custom: 3 red ripples lasting 3 seconds total\nel.frame(\"ff0000\", 3, { duration: 3 });\n\n// common config options shown with default values\nel.frame(\"C3DAF9\", 1, {\n    duration: 1 //duration of entire animation (not each individual ripple)\n    // Note: Easing is not configurable and will be ignored if included\n});\n
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Fx", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "color", + "type" : "String", + "desc" : "(optional) The color of the border. Should be a 6 char hex color without the leading # (defaults to light blue: 'C3DAF9').", + "isOptional" : false + }, + { + "name" : "count", + "type" : "Number", + "desc" : "(optional) The number of ripples to display (defaults to 1)", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) Object literal with any of the Fx config options", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The Element" + } + ] + }, + { + "name" : "pause", + "desc" : "Creates a pause before any subsequent queued effects begin. If there are\nno effects queued after the pause it will have no effect.\nUsage:\n
\nel.pause(1);\n
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Fx", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "seconds", + "type" : "Number", + "desc" : "The length of time to pause (in seconds)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The Element" + } + ] + }, + { + "name" : "hasFxBlock", + "desc" : "Returns true if the element is currently blocking so that no other effect can be queued\nuntil this effect is finished, else returns false if blocking is not set. This is commonly\nused to ensure that an effect initiated by a user action runs to completion prior to the\nsame effect being restarted (e.g., firing only one effect even if the user clicks several times).", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Fx", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if blocking, else false" + } + ] + }, + { + "name" : "hasActiveFx", + "desc" : "Returns true if the element has any effects actively running or queued, else returns false.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Fx", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if element has active effects, else false" + } + ] + }, + { + "name" : "highlight", + "desc" : "Highlights the Element by setting a color (applies to the background-color by default, but can be\nchanged using the \"attr\" config option) and then fading back to the original color. If no original\ncolor is available, you should provide the \"endColor\" config option which will be cleared after the animation.\nUsage:\n
\n// default: highlight background to yellow\nel.highlight();\n\n// custom: highlight foreground text to blue for 2 seconds\nel.highlight(\"0000ff\", { attr: 'color', duration: 2 });\n\n// common config options shown with default values\nel.highlight(\"ffff9c\", {\n    attr: \"background-color\", //can be any valid CSS property (attribute) that supports a color value\n    endColor: (current color) or \"ffffff\",\n    easing: 'easeIn',\n    duration: 1\n});\n
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Fx", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "color", + "type" : "String", + "desc" : "(optional) The highlight color. Should be a 6 char hex color without the leading # (defaults to yellow: 'ffff9c')", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) Object literal with any of the Fx config options", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The Element" + } + ] + }, + { + "name" : "syncFx", + "desc" : "Ensures that all effects queued after syncFx is called on the element are\nrun concurrently. This is the opposite of {@link #sequenceFx}.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Fx", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The Element" + } + ] + }, + { + "name" : "puff", + "desc" : "Fades the element out while slowly expanding it in all directions. When the effect is completed, the \nelement will be hidden (visibility = 'hidden') but block elements will still take up space in the document. \nThe element must be removed from the DOM using the 'remove' config option if desired.\nUsage:\n
\n// default\nel.puff();\n\n// common config options shown with default values\nel.puff({\n    easing: 'easeOut',\n    duration: .5,\n    remove: false,\n    useDisplay: false\n});\n
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Fx", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) Object literal with any of the Fx config options", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The Element" + } + ] + }, + { + "name" : "fadeIn", + "desc" : "Fade an element in (from transparent to opaque). The ending opacity can be specified\nusing the \"endOpacity\" config option.\nUsage:\n
\n// default: fade in from opacity 0 to 100%\nel.fadeIn();\n\n// custom: fade in from opacity 0 to 75% over 2 seconds\nel.fadeIn({ endOpacity: .75, duration: 2});\n\n// common config options shown with default values\nel.fadeIn({\n    endOpacity: 1, //can be any value between 0 and 1 (e.g. .5)\n    easing: 'easeOut',\n    duration: .5\n});\n
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Fx", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) Object literal with any of the Fx config options", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The Element" + } + ] + }, + { + "name" : "sequenceFx", + "desc" : "Ensures that all effects queued after sequenceFx is called on the element are\nrun in sequence. This is the opposite of {@link #syncFx}.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Fx", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The Element" + } + ] + }, + { + "name" : "slideIn", + "desc" : "Slides the element into view. An anchor point can be optionally passed to set the point of\norigin for the slide effect. This function automatically handles wrapping the element with\na fixed-size container if needed. See the Fx class overview for valid anchor point options.\nUsage:\n
\n// default: slide the element in from the top\nel.slideIn();\n\n// custom: slide the element in from the right with a 2-second duration\nel.slideIn('r', { duration: 2 });\n\n// common config options shown with default values\nel.slideIn('t', {\n    easing: 'easeOut',\n    duration: .5\n});\n
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Fx", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "anchor", + "type" : "String", + "desc" : "(optional) One of the valid Fx anchor positions (defaults to top: 't')", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) Object literal with any of the Fx config options", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The Element" + } + ] + }, + { + "name" : "ghost", + "desc" : "Slides the element while fading it out of view. An anchor point can be optionally passed to set the \nending point of the effect.\nUsage:\n
\n// default: slide the element downward while fading out\nel.ghost();\n\n// custom: slide the element out to the right with a 2-second duration\nel.ghost('r', { duration: 2 });\n\n// common config options shown with default values\nel.ghost('b', {\n    easing: 'easeOut',\n    duration: .5\n    remove: false,\n    useDisplay: false\n});\n
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Fx", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "anchor", + "type" : "String", + "desc" : "(optional) One of the valid Fx anchor positions (defaults to bottom: 'b')", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) Object literal with any of the Fx config options", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The Element" + } + ] + }, + { + "name" : "slideOut", + "desc" : "Slides the element out of view. An anchor point can be optionally passed to set the end point\nfor the slide effect. When the effect is completed, the element will be hidden (visibility = \n'hidden') but block elements will still take up space in the document. The element must be removed\nfrom the DOM using the 'remove' config option if desired. This function automatically handles \nwrapping the element with a fixed-size container if needed. See the Fx class overview for valid anchor point options.\nUsage:\n
\n// default: slide the element out to the top\nel.slideOut();\n\n// custom: slide the element out to the right with a 2-second duration\nel.slideOut('r', { duration: 2 });\n\n// common config options shown with default values\nel.slideOut('t', {\n    easing: 'easeOut',\n    duration: .5,\n    remove: false,\n    useDisplay: false\n});\n
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Fx", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "anchor", + "type" : "String", + "desc" : "(optional) One of the valid Fx anchor positions (defaults to top: 't')", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) Object literal with any of the Fx config options", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The Element" + } + ] + }, + { + "name" : "scale", + "desc" : "Animates the transition of an element's dimensions from a starting height/width\nto an ending height/width.\nUsage:\n
\n// change height and width to 100x100 pixels\nel.scale(100, 100);\n\n// common config options shown with default values.  The height and width will default to\n// the element's existing values if passed as null.\nel.scale(\n    [element's width],\n    [element's height], {\n    easing: 'easeOut',\n    duration: .35\n});\n
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Fx", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number", + "desc" : "The new width (pass undefined to keep the original width)", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height (pass undefined to keep the original height)", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) Object literal with any of the Fx config options", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The Element" + } + ] + }, + { + "name" : "switchOff", + "desc" : "Blinks the element as if it was clicked and then collapses on its center (similar to switching off a television).\nWhen the effect is completed, the element will be hidden (visibility = 'hidden') but block elements will still \ntake up space in the document. The element must be removed from the DOM using the 'remove' config option if desired.\nUsage:\n
\n// default\nel.switchOff();\n\n// all config options shown with default values\nel.switchOff({\n    easing: 'easeIn',\n    duration: .3,\n    remove: false,\n    useDisplay: false\n});\n
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Fx", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) Object literal with any of the Fx config options", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The Element" + } + ] + }, + { + "name" : "shift", + "desc" : "Animates the transition of any combination of an element's dimensions, xy position and/or opacity.\nAny of these properties not specified in the config object will not be changed. This effect \nrequires that at least one new dimension, position or opacity setting must be passed in on\nthe config object in order for the function to have any effect.\nUsage:\n
\n// slide the element horizontally to x position 200 while changing the height and opacity\nel.shift({ x: 200, height: 50, opacity: .8 });\n\n// common config options shown with default values.\nel.shift({\n    width: [element's width],\n    height: [element's height],\n    x: [element's x position],\n    y: [element's y position],\n    opacity: [element's opacity],\n    easing: 'easeOut',\n    duration: .35\n});\n
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Fx", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "Object literal with any of the Fx config options", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The Element" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.GridPanel.json b/docs2/symbols/Roo.GridPanel.json new file mode 100644 index 0000000000..5788446471 --- /dev/null +++ b/docs2/symbols/Roo.GridPanel.json @@ -0,0 +1,875 @@ +{ + "name" : "Roo.GridPanel", + "augments" : [ + "Roo.ContentPanel", + "Roo.util.Observable" + ], + "desc" : "Create a new GridPanel.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "fitToFrame", + "type" : "Boolean", + "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "background", + "type" : "Boolean", + "desc" : "True if the panel should not be activated when it is added (defaults to false)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "toolbar", + "type" : "Toolbar", + "desc" : "A toolbar for this panel", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "region", + "type" : "String", + "desc" : "which region to put this panel on (when used with xtype constructors)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + "(center", + "north", + "south", + "east", + "west)" + ] + }, + { + "name" : "content", + "type" : "String", + "desc" : "Raw content to fill content panel with (uses setContent on construction.)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title for this panel", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "fitContainer", + "type" : "Boolean", + "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "True if the panel can be closed/removed", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "adjustments", + "type" : "Array", + "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "Calls {@link #setUrl} with this value", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "resizeEl", + "type" : "String/HTMLElement/Element", + "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getGrid", + "desc" : "Returns the grid for this panel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.GridPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.grid.Grid", + "desc" : "" + } + ] + }, + { + "name" : "load", + "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "Object/String/Function", + "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n
\npanel.load({\n    url: \"your-url.php\",\n    params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n    callback: yourFunction,\n    scope: yourObject, //(optional scope)\n    discardUrl: false,\n    nocache: false,\n    text: \"Loading...\",\n    timeout: 30,\n    scripts: false\n});\n
\nThe only required property is url. The optional properties nocache, text and scripts\nare shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this panel UpdateManager instance.", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)", + "isOptional" : false + }, + { + "name" : "discardUrl", + "type" : "Boolean", + "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "this" + } + ] + }, + { + "name" : "getUpdateManager", + "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "isClosable", + "desc" : "Returns true is this panel was configured to be closable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this panel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns this panel's element - used by regiosn to add.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "setContent", + "desc" : "Updates this panel's element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "content", + "type" : "String", + "desc" : "The new content", + "isOptional" : false + }, + { + "name" : "loadScripts", + "type" : "Boolean", + "desc" : "(optional) true to look for and process scripts", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns this panel's id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "addxtype", + "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cfg", + "type" : "Object", + "desc" : "Xtype definition of item to add.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "refresh", + "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getTitle", + "desc" : "Returns this panel's title", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "setTitle", + "desc" : "Set this panel's title", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getToolbar", + "desc" : "Returns the toolbar for this Panel if one was configured.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar", + "desc" : "" + } + ] + }, + { + "name" : "setUrl", + "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "String/Function", + "desc" : "The URL to load the content from or a function to call to get the URL", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)", + "isOptional" : false + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "deactivate", + "desc" : "Fires when this panel is activated.", + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires when this panel is resized if fitToFrame is true.", + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The width after any component adjustments", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The height after any component adjustments", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires when this tab is created", + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Fires when this panel is activated.", + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.HtmlEditorCore.json b/docs2/symbols/Roo.HtmlEditorCore.json new file mode 100644 index 0000000000..9a9c30fe3b --- /dev/null +++ b/docs2/symbols/Roo.HtmlEditorCore.json @@ -0,0 +1,1302 @@ +{ + "name" : "Roo.HtmlEditorCore", + "augments" : [ + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Provides a the editing component for the HTML editors in Roo. (bootstrap and Roo.form)\n\nany element that has display set to 'none' can cause problems in Safari and Firefox.

", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "the", + "type" : "Roo.form.HtmlEditor|Roo.bootstrap.HtmlEditor", + "desc" : "owner field", + "memberOf" : "Roo.HtmlEditorCore", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "(in pixels)", + "memberOf" : "Roo.HtmlEditorCore", + "values" : [ + ] + }, + { + "name" : "resizable", + "type" : "String", + "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.", + "memberOf" : "Roo.HtmlEditorCore", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "(in pixels)", + "memberOf" : "Roo.HtmlEditorCore", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "stylesheets", + "type" : "Array", + "desc" : "url of stylesheets. set to [] to disable stylesheets.", + "memberOf" : "Roo.HtmlEditorCore", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "relayCmd", + "desc" : "Executes a Midas editor command on the editor document and performs necessary focus and\ntoolbar updates. This should only be called after the editor is initialized.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.HtmlEditorCore", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cmd", + "type" : "String", + "desc" : "The Midas command", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String/Boolean", + "desc" : "(optional) The value to pass to the command (defaults to null)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "execCmd", + "desc" : "Executes a Midas editor command directly on the editor document.\nFor visual commands, you should use {@link #relayCmd} instead.\nThis should only be called after the editor is initialized.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.HtmlEditorCore", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cmd", + "type" : "String", + "desc" : "The Midas command", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String/Boolean", + "desc" : "(optional) The value to pass to the command (defaults to null)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "cleanWord", + "desc" : "Clean up MS wordisms...", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.HtmlEditorCore", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "syncValue", + "desc" : "HTML Editor -> Textarea\nProtected method that will not generally be called directly. Syncs the contents\nof the editor iframe with the textarea.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.HtmlEditorCore", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "cleanTableWidths", + "desc" : "cleanTableWidths.\n\nQuite often pasting from word etc.. results in tables with column and widths.\nThis does not work well on fluid HTML layouts - like emails. - so this code should hunt an destroy them..", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.HtmlEditorCore", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "cleanHtml", + "desc" : "Protected method that will not generally be called directly. If you need/want\ncustom HTML cleanup, this is the method you should override.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.HtmlEditorCore", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "html", + "type" : "String", + "desc" : "The HTML to be cleaned\nreturn {String} The cleaned HTML", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toggleSourceEdit", + "desc" : "Toggles the editor between standard and source edit mode.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.HtmlEditorCore", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sourceEdit", + "type" : "Boolean", + "desc" : "(optional) True for source edit, false for standard", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getDocMarkup", + "desc" : "Protected method that will not generally be called directly. It\nis called when the editor initializes the iframe with HTML contents. Override this method if you\nwant to change the initialization markup of the iframe (e.g. to add stylesheets).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.HtmlEditorCore", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "iterateChildren", + "desc" : "iterateChildren of a Node, calling fn each time, using this as the scole..", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.HtmlEditorCore", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "DomNode", + "desc" : "node to iterate children of.", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "method of this class to call on each item.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "pushValue", + "desc" : "Protected method that will not generally be called directly. Pushes the value of the textarea\ninto the iframe editor.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.HtmlEditorCore", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "rangeIntersectsNode", + "desc" : "Range intersection.. the hard stuff...\n '-1' = before\n '0' = hits..\n '1' = after.\n [ -- selected range --- ]\n [fail] [fail]\n\n basically..\n if end is before start or hits it. fail.\n if start is after end or hits it fail.\n\n if either hits (but other is outside. - then it's not", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.HtmlEditorCore", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "insertAtCursor", + "desc" : "Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated\nto insert tRoo.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.HtmlEditorCore", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "| dom node..", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "specialkey", + "desc" : "", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "editorevent", + "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.HtmlEditorCore", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforepush", + "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.HtmlEditorCore", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.HtmlEditorCore", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "initialize", + "desc" : "Fires when the editor is fully initialized (including the iframe)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.HtmlEditorCore", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforesync", + "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.HtmlEditorCore", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "push", + "desc" : "Fires when the iframe editor is updated with content from the textarea.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.HtmlEditorCore", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "sync", + "desc" : "Fires when the textarea is updated with content from the editor iframe.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.HtmlEditorCore", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.JsonView.json b/docs2/symbols/Roo.JsonView.json new file mode 100644 index 0000000000..40427766ad --- /dev/null +++ b/docs2/symbols/Roo.JsonView.json @@ -0,0 +1,1332 @@ +{ + "name" : "Roo.JsonView", + "augments" : [ + "Roo.View", + "Roo.util.Observable" + ], + "desc" : "Shortcut class to create a JSON + {@link Roo.UpdateManager} template view. Usage:\n
\nvar view = new Roo.JsonView({\n    container: \"my-element\",\n    tpl: '<div id=\"{id}\">{foo} - {bar}</div>', // auto create template\n    multiSelect: true, \n    jsonRoot: \"data\" \n});\n\n// listen for node click?\nview.on(\"click\", function(vw, index, node, e){\n    alert('Node \"' + node.id + '\" at index: ' + index + \" was clicked.\");\n});\n\n// direct load of JSON data\nview.load(\"foobar.php\");\n\n// Example from my blog list\nvar tpl = new Roo.Template(\n    '<div class=\"entry\">' +\n    '<a class=\"entry-title\" href=\"{link}\">{title}</a>' +\n    \"<h4>{date} by {author} | {comments} Comments</h4>{description}\" +\n    \"</div><hr />\"\n);\n\nvar moreView = new Roo.JsonView({\n    container :  \"entry-list\", \n    template : tpl,\n    jsonRoot: \"posts\"\n});\nmoreView.on(\"beforerender\", this.sortEntries, this);\nmoreView.load({\n    url: \"/blog/get-posts.php\",\n    params: \"allposts=true\",\n    text: \"Loading Blog Entries...\"\n});\n
\n\nNote: old code is supported with arguments : (container, template, config)", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "selectedClass", + "type" : "String", + "desc" : "The css class to add to selected nodes", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "dataName", + "type" : "String", + "desc" : "the named area of the template to use as the data area\n Works with domtemplates roo-name=\"name\"", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "text", + "type" : "String", + "desc" : "to display on mask (default Loading)", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "multiSelect", + "type" : "Boolean", + "desc" : "Allow multiple selection", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The empty text to show when nothing is loaded.", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "Data store to load data from.", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "toggleSelect", + "type" : "Boolean", + "desc" : "- selecting", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "singleSelect", + "type" : "Boolean", + "desc" : "Allow single selection", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "tickable", + "type" : "Boolean", + "desc" : "- selecting", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "el", + "type" : "String|Roo.Element", + "desc" : "The container element.", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "tpl", + "type" : "String|Roo.Template", + "desc" : "The template used by this View", + "memberOf" : "Roo.View", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getNodeData", + "desc" : "Returns the JSON object for the specified node(s)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.JsonView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement/Array", + "desc" : "The node or an array of nodes", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object/Array", + "desc" : "If you pass in an array, you get an array back, otherwise\nyou get the JSON object for the node" + } + ] + }, + { + "name" : "getCount", + "desc" : "Get the number of records in the current JSON dataset", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.JsonView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "sort", + "desc" : "Sorts the data for this view and refreshes it.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.JsonView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "property", + "type" : "String", + "desc" : "A property on your JSON objects to sort on", + "isOptional" : false + }, + { + "name" : "direction", + "type" : "String", + "desc" : "(optional) \"desc\" or \"asc\" (defaults to \"asc\")", + "isOptional" : false + }, + { + "name" : "sortType", + "type" : "Function", + "desc" : "(optional) A function to call to convert the data to a sortable value.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "refresh", + "desc" : "Refreshes the view.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.JsonView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "filterBy", + "desc" : "Filter by a function. The passed function will be called with each\nobject in the current dataset. If the function returns true the value is kept,\notherwise it is filtered.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.JsonView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to this JsonView)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearFilter", + "desc" : "Clears the current filter.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.JsonView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "load", + "desc" : "Performs an async HTTP request, and loads the JSON from the response. If params are specified it uses POST, otherwise it uses GET.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.JsonView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "Object/String/Function", + "desc" : "The URL for this request, or a function to call to get the URL, or a config object containing any of the following options:\n
\n     view.load({\n         url: \"your-url.php\",\n         params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n         callback: yourFunction,\n         scope: yourObject, //(optional scope)\n         discardUrl: false,\n         nocache: false,\n         text: \"Loading...\",\n         timeout: 30,\n         scripts: false\n     });\n     
\nThe only required property is url. The optional properties nocache, text and scripts\nare respectively shorthand for disableCaching, indicatorText, and loadScripts and are used to set their associated property on this UpdateManager instance.", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The parameters to pass, as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)", + "isOptional" : false + }, + { + "name" : "discardUrl", + "type" : "Boolean", + "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "filter", + "desc" : "Filter the data by a specific property.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.JsonView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "property", + "type" : "String", + "desc" : "A property on your JSON objects", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String/RegExp", + "desc" : "Either string that the property values\nshould start with, or a RegExp to test against the property", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSelectedNodes", + "desc" : "Get the currently selected nodes.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "An array of HTMLElements" + } + ] + }, + { + "name" : "getNodes", + "desc" : "Gets a range template nodes.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "startIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "endIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "An array of nodes" + } + ] + }, + { + "name" : "select", + "desc" : "Selects nodes.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "nodeInfo", + "type" : "Array/HTMLElement/String/Number", + "desc" : "An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) true to keep existing selections", + "isOptional" : false + }, + { + "name" : "suppressEvent", + "type" : "Boolean", + "desc" : "(optional) true to skip firing of the selectionchange vent", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearSelections", + "desc" : "Clear all selections", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "suppressEvent", + "type" : "Boolean", + "desc" : "(optional) true to skip firing of the selectionchange event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isSelected", + "desc" : "Returns true if the passed node is selected", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement/Number", + "desc" : "The node or node index", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "onBeforeLoad", + "desc" : "onbeforeLoad - masks the loading area.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getSelectedIndexes", + "desc" : "Get the indexes of the selected nodes.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "" + } + ] + }, + { + "name" : "indexOf", + "desc" : "Finds the index of the passed node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "nodeInfo", + "type" : "HTMLElement/String/Number", + "desc" : "An HTMLElement template node, index of a template node or the id of a template node", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the node or -1" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the element this view is bound to.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "setStore", + "desc" : "Changes the data store this view uses and refresh the view.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "store", + "type" : "Store", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "refreshNode", + "desc" : "Refresh an individual node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "prepareData", + "desc" : "Function to override to reformat the data that is sent to\nthe template for each node.\nDEPRICATED - use the preparedata event handler.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "data", + "type" : "Array/Object", + "desc" : "The raw data (array of colData for a data model bound view or\na JSON object for an UpdateManager bound view).", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSelectionCount", + "desc" : "Get the number of selected nodes.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "findItemFromChild", + "desc" : "Returns the template node the passed child belongs to or null if it doesn't belong to one.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "The template node" + } + ] + }, + { + "name" : "unselect", + "desc" : "Unselects nodes.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "nodeInfo", + "type" : "Array/HTMLElement/String/Number", + "desc" : "An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) true IGNORED (for campatibility with select)", + "isOptional" : false + }, + { + "name" : "suppressEvent", + "type" : "Boolean", + "desc" : "(optional) true to skip firing of the selectionchange vent", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getNode", + "desc" : "Gets a template node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "nodeInfo", + "type" : "HTMLElement/String/Number", + "desc" : "An HTMLElement template node, index of a template node or the id of a template node", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "The node or null if it wasn't found" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "loadexception", + "desc" : "Fires when loading fails.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.JsonView", + "desc" : "", + "isOptional" : false + }, + { + "name" : "response", + "type" : "Object", + "desc" : "The raw Connect response object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "load", + "desc" : "Fires when data is loaded.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.JsonView", + "desc" : "", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "The JSON data loaded", + "isOptional" : false + }, + { + "name" : "response", + "type" : "Object", + "desc" : "The raw Connect response object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before rendering of the downloaded JSON data.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.JsonView", + "desc" : "", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "The JSON data loaded", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dblclick", + "desc" : "Fires when a template node is double clicked.", + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the target node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "The target node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The raw event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "preparedata", + "desc" : "Fires on every row to render, to allow you to change the data.", + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "to be rendered (change this)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "selectionchange", + "desc" : "Fires when the selected nodes change.", + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "selections", + "type" : "Array", + "desc" : "Array of the selected nodes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeselect", + "desc" : "Fires before a selection is made. If any handlers return false, the selection is cancelled.", + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "The node to be selected", + "isOptional" : false + }, + { + "name" : "selections", + "type" : "Array", + "desc" : "Array of currently selected nodes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeclick", + "desc" : "Fires before a click is processed. Returns false to cancel the default action.", + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the target node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "The target node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The raw event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fires when a template node is clicked.", + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the target node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "The target node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The raw event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "contextmenu", + "desc" : "Fires when a template node is right clicked.", + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the target node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "The target node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The raw event object", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.KeyMap.json b/docs2/symbols/Roo.KeyMap.json new file mode 100644 index 0000000000..f1233ece18 --- /dev/null +++ b/docs2/symbols/Roo.KeyMap.json @@ -0,0 +1,124 @@ +{ + "name" : "Roo.KeyMap", + "augments" : [ + ], + "desc" : "Handles mapping keys to actions for an element. One key map can be used for multiple actions.\nThe constructor accepts the same config object as defined by {@link #addBinding}.\nIf you bind a callback function to a KeyMap, anytime the KeyMap handles an expected key\ncombination it will call the function with this signature (if the match is a multi-key\ncombination the callback will still be called only once): (String key, Roo.EventObject e)\nA KeyMap can also handle a string representation of keys.
\nUsage:\n
\n// map one key by key code\nvar map = new Roo.KeyMap(\"my-element\", {\n    key: 13, // or Roo.EventObject.ENTER\n    fn: myHandler,\n    scope: myObject\n});\n\n// map multiple keys to one action by string\nvar map = new Roo.KeyMap(\"my-element\", {\n    key: \"a\\r\\n\\t\",\n    fn: myHandler,\n    scope: myObject\n});\n\n// map multiple keys to multiple actions by strings and array of codes\nvar map = new Roo.KeyMap(\"my-element\", [\n    {\n        key: [10,13],\n        fn: function(){ alert(\"Return was pressed\"); }\n    }, {\n        key: \"abc\",\n        fn: function(){ alert('a, b or c was pressed'); }\n    }, {\n        key: \"\\t\",\n        ctrl:true,\n        shift:true,\n        fn: function(){ alert('Control + shift + tab was pressed.'); }\n    }\n]);\n
\nNote: A KeyMap starts enabled", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "on", + "desc" : "Shorthand for adding a single key listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.KeyMap", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "key", + "type" : "Number/Array/Object", + "desc" : "Either the numeric key code, array of key codes or an object with the\nfollowing options:\n{key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Disable this KeyMap", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.KeyMap", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isEnabled", + "desc" : "Returns true if this KeyMap is enabled", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.KeyMap", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "enable", + "desc" : "Enables this KeyMap", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.KeyMap", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "addBinding", + "desc" : "Add a new binding to this KeyMap. The following config object properties are supported:\n
\nProperty    Type             Description\n----------  ---------------  ----------------------------------------------------------------------\nkey         String/Array     A single keycode or an array of keycodes to handle\nshift       Boolean          True to handle key only when shift is pressed (defaults to false)\nctrl        Boolean          True to handle key only when ctrl is pressed (defaults to false)\nalt         Boolean          True to handle key only when alt is pressed (defaults to false)\nfn          Function         The function to call when KeyMap finds the expected key combination\nscope       Object           The scope of the callback function\n
\n\nUsage:\n
\n// Create a KeyMap\nvar map = new Roo.KeyMap(document, {\n    key: Roo.EventObject.ENTER,\n    fn: handleKey,\n    scope: this\n});\n\n//Add a new binding to the existing KeyMap later\nmap.addBinding({\n    key: 'abc',\n    shift: true,\n    fn: handleKey,\n    scope: this\n});\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.KeyMap", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object/Array", + "desc" : "A single KeyMap config or an array of configs", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.KeyNav.json b/docs2/symbols/Roo.KeyNav.json new file mode 100644 index 0000000000..ce84fdc30b --- /dev/null +++ b/docs2/symbols/Roo.KeyNav.json @@ -0,0 +1,71 @@ +{ + "name" : "Roo.KeyNav", + "augments" : [ + ], + "desc" : "

Provides a convenient wrapper for normalized keyboard navigation. KeyNav allows you to bind\nnavigation keys to function calls that will get called when the keys are pressed, providing an easy\nway to implement custom navigation schemes for any UI component.

\n

The following are all of the possible keys that can be implemented: enter, left, right, up, down, tab, esc,\npageUp, pageDown, del, home, end. Usage:

\n
\nvar nav = new Roo.KeyNav(\"my-element\", {\n    \"left\" : function(e){\n        this.moveLeft(e.ctrlKey);\n    },\n    \"right\" : function(e){\n        this.moveRight(e.ctrlKey);\n    },\n    \"enter\" : function(e){\n        this.save();\n    },\n    scope : this\n});\n
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable this KeyNav instance (defaults to false)", + "memberOf" : "Roo.KeyNav", + "values" : [ + ] + }, + { + "name" : "defaultEventAction", + "type" : "String", + "desc" : "The method to call on the {@link Roo.EventObject} after this KeyNav intercepts a key. Valid values are\n{@link Roo.EventObject#stopEvent}, {@link Roo.EventObject#preventDefault} and\n{@link Roo.EventObject#stopPropagation} (defaults to 'stopEvent')", + "memberOf" : "Roo.KeyNav", + "values" : [ + ] + }, + { + "name" : "forceKeyDown", + "type" : "Boolean", + "desc" : "Handle the keydown event instead of keypress (defaults to false). KeyNav automatically does this for IE since\nIE does not propagate special keys on keypress, but setting this to true will force other browsers to also\nhandle keydown instead of keypress.", + "memberOf" : "Roo.KeyNav", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "enable", + "desc" : "Enable this KeyNav", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.KeyNav", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Disable this KeyNav", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.KeyNav", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Layer.json b/docs2/symbols/Roo.Layer.json new file mode 100644 index 0000000000..0f0f629d06 --- /dev/null +++ b/docs2/symbols/Roo.Layer.json @@ -0,0 +1,4239 @@ +{ + "name" : "Roo.Layer", + "augments" : [ + "Roo.Element" + ], + "desc" : "An extended {@link Roo.Element} object that supports a shadow and shim, constrain to viewport and\nautomatic maintaining of shadow/shim positions.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "shadow", + "type" : "String/Boolean", + "desc" : "True to create a shadow element with default class \"x-layer-shadow\", or\nyou can pass a string with a CSS class name. False turns off the shadow.", + "memberOf" : "Roo.Layer", + "values" : [ + ] + }, + { + "name" : "constrain", + "type" : "Boolean", + "desc" : "False to disable constrain to viewport (defaults to true)", + "memberOf" : "Roo.Layer", + "values" : [ + ] + }, + { + "name" : "zindex", + "type" : "Number", + "desc" : "Starting z-index (defaults to 11000)", + "memberOf" : "Roo.Layer", + "values" : [ + ] + }, + { + "name" : "shadowOffset", + "type" : "Number", + "desc" : "Number of pixels to offset the shadow (defaults to 3)", + "memberOf" : "Roo.Layer", + "values" : [ + ] + }, + { + "name" : "dh", + "type" : "Object", + "desc" : "DomHelper object config to create element with (defaults to {tag: \"div\", cls: \"x-layer\"}).", + "memberOf" : "Roo.Layer", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "CSS class to add to the element", + "memberOf" : "Roo.Layer", + "values" : [ + ] + }, + { + "name" : "shim", + "type" : "Boolean", + "desc" : "False to disable the iframe shim in browsers which need one (defaults to true)", + "memberOf" : "Roo.Layer", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "setZIndex", + "desc" : "Sets the z-index of this layer and adjusts any shadow and shim z-indexes. The layer z-index is automatically\nincremented by two more than the value passed in so that it always shows above any shadow or shim (the shadow\nelement, if any, will be assigned z-index + 1, and the shim element, if any, will be assigned the unmodified z-index).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Layer", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "zindex", + "type" : "Number", + "desc" : "The new z-index to set", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "this", + "desc" : "The Layer" + } + ] + }, + { + "name" : "getCenterXY", + "desc" : "Calculates the x, y to center this element on the screen", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The x, y values [x, y]" + } + ] + }, + { + "name" : "getScroll", + "desc" : "Returns the current scroll position of the element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the scroll position in the format {left: (scrollLeft), top: (scrollTop)}" + } + ] + }, + { + "name" : "createShim", + "desc" : "Creates an iframe shim for this element to keep selects and other windowed objects from\nshowing through.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The new shim element" + } + ] + }, + { + "name" : "scrollTo", + "desc" : "Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it will try to do it. For auto bounds checking, use scroll().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "side", + "type" : "String", + "desc" : "Either \"left\" for scrollLeft values or \"top\" for scrollTop values.", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Number", + "desc" : "The new scroll value", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "this" + } + ] + }, + { + "name" : "removeAllListeners", + "desc" : "Removes all previous added listeners from this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setStyle", + "desc" : "Wrapper for setting style properties, also takes single object parameter of multiple styles.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "property", + "type" : "String/Object", + "desc" : "The style property to be set, or an object of multiple styles.", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String", + "desc" : "(optional) The value to apply to the given property, or null if an object was passed.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler (Shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to append", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) of the fn", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)An object with standard {@link Roo.EventManager#addListener} options", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addClassOnClick", + "desc" : "Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "className", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getBorderWidth", + "desc" : "Gets the width of the border(s) for the specified side(s)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "side", + "type" : "String", + "desc" : "Can be t, l, r, b or any combination of those to add multiple values. For example,\npassing lr would get the border (l)eft width + the border (r)ight width.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The width of the sides passed added together" + } + ] + }, + { + "name" : "scroll", + "desc" : "Scrolls this element the specified direction. Does bounds checking to make sure the scroll is\nwithin this element's scrollable range.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "direction", + "type" : "String", + "desc" : "Possible values are: \"l\",\"left\" - \"r\",\"right\" - \"t\",\"top\",\"up\" - \"b\",\"bottom\",\"down\".", + "isOptional" : false + }, + { + "name" : "distance", + "type" : "Number", + "desc" : "How far to scroll the element in pixels", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "Returns true if a scroll was triggered or false if the element\nwas scrolled as far as it could go." + } + ] + }, + { + "name" : "addKeyMap", + "desc" : "Creates a KeyMap for this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "The KeyMap config. See {@link Roo.KeyMap} for more details", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.KeyMap", + "desc" : "The KeyMap created" + } + ] + }, + { + "name" : "createChild", + "desc" : "Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be\nautomatically generated with the specified attributes.", + "isOptional" : false + }, + { + "name" : "insertBefore", + "type" : "HTMLElement", + "desc" : "(optional) a child element of this element", + "isOptional" : false + }, + { + "name" : "returnDom", + "type" : "Boolean", + "desc" : "(optional) true to return the dom node instead of creating an Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The new child element" + } + ] + }, + { + "name" : "addClass", + "desc" : "Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "className", + "type" : "String/Array", + "desc" : "The CSS class to add, or an array of classes", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "attr", + "desc" : "Sets or Returns the value the dom attribute value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "name", + "type" : "String|Object", + "desc" : "The attribute name (or object to set multiple attributes)", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String", + "desc" : "(optional) The value to set the attribute to", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The attribute value" + } + ] + }, + { + "name" : "setOpacity", + "desc" : "Set the opacity of the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "opacity", + "type" : "Float", + "desc" : "The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setSize", + "desc" : "Set the size of the element. If animation is true, both width an height will be animated concurrently.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "un", + "desc" : "Removes an event handler from this element (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "the type of event to remove", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "the method the event invokes", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "up", + "desc" : "Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child).\nThis is a shortcut for findParentNode() that always returns an Roo.Element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The simple selector to test", + "isOptional" : false + }, + { + "name" : "maxDepth", + "type" : "Number/String/HTMLElement/Element", + "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The matching DOM node (or null if no match was found)" + } + ] + }, + { + "name" : "repaint", + "desc" : "Forces the browser to repaint this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "translatePoints", + "desc" : "Translates the passed page coordinates into left/top css values for this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number/Array", + "desc" : "The page x or an array containing [x, y]", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The page y", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object with left and top properties. e.g. {left: (value), top: (value)}" + } + ] + }, + { + "name" : "createProxy", + "desc" : "Creates a proxy element of this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "String/Object", + "desc" : "The class name of the proxy element or a DomHelper config object", + "isOptional" : false + }, + { + "name" : "renderTo", + "type" : "String/HTMLElement", + "desc" : "(optional) The element or element id to render the proxy to (defaults to document.body)", + "isOptional" : false + }, + { + "name" : "matchBox", + "type" : "Boolean", + "desc" : "(optional) True to align and size the proxy to this element now (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The new proxy element" + } + ] + }, + { + "name" : "down", + "desc" : "Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The CSS selector", + "isOptional" : false + }, + { + "name" : "returnDom", + "type" : "Boolean", + "desc" : "(optional) True to return the DOM node instead of Roo.Element (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The child Roo.Element (or DOM node if returnDom = true)" + } + ] + }, + { + "name" : "getBox", + "desc" : "Return a box {x, y, width, height} that can be used to set another elements\nsize/location to match this element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "contentBox", + "type" : "Boolean", + "desc" : "(optional) If true a box for the content of the element is returned.", + "isOptional" : false + }, + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page x/y.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "box An object in the format {x, y, width, height}" + } + ] + }, + { + "name" : "toggle", + "desc" : "Toggles the element's visibility or display, depending on visibility mode.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) True for the default animation, or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setBounds", + "desc" : "Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "X value for new position (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "Y value for new position (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getX", + "desc" : "Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The X position of the element" + } + ] + }, + { + "name" : "getY", + "desc" : "Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The Y position of the element" + } + ] + }, + { + "name" : "focus", + "desc" : "Tries to focus the element. Any exceptions are caught and ignored.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "get", + "desc" : "Static method to retrieve Element objects. Uses simple caching to consistently return the same object.\nAutomatically fixes if an object was recreated with the same id via AJAX or DOM.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM Node or an existing Element.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The Element object" + } + ] + }, + { + "name" : "autoHeight", + "desc" : "Measures the element's content height and updates height to match. Note: this function uses setTimeout so\nthe new height may not be available immediately.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "animate", + "type" : "Boolean", + "desc" : "(optional) Animate the transition (defaults to false)", + "isOptional" : false + }, + { + "name" : "duration", + "type" : "Float", + "desc" : "(optional) Length of the animation in seconds (defaults to .35)", + "isOptional" : false + }, + { + "name" : "onComplete", + "type" : "Function", + "desc" : "(optional) Function to call when animation completes", + "isOptional" : false + }, + { + "name" : "easing", + "type" : "String", + "desc" : "(optional) Easing method to use (defaults to easeOut)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "scrollIntoView", + "desc" : "Scrolls this element into view within the passed container.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The container element to scroll (defaults to document.body)", + "isOptional" : false + }, + { + "name" : "hscroll", + "type" : "Boolean", + "desc" : "(optional) False to disable horizontal scroll (defaults to true)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getAlignToXY", + "desc" : "Gets the x,y coordinates to align this element with another element. See {@link #alignTo} for more info on the\nsupported position values.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to.", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "The position to align to.", + "isOptional" : false + }, + { + "name" : "offsets", + "type" : "Array", + "desc" : "(optional) Offset the positioning by [x, y]", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "[x, y]" + } + ] + }, + { + "name" : "clearOpacity", + "desc" : "Clears any opacity settings from this element. Required in some cases for IE.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setPositioning", + "desc" : "Set positioning with an object returned by getPositioning().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "posCfg", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getMargins", + "desc" : "Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed,\nthen it returns the calculated width of the sides (see getPadding)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sides", + "type" : "String", + "desc" : "(optional) Any combination of l, r, t, b to get the sum of those sides", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object/Number", + "desc" : "" + } + ] + }, + { + "name" : "setRegion", + "desc" : "Sets the element's position and size the the specified region. If animation is true then width, height, x and y will be animated concurrently.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.lib.Region", + "desc" : "The region to fill", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getAttributeNS", + "desc" : "Returns the value of a namespaced attribute from the element's underlying DOM node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "namespace", + "type" : "String", + "desc" : "The namespace in which to look for the attribute", + "isOptional" : false + }, + { + "name" : "name", + "type" : "String", + "desc" : "The attribute name", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The attribute value" + } + ] + }, + { + "name" : "setLeft", + "desc" : "Sets the element's left position directly using CSS style (instead of {@link #setX}).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "String", + "desc" : "The left CSS property value", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "load", + "desc" : "Direct access to the UpdateManager update() method (takes the same parameters).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "String/Function", + "desc" : "The url for this request or a function to call to get the url", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The parameters to pass as either a url encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)", + "isOptional" : false + }, + { + "name" : "discardUrl", + "type" : "Boolean", + "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "replaceClass", + "desc" : "Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "oldClassName", + "type" : "String", + "desc" : "The CSS class to replace", + "isOptional" : false + }, + { + "name" : "newClassName", + "type" : "String", + "desc" : "The replacement CSS class", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "initDDTarget", + "desc" : "Initializes a {@link Roo.dd.DDTarget} object for this element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "group", + "type" : "String", + "desc" : "The group the DDTarget object is member of", + "isOptional" : false + }, + { + "name" : "config", + "type" : "Object", + "desc" : "The DDTarget config object", + "isOptional" : false + }, + { + "name" : "overrides", + "type" : "Object", + "desc" : "An object containing methods to override/implement on the DDTarget object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.dd.DDTarget", + "desc" : "The DDTarget object" + } + ] + }, + { + "name" : "setHeight", + "desc" : "Set the height of the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "height", + "type" : "Number", + "desc" : "The new height", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "clean", + "desc" : "Removes worthless text nodes", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "forceReclean", + "type" : "Boolean", + "desc" : "(optional) By default the element\nkeeps track if it has been cleaned already so\nyou can call this over and over. However, if you update the element and\nneed to force a reclean, you can pass true.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getPositioning", + "desc" : "Gets an object with all CSS positioning properties. Useful along with setPostioning to get\nsnapshot before performing an update and then restoring the element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] + }, + { + "name" : "update", + "desc" : "Update the innerHTML of this element, optionally searching for and processing scripts", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "html", + "type" : "String", + "desc" : "The new HTML", + "isOptional" : false + }, + { + "name" : "loadScripts", + "type" : "Boolean", + "desc" : "(optional) true to look for and process scripts", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "For async script loading you can be noticed when the update completes", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "contains", + "desc" : "Returns true if this element is an ancestor of the passed element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "HTMLElement/String", + "desc" : "The element to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if this element is an ancestor of el, else false" + } + ] + }, + { + "name" : "appendChild", + "desc" : "Appends the passed element(s) to this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Array/Element/CompositeElement", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getValue", + "desc" : "Returns the value of the \"value\" attribute", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "asNumber", + "type" : "Boolean", + "desc" : "true to parse the value as a number", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String/Number", + "desc" : "" + } + ] + }, + { + "name" : "getRegion", + "desc" : "Returns the region of the given element.\nThe element must be part of the DOM tree to have a region (display:none or elements not appended return false).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Region", + "desc" : "A Roo.lib.Region containing \"top, left, bottom, right\" member data." + } + ] + }, + { + "name" : "anchorTo", + "desc" : "Anchors an element to another element and realigns it when the window is resized.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to.", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "The position to align to.", + "isOptional" : false + }, + { + "name" : "offsets", + "type" : "Array", + "desc" : "(optional) Offset the positioning by [x, y]", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) True for the default animation or a standard Element animation config object", + "isOptional" : false + }, + { + "name" : "monitorScroll", + "type" : "Boolean/Number", + "desc" : "(optional) True to monitor body scroll and reposition. If this parameter\nis a number, it is used as the buffer delay (defaults to 50ms).", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "The function to call after the animation finishes", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "removeClass", + "desc" : "Removes one or more CSS classes from the element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "className", + "type" : "String/Array", + "desc" : "The CSS class to remove, or an array of classes", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "radioClass", + "desc" : "Adds one or more CSS classes to this element and removes the same class(es) from all siblings.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "className", + "type" : "String/Array", + "desc" : "The CSS class to add, or an array of classes", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getWidth", + "desc" : "Returns the offset width of the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "contentWidth", + "type" : "Boolean", + "desc" : "(optional) true to get the width minus borders and padding", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The element's width" + } + ] + }, + { + "name" : "insertBefore", + "desc" : "Inserts this element before the passed element in the DOM", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The element to insert before", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getHeight", + "desc" : "Returns the offset height of the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "contentHeight", + "type" : "Boolean", + "desc" : "(optional) true to get the height minus borders and padding", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The element's height" + } + ] + }, + { + "name" : "setTop", + "desc" : "Sets the element's top position directly using CSS style (instead of {@link #setY}).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "top", + "type" : "String", + "desc" : "The top CSS property value", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "toggleClass", + "desc" : "Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "className", + "type" : "String", + "desc" : "The CSS class to toggle", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "wrap", + "desc" : "Creates and wraps this element with another element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "(optional) DomHelper element config object for the wrapper element or null for an empty div", + "isOptional" : false + }, + { + "name" : "returnDom", + "type" : "Boolean", + "desc" : "(optional) True to return the raw DOM element instead of Roo.Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Element", + "desc" : "The newly created wrapper element" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use\nthe display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "Whether the element is visible", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) True for the default animation, or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to append", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) of the fn", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)An object with standard {@link Roo.EventManager#addListener} options", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setWidth", + "desc" : "Set the width of the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "center", + "desc" : "Centers the Element in either the viewport, or another Element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "centerIn", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "(optional) The element in which to center the element.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Checks whether the element is currently visible using both visibility and display properties.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to walk the dom and see if parent elements are hidden (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the element is currently visible, else false" + } + ] + }, + { + "name" : "findParent", + "desc" : "Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The simple selector to test", + "isOptional" : false + }, + { + "name" : "maxDepth", + "type" : "Number/String/HTMLElement/Element", + "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)", + "isOptional" : false + }, + { + "name" : "returnEl", + "type" : "Boolean", + "desc" : "(optional) True to return a Roo.Element object instead of DOM node", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "The matching DOM node (or null if no match was found)" + } + ] + }, + { + "name" : "addKeyListener", + "desc" : "Convenience method for constructing a KeyMap", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "key", + "type" : "Number/Array/Object/String", + "desc" : "Either a string with the keys to listen for, the numeric key code, array of key codes or an object with the following options:\n {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.KeyMap", + "desc" : "The KeyMap created" + } + ] + }, + { + "name" : "swallowEvent", + "desc" : "Stops the specified event from bubbling and optionally prevents the default action", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : "(optional) true to prevent the default action too", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getStyles", + "desc" : "Returns an object with properties matching the styles requested.\nFor example, el.getStyles('color', 'font-size', 'width') might return\n{'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "style1", + "type" : "String", + "desc" : "A style name", + "isOptional" : false + }, + { + "name" : "style2", + "type" : "String", + "desc" : "A style name", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The style object" + } + ] + }, + { + "name" : "getSize", + "desc" : "Returns the size of the element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "contentSize", + "type" : "Boolean", + "desc" : "(optional) true to get the width/size minus borders and padding", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "endMeasure", + "desc" : "Restores displays to before beginMeasure was called", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getViewSize", + "desc" : "Returns the width and height of the viewport.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the viewport's size {width: (viewport width), height: (viewport height)}" + } + ] + }, + { + "name" : "addClassOnFocus", + "desc" : "Sets up event handlers to add and remove a css class when this element has the focus", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "className", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "alignTo", + "desc" : "Aligns this element with another element relative to the specified anchor points. If the other element is the\ndocument it aligns it to the viewport.\nThe position parameter is optional, and can be specified in any one of the following formats:\n
    \n
  • Blank: Defaults to aligning the element's top-left corner to the target's bottom-left corner (\"tl-bl\").
  • \n
  • One anchor (deprecated): The passed anchor position is used as the target element's anchor point.\n The element being aligned will position its top-left corner (tl) to that point. This method has been\n deprecated in favor of the newer two anchor syntax below.
  • \n
  • Two anchors: If two values from the table below are passed separated by a dash, the first value is used as the\n element's anchor point, and the second value is used as the target's anchor point.
  • \n
\nIn addition to the anchor points, the position parameter also supports the \"?\" character. If \"?\" is passed at the end of\nthe position string, the element will attempt to align as specified, but the position will be adjusted to constrain to\nthe viewport if necessary. Note that the element being aligned might be swapped to align to a different position than\nthat specified in order to enforce the viewport constraints.\nFollowing are all of the supported anchor positions:\n
\n    Value  Description\n    -----  -----------------------------\n    tl     The top left corner (default)\n    t      The center of the top edge\n    tr     The top right corner\n    l      The center of the left edge\n    c      In the center of the element\n    r      The center of the right edge\n    bl     The bottom left corner\n    b      The center of the bottom edge\n    br     The bottom right corner\n    
\n Example Usage:\n
\n    // align el to other-el using the default positioning (\"tl-bl\", non-constrained)\n    el.alignTo(\"other-el\");\n\n    // align the top left corner of el with the top right corner of other-el (constrained to viewport)\n    el.alignTo(\"other-el\", \"tr?\");\n\n    // align the bottom right corner of el with the center left edge of other-el\n    el.alignTo(\"other-el\", \"br-l?\");\n\n    // align the center of el with the bottom left corner of other-el and\n    // adjust the x position by -6 pixels (and the y position by 0)\n    el.alignTo(\"other-el\", \"c-bl\", [-6, 0]);\n    
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to.", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "The position to align to.", + "isOptional" : false + }, + { + "name" : "offsets", + "type" : "Array", + "desc" : "(optional) Offset the positioning by [x, y]", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "insertAfter", + "desc" : "Inserts this element after the passed element in the DOM", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The element to insert after", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setBottom", + "desc" : "Sets the element's CSS bottom style.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "bottom", + "type" : "String", + "desc" : "The bottom CSS property value", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "clearPositioning", + "desc" : "Clear positioning back to the default when the document was loaded", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "(optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "isDisplayed", + "desc" : "Returns true if display is not \"none\"", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "show", + "desc" : "Show this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setLeftTop", + "desc" : "Quick set left and top adding default units", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "String", + "desc" : "The left CSS property value", + "isOptional" : false + }, + { + "name" : "top", + "type" : "String", + "desc" : "The top CSS property value", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "child", + "desc" : "Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The CSS selector", + "isOptional" : false + }, + { + "name" : "returnDom", + "type" : "Boolean", + "desc" : "(optional) True to return the DOM node instead of Roo.Element (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The child Roo.Element (or DOM node if returnDom = true)" + } + ] + }, + { + "name" : "unmask", + "desc" : "Removes a previously applied mask. If removeEl is true the mask overlay is destroyed, otherwise\nit is cached for reuse.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "moveTo", + "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "X value for new position (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "Y value for new position (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) True for the default animation, or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "addClassOnOver", + "desc" : "Sets up event handlers to add and remove a css class when the mouse is over this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "className", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "preventFlicker", + "type" : "Boolean", + "desc" : "(optional) If set to true, it prevents flickering by filtering\nmouseout events for children elements", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getLeft", + "desc" : "Gets the left X coordinate", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "True to get the local css position instead of page coordinate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "isScrollable", + "desc" : "Returns true if this element is scrollable.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "boxWrap", + "desc" : "Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a\ngradient background, rounded corners and a 4-way shadow.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "class", + "type" : "String", + "desc" : "(optional) A base CSS class to apply to the containing wrapper element (defaults to 'x-box').\nNote that there are a number of CSS rules that are dependent on this name to make the overall effect work,\nso if you supply an alternate base class, make sure you also supply all of the necessary rules.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "replace", + "desc" : "Replaces the passed element with this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The element to replace", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "select", + "desc" : "Creates a {@link Roo.CompositeElement} for child nodes based on the passed CSS selector (the selector should not contain an id).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The CSS selector", + "isOptional" : false + }, + { + "name" : "unique", + "type" : "Boolean", + "desc" : "(optional) True to create a unique Roo.Element for each child (defaults to false, which creates a single shared flyweight object)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "CompositeElement/CompositeElementLite", + "desc" : "The composite element" + } + ] + }, + { + "name" : "isMasked", + "desc" : "Returns true if this element is masked", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getUpdateManager", + "desc" : "Gets this element's UpdateManager", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "insertHtml", + "desc" : "Inserts an html fragment into this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "where", + "type" : "String", + "desc" : "Where to insert the html in relation to the this element - beforeBegin, afterBegin, beforeEnd, afterEnd.", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "The HTML fragment", + "isOptional" : false + }, + { + "name" : "returnEl", + "type" : "Boolean", + "desc" : "True to return an Roo.Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The inserted node (or nearest related if more than 1 inserted)" + } + ] + }, + { + "name" : "mask", + "desc" : "Puts a mask over this element to disable user interaction. Requires core.css.\nThis method can only be applied to elements which accept child nodes.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "(optional) A message to display in the mask", + "isOptional" : false + }, + { + "name" : "msgCls", + "type" : "String", + "desc" : "(optional) A css class to apply to the msg element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The mask element" + } + ] + }, + { + "name" : "getTop", + "desc" : "Gets the top Y coordinate", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "True to get the local css position instead of page coordinate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "getBottom", + "desc" : "Gets the bottom Y coordinate of the element (element Y position + element height)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "True to get the local css position instead of page coordinate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "getRight", + "desc" : "Gets the right X coordinate of the element (element X position + element width)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "True to get the local css position instead of page coordinate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "beginMeasure", + "desc" : "Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "appendTo", + "desc" : "Appends this element to the passed element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The new parent element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "fly", + "desc" : "Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -\nthe dom node can be overwritten by other code.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement", + "desc" : "The dom node or id", + "isOptional" : false + }, + { + "name" : "named", + "type" : "String", + "desc" : "(optional) Allows for creation of named reusable flyweights to\n prevent conflicts (e.g. internally Roo uses \"_internal\")", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The shared Element object" + } + ] + }, + { + "name" : "hasClass", + "desc" : "Checks if the specified CSS class exists on this element's DOM node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "className", + "type" : "String", + "desc" : "The CSS class to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the class exists, else false" + } + ] + }, + { + "name" : "findScrollableParent", + "desc" : "Looks at the scrollable parent element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "fitToParent", + "desc" : "Sizes this element to its parent element's dimensions performing\nneccessary box adjustments.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "monitorResize", + "type" : "Boolean", + "desc" : "(optional) If true maintains the fit when the browser window is resized.", + "isOptional" : false + }, + { + "name" : "targetParent", + "type" : "String/HTMLElment/Element", + "desc" : "(optional) The target parent, default to the parentNode.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setXY", + "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "pos", + "type" : "Array", + "desc" : "Contains X & Y [x, y] values for new position (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) True for the default animation, or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getXY", + "desc" : "Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element" + } + ] + }, + { + "name" : "unselectable", + "desc" : "Disables text selection for this element (normalized across browsers)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "blur", + "desc" : "Tries to blur the element. Any exceptions are caught and ignored.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setRight", + "desc" : "Sets the element's CSS right style.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "right", + "type" : "String", + "desc" : "The right CSS property value", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "findParentNode", + "desc" : "Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The simple selector to test", + "isOptional" : false + }, + { + "name" : "maxDepth", + "type" : "Number/String/HTMLElement/Element", + "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)", + "isOptional" : false + }, + { + "name" : "returnEl", + "type" : "Boolean", + "desc" : "(optional) True to return a Roo.Element object instead of DOM node", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "The matching DOM node (or null if no match was found)" + } + ] + }, + { + "name" : "position", + "desc" : "Initializes positioning on this element. If a desired position is not passed, it will make the\nthe element positioned relative IF it is not already positioned.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "pos", + "type" : "String", + "desc" : "(optional) Positioning to use \"relative\", \"absolute\" or \"fixed\"", + "isOptional" : false + }, + { + "name" : "zIndex", + "type" : "Number", + "desc" : "(optional) The zIndex to apply", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "(optional) Set the page X position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "(optional) Set the page Y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getFrameWidth", + "desc" : "Returns the sum width of the padding and borders for the passed \"sides\". See getBorderWidth()\n for more information about the sides.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sides", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "setLocation", + "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "X value for new position (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "Y value for new position (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) True for the default animation, or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "unclip", + "desc" : "Return clipping (overflow) to original clipping before clip() was called", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "set", + "desc" : "Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "The object with the attributes", + "isOptional" : false + }, + { + "name" : "useSet", + "type" : "Boolean", + "desc" : "(optional) false to override the default setAttribute to use expandos.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setDisplayed", + "desc" : "Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean", + "desc" : "Boolean value to display the element using its default display, or a string to set the display directly", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "insertFirst", + "desc" : "Inserts (or creates) an element (or DomHelper config) as the first child of the this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element/Object", + "desc" : "The id or element to insert or a DomHelper config to create and insert", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The new child" + } + ] + }, + { + "name" : "animate", + "desc" : "Perform animation on this element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "args", + "type" : "Object", + "desc" : "The YUI animation control args", + "isOptional" : false + }, + { + "name" : "duration", + "type" : "Float", + "desc" : "(optional) How long the animation lasts in seconds (defaults to .35)", + "isOptional" : false + }, + { + "name" : "onComplete", + "type" : "Function", + "desc" : "(optional) Function to call when animation completes", + "isOptional" : false + }, + { + "name" : "easing", + "type" : "String", + "desc" : "(optional) Easing method to use (defaults to 'easeOut')", + "isOptional" : false + }, + { + "name" : "animType", + "type" : "String", + "desc" : "(optional) 'run' is the default. Can also be 'color', 'motion', or 'scroll'", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "enableDisplayMode", + "desc" : "Convenience method for setVisibilityMode(Element.DISPLAY)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "display", + "type" : "String", + "desc" : "(optional) What to set display to when visible", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getComputedWidth", + "desc" : "Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders\nwhen needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements\nif a width has not been set using CSS.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "clip", + "desc" : "Store the current overflow setting and clip overflow on the element - use {@link #unclip} to remove", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setVisibilityMode", + "desc" : "Sets the element's visibility mode. When setVisible() is called it\nwill use this to determine whether to set the visibility or the display property.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visMode", + "type" : "", + "desc" : "Element.VISIBILITY or Element.DISPLAY", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getColor", + "desc" : "Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values\nare convert to standard 6 digit hex color.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "attr", + "type" : "String", + "desc" : "The css attribute", + "isOptional" : false + }, + { + "name" : "defaultValue", + "type" : "String", + "desc" : "The default value to use when a valid color isn't found", + "isOptional" : false + }, + { + "name" : "prefix", + "type" : "String", + "desc" : "(optional) defaults to #. Use an empty string when working with\nYUI color anims.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "insertSibling", + "desc" : "Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element/Object", + "desc" : "The id or element to insert or a DomHelper config to create and insert", + "isOptional" : false + }, + { + "name" : "where", + "type" : "String", + "desc" : "(optional) 'before' or 'after' defaults to before", + "isOptional" : false + }, + { + "name" : "returnDom", + "type" : "Boolean", + "desc" : "(optional) True to return the raw DOM element instead of Roo.Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "the inserted Element" + } + ] + }, + { + "name" : "removeListener", + "desc" : "Removes an event handler from this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "the type of event to remove", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "the method the event invokes", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "applyStyles", + "desc" : "More flexible version of {@link #setStyle} for setting style properties.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "styles", + "type" : "String/Object/Function", + "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "getPrevSibling", + "desc" : "Gets the previous sibling, skipping text nodes", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "The previous sibling or null" + } + ] + }, + { + "name" : "setBox", + "desc" : "Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x and y will be animated concurrently.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "The box to fill {x, y, width, height}", + "isOptional" : false + }, + { + "name" : "adjust", + "type" : "Boolean", + "desc" : "(optional) Whether to adjust for box-model issues automatically", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "initDDProxy", + "desc" : "Initializes a {@link Roo.dd.DDProxy} object for this element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "group", + "type" : "String", + "desc" : "The group the DDProxy object is member of", + "isOptional" : false + }, + { + "name" : "config", + "type" : "Object", + "desc" : "The DDProxy config object", + "isOptional" : false + }, + { + "name" : "overrides", + "type" : "Object", + "desc" : "An object containing methods to override/implement on the DDProxy object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.dd.DDProxy", + "desc" : "The DDProxy object" + } + ] + }, + { + "name" : "setX", + "desc" : "Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "The", + "type" : "Number", + "desc" : "X position of the element", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) True for the default animation, or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "setY", + "desc" : "Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "The", + "type" : "Number", + "desc" : "Y position of the element", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) True for the default animation, or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "query", + "desc" : "Selects child nodes based on the passed CSS selector (the selector should not contain an id).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The CSS selector", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "An array of the matched nodes" + } + ] + }, + { + "name" : "getAnchorXY", + "desc" : "Gets the x,y coordinates specified by the anchor position on the element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "anchor", + "type" : "String", + "desc" : "(optional) The specified anchor position (defaults to \"c\"). See {@link #alignTo} for details on supported anchor positions.", + "isOptional" : false + }, + { + "name" : "size", + "type" : "Object", + "desc" : "(optional) An object containing the size to use for calculating anchor position\n {width: (target width), height: (target height)} (defaults to the element's current size)", + "isOptional" : false + }, + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) True to get the local (element top/left-relative) anchor position instead of page coordinates", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "[x, y] An array containing the element's x and y coordinates" + } + ] + }, + { + "name" : "initDD", + "desc" : "Initializes a {@link Roo.dd.DD} drag drop object for this element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "group", + "type" : "String", + "desc" : "The group the DD object is member of", + "isOptional" : false + }, + { + "name" : "config", + "type" : "Object", + "desc" : "The DD config object", + "isOptional" : false + }, + { + "name" : "overrides", + "type" : "Object", + "desc" : "An object containing methods to override/implement on the DD object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.dd.DD", + "desc" : "The DD object" + } + ] + }, + { + "name" : "getComputedHeight", + "desc" : "Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders\nwhen needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements\nif a height has not been set using CSS.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "is", + "desc" : "Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The simple selector to test", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if this element matches the selector, else false" + } + ] + }, + { + "name" : "move", + "desc" : "Move this element relative to its current position.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "direction", + "type" : "String", + "desc" : "Possible values are: \"l\",\"left\" - \"r\",\"right\" - \"t\",\"top\",\"up\" - \"b\",\"bottom\",\"down\".", + "isOptional" : false + }, + { + "name" : "distance", + "type" : "Number", + "desc" : "How far to move the element in pixels", + "isOptional" : false + }, + { + "name" : "animate", + "type" : "Boolean/Object", + "desc" : "(optional) true for the default animation or a standard Element animation config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "this" + } + ] + }, + { + "name" : "remove", + "desc" : "Removes this element from the DOM and deletes it from the cache", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getNextSibling", + "desc" : "Gets the next sibling, skipping text nodes", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "The next sibling or null" + } + ] + }, + { + "name" : "getStyle", + "desc" : "Normalizes currentStyle and computedStyle. This is not YUI getStyle, it is an optimised version.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "property", + "type" : "String", + "desc" : "The style property whose value is returned.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The current value of the style property for this element." + } + ] + }, + { + "name" : "isBorderBox", + "desc" : "Tests various css rules/browsers to determine if this element uses a border box", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getPadding", + "desc" : "Gets the width of the padding(s) for the specified side(s)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "side", + "type" : "String", + "desc" : "Can be t, l, r, b or any combination of those to add multiple values. For example,\npassing lr would get the padding (l)eft + the padding (r)ight.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The padding of the sides passed added together" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.LayoutDialog.json b/docs2/symbols/Roo.LayoutDialog.json new file mode 100644 index 0000000000..acdd80ed1a --- /dev/null +++ b/docs2/symbols/Roo.LayoutDialog.json @@ -0,0 +1,1395 @@ +{ + "name" : "Roo.LayoutDialog", + "augments" : [ + "Roo.BasicDialog", + "Roo.util.Observable" + ], + "desc" : "Dialog which provides adjustments for working with a layout in a Dialog.\nAdd your necessary layout config options to the dialog's config.
\nExample usage (including a nested layout):\n
\nif(!dialog){\n    dialog = new Roo.LayoutDialog(\"download-dlg\", {\n        modal: true,\n        width:600,\n        height:450,\n        shadow:true,\n        minWidth:500,\n        minHeight:350,\n        autoTabs:true,\n        proxyDrag:true,\n        // layout config merges with the dialog config\n        center:{\n            tabPosition: \"top\",\n            alwaysShowTabs: true\n        }\n    });\n    dialog.addKeyListener(27, dialog.hide, dialog);\n    dialog.setDefaultButton(dialog.addButton(\"Close\", dialog.hide, dialog));\n    dialog.addButton(\"Build It!\", this.getDownload, this);\n\n    // we can even add nested layouts\n    var innerLayout = new Roo.BorderLayout(\"dl-inner\", {\n        east: {\n            initialSize: 200,\n            autoScroll:true,\n            split:true\n        },\n        center: {\n            autoScroll:true\n        }\n    });\n    innerLayout.beginUpdate();\n    innerLayout.add(\"east\", new Roo.ContentPanel(\"dl-details\"));\n    innerLayout.add(\"center\", new Roo.ContentPanel(\"selection-panel\"));\n    innerLayout.endUpdate(true);\n\n    var layout = dialog.getLayout();\n    layout.beginUpdate();\n    layout.add(\"center\", new Roo.ContentPanel(\"standard-panel\",\n                        {title: \"Download the Source\", fitToFrame:true}));\n    layout.add(\"center\", new Roo.NestedLayoutPanel(innerLayout,\n               {title: \"Build your own roo.js\"}));\n    layout.getRegion(\"center\").showPanel(sp);\n    layout.endUpdate();\n}\n
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The default top page coordinate of the dialog (defaults to center screen)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "modal", + "type" : "Boolean", + "desc" : "True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "animateTarget", + "type" : "String/Element", + "desc" : "Id or element from which the dialog should animate while opening\n(defaults to null with no animation)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right\nshadow (defaults to false)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "collapsible", + "type" : "Boolean", + "desc" : "False to remove the built-in top-right corner collapse button (defaults to true)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "autoTabs", + "type" : "Boolean", + "desc" : "If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "shadowOffset", + "type" : "Number", + "desc" : "The number of pixels to offset the shadow if displayed (defaults to 5)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "buttons", + "type" : "Array", + "desc" : "Array of buttons", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "minButtonWidth", + "type" : "Number", + "desc" : "Minimum width of all dialog buttons (defaults to 75)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "Default text to display in the title bar (defaults to null)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum allowable width for a resizable dialog (defaults to 200)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "buttonAlign", + "type" : "String", + "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "Boolean/DomHelper", + "desc" : "True to auto create from scratch, or using a DomHelper Object (defaults to false)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "minHeight", + "type" : "Number", + "desc" : "The minimum allowable height for a resizable dialog (defaults to 80)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "proxyDrag", + "type" : "Boolean", + "desc" : "True to drag a lightweight proxy element rather than the dialog itself, used when\ndraggable = true (defaults to false)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "shim", + "type" : "Boolean", + "desc" : "True to create an iframe shim that prevents selects from showing through (defaults to false)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "Width of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "constraintoviewport", + "type" : "Boolean", + "desc" : "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "syncHeightBeforeShow", + "type" : "Boolean", + "desc" : "True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "tabTag", + "type" : "String", + "desc" : "The tag name of tab elements, used when autoTabs = true (defaults to 'div')", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "resizable", + "type" : "Boolean", + "desc" : "False to disable manual dialog resizing (defaults to true)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "False to remove the built-in top-right corner close button (defaults to true)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "fixedcenter", + "type" : "Boolean", + "desc" : "True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "Height of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "resizeHandles", + "type" : "String", + "desc" : "Which resize handles to display - see the {@link Roo.Resizable} handles config\nproperty for valid values (defaults to 'all')", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The default left page coordinate of the dialog (defaults to center screen)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + }, + { + "name" : "draggable", + "type" : "Boolean", + "desc" : "False to disable dragging of the dialog within the viewport (defaults to true)", + "memberOf" : "Roo.BasicDialog", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "addxtype", + "desc" : "Add an xtype element (actually adds to the layout.)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "xdata xtype object data." + } + ] + }, + { + "name" : "getLayout", + "desc" : "Get the BorderLayout for this dialog", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BorderLayout", + "desc" : "" + } + ] + }, + { + "name" : "endUpdate", + "desc" : "Ends update of the layout and resets display to none. Use standard beginUpdate/endUpdate on the layout.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutDialog", + "example" : "", + "deprecated" : "This has been deprecated: ", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "beginUpdate", + "desc" : "Begins an update of the layout and sets display to block and visibility to hidden. Use standard beginUpdate/endUpdate on the layout.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutDialog", + "example" : "", + "deprecated" : "This has been deprecated: ", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "expand", + "desc" : "Expands a collapsed dialog back to its normal state. Equivalent to the user\nclicking the expand dialog button.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "alignTo", + "desc" : "Aligns the dialog to the specified element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to.", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details).", + "isOptional" : false + }, + { + "name" : "offsets", + "type" : "Array", + "desc" : "(optional) Offset the positioning by [x, y]", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "setTitle", + "desc" : "Sets the dialog title text", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The title text to display", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if the dialog is visible", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "resizeTo", + "desc" : "Resizes the dialog.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "center", + "desc" : "Centers this dialog in the viewport", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "collapse", + "desc" : "Collapses the dialog to its minimized state (only the title bar is visible).\nEquivalent to the user clicking the collapse dialog button.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initTabs", + "desc" : "Reinitializes the tabs component, clearing out old tabs and finding new ones.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanel", + "desc" : "The tabs component" + } + ] + }, + { + "name" : "toFront", + "desc" : "Brings this dialog to the front of any other visible dialogs", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "moveTo", + "desc" : "Moves the dialog's top-left corner to the specified point", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "hide", + "desc" : "Hides the dialog.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Function to call when the dialog is hidden", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this dialog and all its supporting elements (including any tabs, shim,\nshadow, proxy, mask, etc.) Also removes all event listeners.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "removeEl", + "type" : "Boolean", + "desc" : "(optional) true to remove the element from the DOM", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Shows the dialog.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "animateTarget", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "(optional) Reset the animation target", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "anchorTo", + "desc" : "Anchors an element to another element and realigns it when the window is resized.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to.", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details)", + "isOptional" : false + }, + { + "name" : "offsets", + "type" : "Array", + "desc" : "(optional) Offset the positioning by [x, y]", + "isOptional" : false + }, + { + "name" : "monitorScroll", + "type" : "Boolean/Number", + "desc" : "(optional) true to monitor body scroll and reposition. If this parameter\nis a number, it is used as the buffer delay (defaults to 50ms).", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "addButton", + "desc" : "Adds a button to the footer section of the dialog.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "String/Object", + "desc" : "A string becomes the button text, an object can either be a Button config\nobject or a valid Roo.DomHelper element config", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The function called when the button is clicked", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the handler function (accepts position as a property)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Button", + "desc" : "The new button" + } + ] + }, + { + "name" : "addKeyListener", + "desc" : "Adds a key listener for when this dialog is displayed. This allows you to hook in a function that will be\nexecuted in response to a particular key being pressed while the dialog is active.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "key", + "type" : "Number/Array/Object", + "desc" : "Either the numeric key code, array of key codes or an object with the following options:\n {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Focuses the dialog. If a defaultButton is set, it will receive focus, otherwise the\ndialog itself will receive focus.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getTabs", + "desc" : "Returns the TabPanel component (creates it if it doesn't exist).\nNote: If you wish to simply check for the existence of tabs without creating them,\ncheck for a null 'tabs' property.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanel", + "desc" : "The tabs component" + } + ] + }, + { + "name" : "setDefaultButton", + "desc" : "Sets the default button to be focused when the dialog is displayed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "btn", + "type" : "Roo.BasicDialog.Button", + "desc" : "The button object returned by {@link #addButton}", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "toBack", + "desc" : "Sends this dialog to the back (under) of any other visible dialogs", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "setContentSize", + "desc" : "Resizes the dialog to fit the specified content size.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "restoreState", + "desc" : "Restores the previous state of the dialog if Roo.state is configured.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the element for this dialog", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The underlying dialog Element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "move", + "desc" : "Fires when this dialog is moved by the user.", + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.BasicDialog", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new page X", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new page Y", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires when this dialog is resized by the user.", + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.BasicDialog", + "desc" : "", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before this dialog is hidden.", + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.BasicDialog", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before this dialog is shown.", + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.BasicDialog", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires when this dialog is hidden.", + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.BasicDialog", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires when this dialog is shown.", + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.BasicDialog", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keydown", + "desc" : "Fires when a key is pressed", + "memberOf" : "Roo.BasicDialog", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.BasicDialog", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.LayoutManager.json b/docs2/symbols/Roo.LayoutManager.json new file mode 100644 index 0000000000..0a7edb125a --- /dev/null +++ b/docs2/symbols/Roo.LayoutManager.json @@ -0,0 +1,536 @@ +{ + "name" : "Roo.LayoutManager", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "Base class for layout managers.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getRegion", + "desc" : "Returns the specified region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.LayoutRegion", + "desc" : "" + } + ] + }, + { + "name" : "beginUpdate", + "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isUpdating", + "desc" : "Returns true if this layout is currently being updated", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getViewSize", + "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The size as an object {width: (the width), height: (the height)}" + } + ] + }, + { + "name" : "endUpdate", + "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "noLayout", + "type" : "Boolean", + "desc" : "true to disable a layout update", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns the Element this layout is bound to.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "layout", + "desc" : "Fires when a layout is performed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutManager", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "regionexpanded", + "desc" : "Fires when a region is expanded.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The expanded region", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "regionresized", + "desc" : "Fires when the user resizes a region.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The resized region", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size (width for east/west, height for north/south)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "regioncollapsed", + "desc" : "Fires when a region is collapsed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The collapsed region", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.LayoutRegion.json b/docs2/symbols/Roo.LayoutRegion.json new file mode 100644 index 0000000000..1774f13ba9 --- /dev/null +++ b/docs2/symbols/Roo.LayoutRegion.json @@ -0,0 +1,1231 @@ +{ + "name" : "Roo.LayoutRegion", + "augments" : [ + "Roo.BasicLayoutRegion", + "Roo.util.Observable" + ], + "desc" : "This class represents a region in a layout manager.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "cmargins", + "type" : "Object", + "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "alwaysShowTabs", + "type" : "Boolean", + "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "margins", + "type" : "Object", + "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "preferredTabWidth", + "type" : "Number", + "desc" : "The preferred tab width (defaults to 150)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "disableTabTips", + "type" : "Boolean", + "desc" : "True to disable tab tooltips", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "collapsible", + "type" : "Boolean", + "desc" : "False to disable collapsing (defaults to true)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "collapsedTitle", + "type" : "String", + "desc" : "Optional string message to display in the collapsed block of a north or south region", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to enable overflow scrolling (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to start the region hidden (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "toolbar", + "type" : "Boolean", + "desc" : "xtype configuration for a toolbar - shows on right of tabbar", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title for the region (overrides panel titles)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "hideWhenEmpty", + "type" : "Boolean", + "desc" : "True to hide the region when it has no panels", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "collapsed", + "type" : "Boolean", + "desc" : "True to set the initial display to collapsed (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "hideTabs", + "type" : "Boolean", + "desc" : "True to hide the tab strip (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "resizeTabs", + "type" : "Boolean", + "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "tabPosition", + "type" : "String", + "desc" : "\"top\" or \"bottom\" (defaults to \"bottom\")", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + "(top", + "bottom)" + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "For East/West panels", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "floatable", + "type" : "Boolean", + "desc" : "False to disable floating (defaults to true)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "minTabWidth", + "type" : "Number", + "desc" : "The minimum tab width (defaults to 40)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "split", + "type" : "Boolean", + "desc" : "To show the splitter", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "titlebar", + "type" : "Boolean", + "desc" : "True to display a title bar (defaults to true)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "preservePanels", + "type" : "Boolean", + "desc" : "True to preserve removed panels so they can be readded later (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "closeOnTab", + "type" : "Boolean", + "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "For North/South panels", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "animate", + "type" : "Boolean", + "desc" : "True to animate expand/collapse (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "autoHide", + "type" : "Boolean", + "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "showPin", + "type" : "Boolean", + "desc" : "True to show a pin button", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getEl", + "desc" : "Returns the container element for this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "remove", + "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + }, + { + "name" : "preservePanel", + "type" : "Boolean", + "desc" : "Overrides the config preservePanel option", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel that was removed" + } + ] + }, + { + "name" : "getActivePanel", + "desc" : "Get the active panel for this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The active panel or null" + } + ] + }, + { + "name" : "collapse", + "desc" : "Collapses this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "skipAnim", + "type" : "Boolean", + "desc" : "(optional) true to collapse the element without animation (if animate is true)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "unhidePanel", + "desc" : "Unhides the tab for a previously hidden panel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setCollapsedTitle", + "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getTabs", + "desc" : "Returns the TabPanel component used by this region", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanel", + "desc" : "" + } + ] + }, + { + "name" : "expand", + "desc" : "Expands this region if it was previously collapsed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event that triggered the expand (or null if calling manually)", + "isOptional" : false + }, + { + "name" : "skipAnim", + "type" : "Boolean", + "desc" : "(optional) true to expand the element without animation (if animate is true)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this region is currently visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "showPanel", + "desc" : "Shows the specified panel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panelId", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The shown panel, or null if a panel could not be found from panelId" + } + ] + }, + { + "name" : "hide", + "desc" : "Hides this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Shows this region if it was previously hidden.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "add", + "desc" : "Adds the passed ContentPanel(s) to this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "ContentPanel...", + "desc" : "The ContentPanel(s) to add (you can pass more than one)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel added (if only one was added; null otherwise)" + } + ] + }, + { + "name" : "hidePanel", + "desc" : "Hides the tab for the specified panel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hasPanel", + "desc" : "Returns true if the panel is in this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "resizeTo", + "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new width or height", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getPosition", + "desc" : "Returns this regions position (north/south/east/west/center).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "getPanel", + "desc" : "Returns the panel specified or null if it's not in this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "paneladded", + "desc" : "Fires when a panel is added.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalidated", + "desc" : "Fires when the layout for this region is changed.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "expanded", + "desc" : "Fires when this region is expanded.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeremove", + "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The cancel event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collapsed", + "desc" : "Fires when this region is collapsed.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "panelremoved", + "desc" : "Fires when a panel is removed.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforecollapse", + "desc" : "Fires when this region before collapse.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "slidehide", + "desc" : "Fires when this region slides out of view.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "visibilitychange", + "desc" : "Fires when this region is shown or hidden", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "visibility", + "type" : "Boolean", + "desc" : "true or false", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "slideshow", + "desc" : "Fires when this region is slid into view.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "panelactivated", + "desc" : "Fires when a panel is activated.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The activated panel", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resized", + "desc" : "Fires when the user resizes this region.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size (width for east/west, height for north/south)", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.LoadMask.json b/docs2/symbols/Roo.LoadMask.json new file mode 100644 index 0000000000..1220889519 --- /dev/null +++ b/docs2/symbols/Roo.LoadMask.json @@ -0,0 +1,71 @@ +{ + "name" : "Roo.LoadMask", + "augments" : [ + ], + "desc" : "A simple utility class for generically masking elements while loading data. If the element being masked has\nan underlying {@link Roo.data.Store}, the masking will be automatically synchronized with the store's loading\nprocess and the mask element will be cached for reuse. For all other elements, this mask will replace the\nelement's UpdateManager load indicator and will be destroyed after the initial load.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The text to display in a centered loading message box (defaults to 'Loading...')", + "memberOf" : "Roo.LoadMask", + "values" : [ + ] + }, + { + "name" : "removeMask", + "type" : "Boolean", + "desc" : "True to create a single-use mask that is automatically destroyed after loading (useful for page loads),\nFalse to persist the mask element reference for multiple uses (e.g., for paged data widgets). Defaults to false.", + "memberOf" : "Roo", + "values" : [ + ] + }, + { + "name" : "msgCls", + "type" : "String", + "desc" : "The CSS class to apply to the loading message element (defaults to \"x-mask-loading\")", + "memberOf" : "Roo.LoadMask", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "disable", + "desc" : "Disables the mask to prevent it from being displayed", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LoadMask", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Enables the mask so that it can be displayed", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LoadMask", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.MasterTemplate.json b/docs2/symbols/Roo.MasterTemplate.json new file mode 100644 index 0000000000..71060a4c76 --- /dev/null +++ b/docs2/symbols/Roo.MasterTemplate.json @@ -0,0 +1,461 @@ +{ + "name" : "Roo.MasterTemplate", + "augments" : [ + "Roo.Template" + ], + "desc" : "Provides a template that can have child templates. The syntax is:\n
\nvar t = new Roo.MasterTemplate(\n\t'<select name=\"{name}\">',\n\t\t'<tpl name=\"options\"><option value=\"{value:trim}\">{text:ellipsis(10)}</option></tpl>',\n\t'</select>'\n);\nt.add('options', {value: 'foo', text: 'bar'});\n// or you can add multiple child elements in one shot\nt.addAll('options', [\n    {value: 'foo', text: 'bar'},\n    {value: 'foo2', text: 'bar2'},\n    {value: 'foo3', text: 'bar3'}\n]);\n// then append, applying the master template values\nt.append('my-form', {name: 'my-select'});\n
\nA name attribute for the child template is not required if you have only one child\ntemplate or you want to refer to them by index.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "html", + "type" : "String", + "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")", + "memberOf" : "Roo.Template", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...", + "memberOf" : "Roo.Template", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "fill", + "desc" : "Applies all the passed values to a child template.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.MasterTemplate", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "name", + "type" : "String/Number", + "desc" : "(optional) The name or index of the child template", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Array", + "desc" : "The values to be applied to the template, this should be an array of objects.", + "isOptional" : false + }, + { + "name" : "reset", + "type" : "Boolean", + "desc" : "(optional) True to reset the template first", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "MasterTemplate", + "desc" : "this" + } + ] + }, + { + "name" : "add", + "desc" : "Applies the passed values to a child template.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.MasterTemplate", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "name", + "type" : "String/Number", + "desc" : "(optional) The name or index of the child template", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Array/Object", + "desc" : "The values to be applied to the template", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "MasterTemplate", + "desc" : "this" + } + ] + }, + { + "name" : "from", + "desc" : "Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML. e.g.\nvar tpl = Roo.MasterTemplate.from('element-id');", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.MasterTemplate", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement", + "desc" : "", + "isOptional" : false + }, + { + "name" : "config", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "reset", + "desc" : "Resets the template for reuse", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.MasterTemplate", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "MasterTemplate", + "desc" : "this" + } + ] + }, + { + "name" : "addAll", + "desc" : "Alias for fill().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.MasterTemplate", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "insertFirst", + "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "overwrite", + "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "insertBefore", + "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "applyTemplate", + "desc" : "Returns an HTML fragment of this template with the specified values applied.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The HTML fragment" + } + ] + }, + { + "name" : "compile", + "desc" : "Compiles the template into an internal function, eliminating the RegEx overhead.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Template", + "desc" : "this" + } + ] + }, + { + "name" : "set", + "desc" : "Sets the HTML used as the template and optionally compiles it.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "compile", + "type" : "Boolean", + "desc" : "(optional) True to compile the template (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Template", + "desc" : "this" + } + ] + }, + { + "name" : "insertAfter", + "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "append", + "desc" : "Applies the supplied values to the template and appends the new node(s) to el.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "apply", + "desc" : "Alias for {@link #applyTemplate}", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.NestedLayoutPanel.json b/docs2/symbols/Roo.NestedLayoutPanel.json new file mode 100644 index 0000000000..760f35dc05 --- /dev/null +++ b/docs2/symbols/Roo.NestedLayoutPanel.json @@ -0,0 +1,875 @@ +{ + "name" : "Roo.NestedLayoutPanel", + "augments" : [ + "Roo.ContentPanel", + "Roo.util.Observable" + ], + "desc" : "Create a new NestedLayoutPanel.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "fitToFrame", + "type" : "Boolean", + "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "background", + "type" : "Boolean", + "desc" : "True if the panel should not be activated when it is added (defaults to false)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "toolbar", + "type" : "Toolbar", + "desc" : "A toolbar for this panel", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "region", + "type" : "String", + "desc" : "which region to put this panel on (when used with xtype constructors)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + "(center", + "north", + "south", + "east", + "west)" + ] + }, + { + "name" : "content", + "type" : "String", + "desc" : "Raw content to fill content panel with (uses setContent on construction.)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title for this panel", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "fitContainer", + "type" : "Boolean", + "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "True if the panel can be closed/removed", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "adjustments", + "type" : "Array", + "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "Calls {@link #setUrl} with this value", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "resizeEl", + "type" : "String/HTMLElement/Element", + "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "addxtype", + "desc" : "Adds a xtype elements to the layout of the nested panel\n
\n\npanel.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\npanel.addxtype({\n        xtype : 'NestedLayoutPanel',\n        region: 'west',\n        layout: {\n           center: { },\n           west: { }   \n        },\n        items : [ ... list of content panels or nested layout panels.. ]\n   }\n);\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.NestedLayoutPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cfg", + "type" : "Object", + "desc" : "Xtype definition of item to add.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getLayout", + "desc" : "Returns the nested BorderLayout for this panel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.NestedLayoutPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BorderLayout", + "desc" : "" + } + ] + }, + { + "name" : "load", + "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "Object/String/Function", + "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n
\npanel.load({\n    url: \"your-url.php\",\n    params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n    callback: yourFunction,\n    scope: yourObject, //(optional scope)\n    discardUrl: false,\n    nocache: false,\n    text: \"Loading...\",\n    timeout: 30,\n    scripts: false\n});\n
\nThe only required property is url. The optional properties nocache, text and scripts\nare shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this panel UpdateManager instance.", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)", + "isOptional" : false + }, + { + "name" : "discardUrl", + "type" : "Boolean", + "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "this" + } + ] + }, + { + "name" : "getUpdateManager", + "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "isClosable", + "desc" : "Returns true is this panel was configured to be closable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this panel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns this panel's element - used by regiosn to add.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "setContent", + "desc" : "Updates this panel's element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "content", + "type" : "String", + "desc" : "The new content", + "isOptional" : false + }, + { + "name" : "loadScripts", + "type" : "Boolean", + "desc" : "(optional) true to look for and process scripts", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns this panel's id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "refresh", + "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getTitle", + "desc" : "Returns this panel's title", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "setTitle", + "desc" : "Set this panel's title", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getToolbar", + "desc" : "Returns the toolbar for this Panel if one was configured.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar", + "desc" : "" + } + ] + }, + { + "name" : "setUrl", + "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "String/Function", + "desc" : "The URL to load the content from or a function to call to get the URL", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)", + "isOptional" : false + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "deactivate", + "desc" : "Fires when this panel is activated.", + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires when this panel is resized if fitToFrame is true.", + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The width after any component adjustments", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The height after any component adjustments", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires when this tab is created", + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Fires when this panel is activated.", + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.PagingToolbar.json b/docs2/symbols/Roo.PagingToolbar.json new file mode 100644 index 0000000000..314453c61e --- /dev/null +++ b/docs2/symbols/Roo.PagingToolbar.json @@ -0,0 +1,482 @@ +{ + "name" : "Roo.PagingToolbar", + "augments" : [ + "Roo.Toolbar" + ], + "desc" : "A specialized toolbar that is bound to a {@link Roo.data.Store} and provides automatic paging controls.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "pageSize", + "type" : "Number", + "desc" : "The number of records to display per page (defaults to 20)", + "memberOf" : "Roo.PagingToolbar", + "values" : [ + ] + }, + { + "name" : "dataSource", + "type" : "Roo.data.Store", + "desc" : "The underlying data store providing the paged data", + "memberOf" : "Roo.PagingToolbar", + "values" : [ + ] + }, + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "container The id or element that will contain the toolbar", + "memberOf" : "Roo.PagingToolbar", + "values" : [ + ] + }, + { + "name" : "emptyMsg", + "type" : "String", + "desc" : "The message to display when no records are found (defaults to \"No data to display\")", + "memberOf" : "Roo.PagingToolbar", + "values" : [ + ] + }, + { + "name" : "items", + "type" : "Array", + "desc" : "array of button configs or elements to add (will be converted to a MixedCollection)", + "memberOf" : "Roo", + "values" : [ + ] + }, + { + "name" : "displayInfo", + "type" : "Boolean", + "desc" : "True to display the displayMsg (defaults to false)", + "memberOf" : "Roo.PagingToolbar", + "values" : [ + ] + }, + { + "name" : "displayMsg", + "type" : "String", + "desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")", + "memberOf" : "Roo.PagingToolbar", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "bind", + "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.PagingToolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "The data store to bind", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "unbind", + "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.PagingToolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "The data store to unbind", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addDom", + "desc" : "Adds a new element to the toolbar from the passed {@link Roo.DomHelper} config.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Item", + "desc" : "The element's item" + } + ] + }, + { + "name" : "addElement", + "desc" : "Adds any standard HTML element to the toolbar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The element or id of the element to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Item", + "desc" : "The element's item" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the Element for this toolbar.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide the toolbar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "addSeparator", + "desc" : "Adds a separator", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Item", + "desc" : "The separator item" + } + ] + }, + { + "name" : "show", + "desc" : "Show the toolbar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "addFill", + "desc" : "Adds a fill element that forces subsequent additions to the right side of the toolbar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Fill", + "desc" : "The fill item" + } + ] + }, + { + "name" : "addSpacer", + "desc" : "Adds a spacer element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Spacer", + "desc" : "The spacer item" + } + ] + }, + { + "name" : "add", + "desc" : "Adds element(s) to the toolbar -- this function takes a variable number of \narguments of mixed type and adds them to the toolbar.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "arg1", + "type" : "Mixed", + "desc" : "The following types of arguments are all valid:
\n
    \n
  • {@link Roo.Toolbar.Button} config: A valid button config object (equivalent to {@link #addButton})
  • \n
  • HtmlElement: Any standard HTML element (equivalent to {@link #addElement})
  • \n
  • Field: Any form field (equivalent to {@link #addField})
  • \n
  • Item: Any subclass of {@link Roo.Toolbar.Item} (equivalent to {@link #addItem})
  • \n
  • String: Any generic string (gets wrapped in a {@link Roo.Toolbar.TextItem}, equivalent to {@link #addText}).\nNote that there are a few special strings that are treated differently as explained nRoo.
  • \n
  • 'separator' or '-': Creates a separator element (equivalent to {@link #addSeparator})
  • \n
  • ' ': Creates a spacer element (equivalent to {@link #addSpacer})
  • \n
  • '->': Creates a fill element (equivalent to {@link #addFill})
  • \n
", + "isOptional" : false + }, + { + "name" : "arg2", + "type" : "Mixed", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addField", + "desc" : "Adds a dynamically rendered Roo.form field (TextField, ComboBox, etc).\nNote: the field should not have been rendered yet. For a field that has already been\nrendered, use {@link #addElement}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "field", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ToolbarItem", + "desc" : "" + } + ] + }, + { + "name" : "addText", + "desc" : "Adds text to the toolbar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The text to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Item", + "desc" : "The element's item" + } + ] + }, + { + "name" : "addItem", + "desc" : "Adds any Toolbar.Item or subclass", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.Toolbar.Item", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Item", + "desc" : "The item" + } + ] + }, + { + "name" : "addButton", + "desc" : "Adds a button (or buttons). See {@link Roo.Toolbar.Button} for more info on the config.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object/Array", + "desc" : "A button config or array of configs", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Button/Array", + "desc" : "" + } + ] + }, + { + "name" : "insertButton", + "desc" : "Inserts any {@link Roo.Toolbar.Item}/{@link Roo.Toolbar.Button} at the specified index.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index where the item is to be inserted", + "isOptional" : false + }, + { + "name" : "item", + "type" : "Object/Roo.Toolbar.Item/Roo.Toolbar.Button (may be Array)", + "desc" : "The button, or button config object to be inserted.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Button/Item", + "desc" : "" + } + ] + }, + { + "name" : "addxtype", + "desc" : "Add an Xtype element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "xtype", + "type" : "Object", + "desc" : "Xtype Object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "created Object" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.QuickTips.json b/docs2/symbols/Roo.QuickTips.json new file mode 100644 index 0000000000..7d3f0780a4 --- /dev/null +++ b/docs2/symbols/Roo.QuickTips.json @@ -0,0 +1,243 @@ +{ + "name" : "Roo.QuickTips", + "augments" : [ + ], + "desc" : "Provides attractive and customizable tooltips for any element.", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "showDelay", + "type" : "Number", + "desc" : "Delay in milliseconds before the quick tip displays after the mouse enters the target element (defaults to 500)", + "memberOf" : "Roo.QuickTips", + "values" : [ + ] + }, + { + "name" : "maxWidth", + "type" : "Number", + "desc" : "The maximum width of the quick tip (defaults to 300)", + "memberOf" : "Roo.QuickTips", + "values" : [ + ] + }, + { + "name" : "Delay", + "type" : "Number", + "desc" : "in milliseconds before the quick tip hides when autoDismiss = true (defaults to 5000)", + "memberOf" : "Roo.QuickTips", + "values" : [ + ] + }, + { + "name" : "text", + "type" : "String", + "desc" : "Body text to display (defaults to ''). This can be any valid HTML markup.", + "memberOf" : "Roo.QuickTips", + "values" : [ + ] + }, + { + "name" : "hideOnClick", + "type" : "Boolean", + "desc" : "True to hide the quick tip if the user clicks anywhere in the document (defaults to true)", + "memberOf" : "Roo.QuickTips", + "values" : [ + ] + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum width of the quick tip (defaults to 40)", + "memberOf" : "Roo.QuickTips", + "values" : [ + ] + }, + { + "name" : "hideDelay", + "type" : "Number", + "desc" : "Delay in milliseconds before the quick tip hides when autoHide = true (defaults to 200)", + "memberOf" : "Roo.QuickTips", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "Title text to display (defaults to ''). This can be any valid HTML markup.", + "memberOf" : "Roo.QuickTips", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the base quick tip element (defaults to '').", + "memberOf" : "Roo.QuickTips", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "Width in pixels of the quick tip (defaults to auto). Width will be ignored if it exceeds the bounds of\nminWidth or maxWidth.", + "memberOf" : "Roo.QuickTips", + "values" : [ + ] + }, + { + "name" : "interceptTitles", + "type" : "Boolean", + "desc" : "True to automatically use the element's DOM title value if available (defaults to false)", + "memberOf" : "Roo.QuickTips", + "values" : [ + ] + }, + { + "name" : "trackMouse", + "type" : "Boolean", + "desc" : "True to have the quick tip follow the mouse as it moves over the target element (defaults to false)", + "memberOf" : "Roo.QuickTips", + "values" : [ + ] + }, + { + "name" : "True", + "type" : "Boolean", + "desc" : "to automatically hide the quick tip after a set period of time, regardless of the user's actions\n(defaults to true). Used in conjunction with autoDismissDelay.", + "memberOf" : "Roo.QuickTips", + "values" : [ + ] + }, + { + "name" : "animate", + "type" : "Boolean", + "desc" : "True to turn on fade animation. Defaults to false (ClearType/scrollbar flicker issues in IE7).", + "memberOf" : "Roo.QuickTips", + "values" : [ + ] + }, + { + "name" : "autoHide", + "type" : "Boolean", + "desc" : "True to automatically hide the quick tip after the mouse exits the target element (defaults to true).\nUsed in conjunction with hideDelay.", + "memberOf" : "Roo.QuickTips", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "isEnabled", + "desc" : "Returns true if the quick tip is enabled, else false.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.QuickTips", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Disable this quick tip.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.QuickTips", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "unregister", + "desc" : "Removes this quick tip from its element and destroys it.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.QuickTips", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The element from which the quick tip is to be removed.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Enable this quick tip.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.QuickTips", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "init", + "desc" : "Initialize and enable QuickTips for first use. This should be called once before the first attempt to access\nor display QuickTips in a page.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.QuickTips", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "register", + "desc" : "Configures a new quick tip instance and assigns it to a target element. The following config options\nare supported:\n
\nProperty    Type                   Description\n----------  ---------------------  ------------------------------------------------------------------------\ntarget      Element/String/Array   An Element, id or array of ids that this quick tip should be tied to\n",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.QuickTips",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "config",
+          "type" : "Object",
+          "desc" : "The config object",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    }
+  ],
+  "events" : [
+  ]
+}
\ No newline at end of file
diff --git a/docs2/symbols/Roo.ReaderLayout.json b/docs2/symbols/Roo.ReaderLayout.json
new file mode 100644
index 0000000000..8287963002
--- /dev/null
+++ b/docs2/symbols/Roo.ReaderLayout.json
@@ -0,0 +1,801 @@
+{
+  "name" : "Roo.ReaderLayout",
+  "augments" : [
+    "Roo.BorderLayout",
+    "Roo.LayoutManager",
+    "Roo.util.Observable"
+  ],
+  "desc" : "This is a pre-built layout that represents a classic, 5-pane application.  It consists of a header, a primary\ncenter region containing two nested regions (a top one for a list view and one for item preview below),\nand regions on either side that can be used for navigation, application commands, informational displays, etc.\nThe setup and configuration work exactly the same as it does for a {@link Roo.BorderLayout} - this class simply\nexpedites the setup of the overall layout and regions for this common application style.\nExample:\n 
\nvar reader = new Roo.ReaderLayout();\nvar CP = Roo.ContentPanel;  // shortcut for adding\n\nreader.beginUpdate();\nreader.add(\"north\", new CP(\"north\", \"North\"));\nreader.add(\"west\", new CP(\"west\", {title: \"West\"}));\nreader.add(\"east\", new CP(\"east\", {title: \"East\"}));\n\nreader.regions.listView.add(new CP(\"listView\", \"List\"));\nreader.regions.preview.add(new CP(\"preview\", \"Preview\"));\nreader.endUpdate();\n
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "create", + "desc" : "Shortcut for creating a new BorderLayout object and adding one or more ContentPanels to it in a single step, handling\nthe beginUpdate and endUpdate calls internally. The key to this method is the panels property that can be\nprovided with each region config, which allows you to add ContentPanel configs in addition to the region configs\nduring creation. The following code is equivalent to the constructor-based example at the beginning of this class:\n
\n// shorthand\nvar CP = Roo.ContentPanel;\n\nvar layout = Roo.BorderLayout.create({\n    north: {\n        initialSize: 25,\n        titlebar: false,\n        panels: [new CP(\"north\", \"North\")]\n    },\n    west: {\n        split:true,\n        initialSize: 200,\n        minSize: 175,\n        maxSize: 400,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"west\", {title: \"West\"})]\n    },\n    east: {\n        split:true,\n        initialSize: 202,\n        minSize: 175,\n        maxSize: 400,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"autoTabs\", {title: \"Auto Tabs\", closable: true})]\n    },\n    south: {\n        split:true,\n        initialSize: 100,\n        minSize: 100,\n        maxSize: 200,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"south\", {title: \"South\", closable: true})]\n    },\n    center: {\n        titlebar: true,\n        autoScroll:true,\n        resizeTabs: true,\n        minTabWidth: 50,\n        preferredTabWidth: 150,\n        panels: [\n            new CP(\"center1\", {title: \"Close Me\", closable: true}),\n            new CP(\"center2\", {title: \"Center Panel\", closable: false})\n        ]\n    }\n}, document.body);\n\nlayout.getRegion(\"center\").showPanel(\"center1\");\n
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "", + "desc" : "", + "isOptional" : false + }, + { + "name" : "targetEl", + "type" : "", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "restoreState", + "desc" : "Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "provider", + "type" : "Roo.state.Provider", + "desc" : "(optional) An alternate state provider", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addRegion", + "desc" : "Creates and adds a new region if it doesn't already exist.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The target region key (north, south, east, west or center).", + "isOptional" : false + }, + { + "name" : "config", + "type" : "Object", + "desc" : "The regions config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BorderLayoutRegion", + "desc" : "The new region" + } + ] + }, + { + "name" : "showPanel", + "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panelId", + "type" : "String/ContentPanel", + "desc" : "The panels id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The shown panel or null" + } + ] + }, + { + "name" : "batchAdd", + "desc" : "Adds a batch of multiple ContentPanels dynamically by passing a special regions config object. This config\nobject should contain properties for each region to add ContentPanels to, and each property's value should be\na valid ContentPanel config object. Example:\n
\n// Create the main layout\nvar layout = new Roo.BorderLayout('main-ct', {\n    west: {\n        split:true,\n        minSize: 175,\n        titlebar: true\n    },\n    center: {\n        title:'Components'\n    }\n}, 'main-ct');\n\n// Create and add multiple ContentPanels at once via configs\nlayout.batchAdd({\n   west: {\n       id: 'source-files',\n       autoCreate:true,\n       title:'Ext Source Files',\n       autoScroll:true,\n       fitToFrame:true\n   },\n   center : {\n       el: cview,\n       autoScroll:true,\n       fitToFrame:true,\n       toolbar: tb,\n       resizeEl:'cbody'\n   }\n});\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "regions", + "type" : "Object", + "desc" : "An object containing ContentPanel configs by region name", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Remove a ContentPanel (or subclass) to this layout.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The target region key (north, south, east, west or center).", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Number/String/Roo.ContentPanel", + "desc" : "The index, id or panel to remove", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The removed panel" + } + ] + }, + { + "name" : "findPanel", + "desc" : "Searches all regions for a panel with the specified id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panelId", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel or null if it wasn't found" + } + ] + }, + { + "name" : "layout", + "desc" : "Performs a layout update.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "addxtype", + "desc" : "Adds a xtype elements to the layout.\n
\n\nlayout.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\nlayout.addxtype({\n        xtype : 'NestedLayoutPanel',\n        region: 'west',\n        layout: {\n           center: { },\n           west: { }   \n        },\n        items : [ ... list of content panels or nested layout panels.. ]\n   }\n);\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cfg", + "type" : "Object", + "desc" : "Xtype definition of item to add.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "add", + "desc" : "Adds a ContentPanel (or subclass) to this layout.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BorderLayout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The target region key (north, south, east, west or center).", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The added panel" + } + ] + }, + { + "name" : "getRegion", + "desc" : "Returns the specified region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.LayoutRegion", + "desc" : "" + } + ] + }, + { + "name" : "beginUpdate", + "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isUpdating", + "desc" : "Returns true if this layout is currently being updated", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getViewSize", + "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The size as an object {width: (the width), height: (the height)}" + } + ] + }, + { + "name" : "endUpdate", + "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "noLayout", + "type" : "Boolean", + "desc" : "true to disable a layout update", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns the Element this layout is bound to.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "layout", + "desc" : "Fires when a layout is performed.", + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutManager", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "regionexpanded", + "desc" : "Fires when a region is expanded.", + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The expanded region", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "regionresized", + "desc" : "Fires when the user resizes a region.", + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The resized region", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size (width for east/west, height for north/south)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "regioncollapsed", + "desc" : "Fires when a region is collapsed.", + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The collapsed region", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Resizable.json b/docs2/symbols/Roo.Resizable.json new file mode 100644 index 0000000000..2110f29114 --- /dev/null +++ b/docs2/symbols/Roo.Resizable.json @@ -0,0 +1,745 @@ +{ + "name" : "Roo.Resizable", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "

Applies drag handles to an element to make it resizable. The drag handles are inserted into the element\nand positioned absolute. Some elements, such as a textarea or image, don't support this. To overcome that, you can wrap\nthe textarea in a div and set \"resizeChild\" to true (or to the id of the element), or set wrap:true in your config and\nthe element will be wrapped for you automatically.

\n

Here is the list of valid resize handles:

\n
\nValue   Description\n------  -------------------\n 'n'     north\n 's'     south\n 'e'     east\n 'w'     west\n 'nw'    northwest\n 'sw'    southwest\n 'se'    southeast\n 'ne'    northeast\n 'hd'    horizontal drag\n 'all'   all\n
\n

Here's an example showing the creation of a typical Resizable:

\n
\nvar resizer = new Roo.Resizable(\"element-id\", {\n    handles: 'all',\n    minWidth: 200,\n    minHeight: 100,\n    maxWidth: 500,\n    maxHeight: 400,\n    pinned: true\n});\nresizer.on(\"resize\", myHandler);\n
\n

To hide a particular handle, set its display to none in CSS, or through script:
\nresizer.east.setDisplayed(false);

", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "easing", + "type" : "String", + "desc" : "Animation easing if animate = true (defaults to 'easingOutStrong')", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "maxWidth", + "type" : "Number", + "desc" : "The maximum width for the element (defaults to 10000)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum width for the element (defaults to 5)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "dynamic", + "type" : "Boolean", + "desc" : "True to resize the element while dragging instead of using a proxy (defaults to false)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "pinned", + "type" : "Boolean", + "desc" : "True to ensure that the resize handles are always visible, false to display them only when the\nuser mouses over the resizable borders. This is only applied at config time. (defaults to false)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "enabled", + "type" : "Boolean", + "desc" : "False to disable resizing (defaults to true)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "handles", + "type" : "String", + "desc" : "String consisting of the resize handles to display (defaults to undefined)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "preserveRatio", + "type" : "Boolean", + "desc" : "True to preserve the original ratio between height and width during resize (defaults to false)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "minHeight", + "type" : "Number", + "desc" : "The minimum height for the element (defaults to 5)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "maxHeight", + "type" : "Number", + "desc" : "The maximum height for the element (defaults to 10000)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "widthIncrement", + "type" : "Number", + "desc" : "The increment to snap the width resize in pixels (dynamic must be true, defaults to 0)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "resizeChild", + "type" : "Boolean/String/Element", + "desc" : "True to resize the first child, or id/element to resize (defaults to false)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The width of the element in pixels (defaults to null)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "transparent", + "type" : "Boolean", + "desc" : "True for transparent handles. This is only applied at config time. (defaults to false)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "minX", + "type" : "Number", + "desc" : "The minimum allowed page X for the element (only used for west resizing, defaults to 0)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "constrainTo", + "type" : "String/HTMLElement/Element", + "desc" : "Constrain the resize to a particular element", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "disableTrackOver", + "type" : "Boolean", + "desc" : "True to disable mouse tracking. This is only applied at config time. (defaults to false)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "minY", + "type" : "Number", + "desc" : "The minimum allowed page Y for the element (only used for north resizing, defaults to 0)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "adjustments", + "type" : "Array/String", + "desc" : "String \"auto\" or an array [width, height] with values to be added to the\nresize operation's new size (defaults to [0, 0])", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "wrap", + "type" : "Boolean", + "desc" : "True to wrap an element with a div if needed (required for textareas and images, defaults to false)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The height of the element in pixels (defaults to null)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "duration", + "type" : "Number", + "desc" : "Animation duration if animate = true (defaults to .35)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "animate", + "type" : "Boolean", + "desc" : "True to animate the resize (not compatible with dynamic sizing, defaults to false)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "multiDirectional", + "type" : "Boolean", + "desc" : "Deprecated. The old style of adding multi-direction resize handles, deprecated\nin favor of the handles config option (defaults to false)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "heightIncrement", + "type" : "Number", + "desc" : "The increment to snap the height resize in pixels (dynamic must be true, defaults to 0)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "draggable", + "type" : "Boolean", + "desc" : "Convenience to initialize drag drop (defaults to false)", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + }, + { + "name" : "resizeRegion", + "type" : "Roo.lib.Region", + "desc" : "Constrain the resize to a particular region", + "memberOf" : "Roo.Resizable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getEl", + "desc" : "Returns the element this component is bound to.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Resizable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "getResizeChild", + "desc" : "Returns the resizeChild element (or null).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Resizable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this resizable. If the element was wrapped and\nremoveEl is not true then the element remains.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Resizable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "removeEl", + "type" : "Boolean", + "desc" : "(optional) true to remove the element from the DOM", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resizeTo", + "desc" : "Perform a manual resize", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Resizable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "resize", + "desc" : "Fired after a resize.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Resizable", + "desc" : "", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resizing", + "desc" : "Fired a resizing.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Resizable", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + }, + { + "name" : "w", + "type" : "Number", + "desc" : "The new w width", + "isOptional" : false + }, + { + "name" : "h", + "type" : "Number", + "desc" : "The new h hight", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeresize", + "desc" : "Fired before resize is allowed. Set enabled to false to cancel resize.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Resizable", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The mousedown event", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Shadow.json b/docs2/symbols/Roo.Shadow.json new file mode 100644 index 0000000000..5b0c4e0615 --- /dev/null +++ b/docs2/symbols/Roo.Shadow.json @@ -0,0 +1,147 @@ +{ + "name" : "Roo.Shadow", + "augments" : [ + ], + "desc" : "Simple class that can provide a shadow effect for any element. Note that the element MUST be absolutely positioned,\nand the shadow does not provide any shimming. This should be used only in simple cases -- for more advanced\nfunctionality that can also provide the same shadow effect, see the {@link Roo.Layer} class.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "offset", + "type" : "String", + "desc" : "The number of pixels to offset the shadow from the element (defaults to 4)", + "memberOf" : "Roo.Shadow", + "values" : [ + ] + }, + { + "name" : "mode", + "type" : "String", + "desc" : "The shadow display mode. Supports the following options:
\nsides: Shadow displays on both sides and bottom only
\nframe: Shadow displays equally on all four sides
\ndrop: Traditional bottom-right drop shadow (default)", + "memberOf" : "Roo", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "setZIndex", + "desc" : "Adjust the z-index of this shadow", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Shadow", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "zindex", + "type" : "Number", + "desc" : "The new z-index", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if the shadow is visible, else false", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Shadow", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hides this shadow", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Shadow", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Displays the shadow under the target element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Shadow", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "targetEl", + "type" : "String/HTMLElement/Element", + "desc" : "The id or element under which the shadow should display", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "realign", + "desc" : "Direct alignment when values are already available. Show must be called at least once before\ncalling this method to ensure it is initialized.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Shadow", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The target element left position", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The target element top position", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The target element width", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The target element height", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.SplitBar.AbsoluteLayoutAdapter.json b/docs2/symbols/Roo.SplitBar.AbsoluteLayoutAdapter.json new file mode 100644 index 0000000000..84d1fb2682 --- /dev/null +++ b/docs2/symbols/Roo.SplitBar.AbsoluteLayoutAdapter.json @@ -0,0 +1,72 @@ +{ + "name" : "Roo.SplitBar.AbsoluteLayoutAdapter", + "augments" : [ + "Roo.SplitBar.BasicLayoutAdapter" + ], + "desc" : "Adapter that moves the splitter element to align with the resized sizing element. \nUsed with an absolute positioned SplitBar.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "setElementSize", + "desc" : "Called after drag operations to set the size of the resizing element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitBar.BasicLayoutAdapter", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "s", + "type" : "Roo.SplitBar", + "desc" : "The SplitBar using this adapter", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size to set", + "isOptional" : false + }, + { + "name" : "onComplete", + "type" : "Function", + "desc" : "A function to be invoked when resizing is complete", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getElementSize", + "desc" : "Called before drag operations to get the current size of the resizing element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitBar.BasicLayoutAdapter", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "s", + "type" : "Roo.SplitBar", + "desc" : "The SplitBar using this adapter", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.SplitBar.BasicLayoutAdapter.json b/docs2/symbols/Roo.SplitBar.BasicLayoutAdapter.json new file mode 100644 index 0000000000..966f0044e7 --- /dev/null +++ b/docs2/symbols/Roo.SplitBar.BasicLayoutAdapter.json @@ -0,0 +1,71 @@ +{ + "name" : "Roo.SplitBar.BasicLayoutAdapter", + "augments" : [ + ], + "desc" : "Default Adapter. It assumes the splitter and resizing element are not positioned\nelements and only gets/sets the width of the element. Generally used for table based layouts.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "setElementSize", + "desc" : "Called after drag operations to set the size of the resizing element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitBar.BasicLayoutAdapter", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "s", + "type" : "Roo.SplitBar", + "desc" : "The SplitBar using this adapter", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size to set", + "isOptional" : false + }, + { + "name" : "onComplete", + "type" : "Function", + "desc" : "A function to be invoked when resizing is complete", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getElementSize", + "desc" : "Called before drag operations to get the current size of the resizing element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitBar.BasicLayoutAdapter", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "s", + "type" : "Roo.SplitBar", + "desc" : "The SplitBar using this adapter", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.SplitBar.json b/docs2/symbols/Roo.SplitBar.json new file mode 100644 index 0000000000..dab260433a --- /dev/null +++ b/docs2/symbols/Roo.SplitBar.json @@ -0,0 +1,568 @@ +{ + "name" : "Roo.SplitBar", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "Creates draggable splitter bar functionality from two elements (element to be dragged and element to be resized).\n

\nUsage:\n
\nvar split = new Roo.SplitBar(\"elementToDrag\", \"elementToSize\",\n                   Roo.SplitBar.HORIZONTAL, Roo.SplitBar.LEFT);\nsplit.setAdapter(new Roo.SplitBar.AbsoluteLayoutAdapter(\"container\"));\nsplit.minSize = 100;\nsplit.maxSize = 600;\nsplit.animate = true;\nsplit.on('moved', splitterMoved);\n
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getAdapter", + "desc" : "Get the adapter this SplitBar uses", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitBar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "The adapter object" + } + ] + }, + { + "name" : "setMaximumSize", + "desc" : "Sets the maximum size for the resizing element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitBar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "maxSize", + "type" : "Number", + "desc" : "The maximum size", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setCurrentSize", + "desc" : "Sets the initialize size for the resizing element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitBar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "size", + "type" : "Number", + "desc" : "The initial size", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroy this splitbar.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitBar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "removeEl", + "type" : "Boolean", + "desc" : "True to remove the element", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setMinimumSize", + "desc" : "Sets the minimum size for the resizing element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitBar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "minSize", + "type" : "Number", + "desc" : "The minimum size", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getMinimumSize", + "desc" : "Gets the minimum size for the resizing element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitBar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The minimum size" + } + ] + }, + { + "name" : "getMaximumSize", + "desc" : "Gets the maximum size for the resizing element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitBar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The maximum size" + } + ] + }, + { + "name" : "setAdapter", + "desc" : "Set the adapter this SplitBar uses", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitBar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adapter", + "type" : "Object", + "desc" : "A SplitBar adapter object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "resize", + "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.SplitBar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "the new width or height", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeresize", + "desc" : "Fires before the splitter is dragged", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.SplitBar", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "moved", + "desc" : "Fires when the splitter is moved", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.SplitBar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "the new width or height", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.SplitButton.json b/docs2/symbols/Roo.SplitButton.json new file mode 100644 index 0000000000..be623dd6c2 --- /dev/null +++ b/docs2/symbols/Roo.SplitButton.json @@ -0,0 +1,953 @@ +{ + "name" : "Roo.SplitButton", + "augments" : [ + "Roo.Button", + "Roo.util.Observable" + ], + "desc" : "A split button that provides a built-in dropdown arrow that can fire an event separately from the default\nclick event of the button. Typically this would be used to display a dropdown menu that provides additional\noptions to the primary button action, but any custom handler can provide the arrowclick implementation.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "String/Object", + "desc" : "The tooltip for the button - can be a string or QuickTips config object", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "text", + "type" : "String", + "desc" : "The button text", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "renderTo", + "type" : "String/HTMLElement/Element", + "desc" : "The element to append the button to", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to start hidden (defaults to false)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "toggleGroup", + "type" : "String", + "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "handleMouseEvents", + "type" : "Boolean", + "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "menu", + "type" : "Mixed", + "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "enableToggle", + "type" : "Boolean", + "desc" : "True to enable pressed/not pressed toggling (defaults to false)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "arrowHandler", + "type" : "Function", + "desc" : "A function called when the arrow button is clicked (can be used instead of click event)", + "memberOf" : "Roo.SplitButton", + "values" : [ + ] + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function called when the button is clicked (can be used instead of click event)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "The scope of the handler", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum width for this button (used to give a set of buttons a common width)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to start disabled (defaults to false)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "pressed", + "type" : "Boolean", + "desc" : "True to start pressed (only if enableToggle = true)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "template", + "type" : "Roo.Template", + "desc" : "(Optional)\nAn {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the button's main element.", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The DOM tabIndex for this button (defaults to undefined)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "iconCls", + "type" : "String", + "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "menuAlign", + "type" : "String", + "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "icon", + "type" : "String", + "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "tooltipType", + "type" : "String", + "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "arrowTooltip", + "type" : "String", + "desc" : "The title attribute of the arrow", + "memberOf" : "Roo.SplitButton", + "values" : [ + ] + }, + { + "name" : "clickEvent", + "type" : "String", + "desc" : "The type of event to map to the button's event handler (defaults to 'click')", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "repeat", + "type" : "Boolean/Object", + "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "type", + "type" : "String", + "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).", + "memberOf" : "Roo.Button", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "setArrowHandler", + "desc" : "Sets this button's arrow click handler", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitButton", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "handler", + "type" : "Function", + "desc" : "The function to call when the arrow is clicked", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) Scope for the function passed above", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Focus the button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitButton", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setHandler", + "desc" : "Sets this button's click handler", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitButton", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "handler", + "type" : "Function", + "desc" : "The function to call when the button is clicked", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) Scope for the function passed above", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Disable this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Enable this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns the button's underlying element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for boolean enable/disable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "enabled", + "type" : "Boolean", + "desc" : "True to enable, false to disable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function for boolean show/hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this Button and removes any listeners.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getText", + "desc" : "Gets the text for this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The button text" + } + ] + }, + { + "name" : "setText", + "desc" : "Sets this button's text", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The button text", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toggle", + "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "state", + "type" : "Boolean", + "desc" : "(optional) Force a particular state", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "arrowclick", + "desc" : "Fires when this button's arrow is clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SplitButton", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "EventObject", + "desc" : "The click event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires when the button is rendered", + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fires when this button is clicked", + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "EventObject", + "desc" : "The click event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseover", + "desc" : "Fires when the mouse hovers over the button", + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toggle", + "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)", + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "pressed", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseout", + "desc" : "Fires when the mouse exits the button", + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.SplitLayoutRegion.json b/docs2/symbols/Roo.SplitLayoutRegion.json new file mode 100644 index 0000000000..d16ccd3e3f --- /dev/null +++ b/docs2/symbols/Roo.SplitLayoutRegion.json @@ -0,0 +1,1253 @@ +{ + "name" : "Roo.SplitLayoutRegion", + "augments" : [ + "Roo.LayoutRegion", + "Roo.BasicLayoutRegion", + "Roo.util.Observable" + ], + "desc" : "Adds a splitbar and other (private) useful functionality to a {@link Roo.LayoutRegion}.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "cmargins", + "type" : "Object", + "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "alwaysShowTabs", + "type" : "Boolean", + "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "margins", + "type" : "Object", + "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "preferredTabWidth", + "type" : "Number", + "desc" : "The preferred tab width (defaults to 150)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "disableTabTips", + "type" : "Boolean", + "desc" : "True to disable tab tooltips", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "collapsible", + "type" : "Boolean", + "desc" : "False to disable collapsing (defaults to true)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "collapsedTitle", + "type" : "String", + "desc" : "Optional string message to display in the collapsed block of a north or south region", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to enable overflow scrolling (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to start the region hidden (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "toolbar", + "type" : "Boolean", + "desc" : "xtype configuration for a toolbar - shows on right of tabbar", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title for the region (overrides panel titles)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "hideWhenEmpty", + "type" : "Boolean", + "desc" : "True to hide the region when it has no panels", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "collapsed", + "type" : "Boolean", + "desc" : "True to set the initial display to collapsed (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "hideTabs", + "type" : "Boolean", + "desc" : "True to hide the tab strip (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "resizeTabs", + "type" : "Boolean", + "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "tabPosition", + "type" : "String", + "desc" : "\"top\" or \"bottom\" (defaults to \"bottom\")", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + "(top", + "bottom)" + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "For East/West panels", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "floatable", + "type" : "Boolean", + "desc" : "False to disable floating (defaults to true)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "minTabWidth", + "type" : "Number", + "desc" : "The minimum tab width (defaults to 40)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "split", + "type" : "Boolean", + "desc" : "To show the splitter", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "titlebar", + "type" : "Boolean", + "desc" : "True to display a title bar (defaults to true)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "preservePanels", + "type" : "Boolean", + "desc" : "True to preserve removed panels so they can be readded later (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "closeOnTab", + "type" : "Boolean", + "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "For North/South panels", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "animate", + "type" : "Boolean", + "desc" : "True to animate expand/collapse (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "autoHide", + "type" : "Boolean", + "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "showPin", + "type" : "Boolean", + "desc" : "True to show a pin button", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getSplitBar", + "desc" : "Returns the {@link Roo.SplitBar} for this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.SplitBar", + "desc" : "" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the container element for this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "remove", + "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + }, + { + "name" : "preservePanel", + "type" : "Boolean", + "desc" : "Overrides the config preservePanel option", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel that was removed" + } + ] + }, + { + "name" : "getActivePanel", + "desc" : "Get the active panel for this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The active panel or null" + } + ] + }, + { + "name" : "collapse", + "desc" : "Collapses this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "skipAnim", + "type" : "Boolean", + "desc" : "(optional) true to collapse the element without animation (if animate is true)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "unhidePanel", + "desc" : "Unhides the tab for a previously hidden panel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setCollapsedTitle", + "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getTabs", + "desc" : "Returns the TabPanel component used by this region", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanel", + "desc" : "" + } + ] + }, + { + "name" : "expand", + "desc" : "Expands this region if it was previously collapsed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event that triggered the expand (or null if calling manually)", + "isOptional" : false + }, + { + "name" : "skipAnim", + "type" : "Boolean", + "desc" : "(optional) true to expand the element without animation (if animate is true)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this region is currently visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "showPanel", + "desc" : "Shows the specified panel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panelId", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The shown panel, or null if a panel could not be found from panelId" + } + ] + }, + { + "name" : "hide", + "desc" : "Hides this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Shows this region if it was previously hidden.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "add", + "desc" : "Adds the passed ContentPanel(s) to this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "ContentPanel...", + "desc" : "The ContentPanel(s) to add (you can pass more than one)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel added (if only one was added; null otherwise)" + } + ] + }, + { + "name" : "hidePanel", + "desc" : "Hides the tab for the specified panel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hasPanel", + "desc" : "Returns true if the panel is in this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "resizeTo", + "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new width or height", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getPosition", + "desc" : "Returns this regions position (north/south/east/west/center).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "getPanel", + "desc" : "Returns the panel specified or null if it's not in this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "paneladded", + "desc" : "Fires when a panel is added.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalidated", + "desc" : "Fires when the layout for this region is changed.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "expanded", + "desc" : "Fires when this region is expanded.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeremove", + "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The cancel event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collapsed", + "desc" : "Fires when this region is collapsed.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "panelremoved", + "desc" : "Fires when a panel is removed.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforecollapse", + "desc" : "Fires when this region before collapse.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "slidehide", + "desc" : "Fires when this region slides out of view.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "visibilitychange", + "desc" : "Fires when this region is shown or hidden", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "visibility", + "type" : "Boolean", + "desc" : "true or false", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "slideshow", + "desc" : "Fires when this region is slid into view.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "panelactivated", + "desc" : "Fires when a panel is activated.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The activated panel", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resized", + "desc" : "Fires when the user resizes this region.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size (width for east/west, height for north/south)", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.TabPanel.json b/docs2/symbols/Roo.TabPanel.json new file mode 100644 index 0000000000..23727e8891 --- /dev/null +++ b/docs2/symbols/Roo.TabPanel.json @@ -0,0 +1,769 @@ +{ + "name" : "Roo.TabPanel", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "A lightweight tab container.\n

\nUsage:\n
\n// basic tabs 1, built from existing content\nvar tabs = new Roo.TabPanel(\"tabs1\");\ntabs.addTab(\"script\", \"View Script\");\ntabs.addTab(\"markup\", \"View Markup\");\ntabs.activate(\"script\");\n\n// more advanced tabs, built from javascript\nvar jtabs = new Roo.TabPanel(\"jtabs\");\njtabs.addTab(\"jtabs-1\", \"Normal Tab\", \"My content was added during construction.\");\n\n// set up the UpdateManager\nvar tab2 = jtabs.addTab(\"jtabs-2\", \"Ajax Tab 1\");\nvar updater = tab2.getUpdateManager();\nupdater.setDefaultUrl(\"ajax1.htm\");\ntab2.on('activate', updater.refresh, updater, true);\n\n// Use setUrl for Ajax loading\nvar tab3 = jtabs.addTab(\"jtabs-3\", \"Ajax Tab 2\");\ntab3.setUrl(\"ajax2.htm\", null, true);\n\n// Disabled tab\nvar tab4 = jtabs.addTab(\"tabs1-5\", \"Disabled Tab\", \"Can't see me cause I'm disabled\");\ntab4.disable();\n\njtabs.activate(\"jtabs-1\");\n
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getActiveTab", + "desc" : "Gets the active {@link Roo.TabPanelItem}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanelItem", + "desc" : "The active TabPanelItem or null if none are active." + } + ] + }, + { + "name" : "beginUpdate", + "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "unhideTab", + "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to unhide.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enableTab", + "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to enable.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setTabWidth", + "desc" : "Resizes all the tabs to the passed width", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "The", + "type" : "Number", + "desc" : "new width", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "endUpdate", + "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "addTab", + "desc" : "Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of the div to use or create", + "isOptional" : false + }, + { + "name" : "text", + "type" : "String", + "desc" : "The text for the tab", + "isOptional" : false + }, + { + "name" : "content", + "type" : "String", + "desc" : "(optional) Content to put in the TabPanelItem body", + "isOptional" : false + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "(optional) True to create a close icon on the tab", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanelItem", + "desc" : "The created TabPanelItem" + } + ] + }, + { + "name" : "disableTab", + "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to disable.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this TabPanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "removeEl", + "type" : "Boolean", + "desc" : "(optional) True to remove the element from the DOM as well (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getTab", + "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to fetch.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanelItem", + "desc" : "" + } + ] + }, + { + "name" : "getCount", + "desc" : "Returns the number of tabs in this TabPanel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "autoSizeTabs", + "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "removeTab", + "desc" : "Removes a {@link Roo.TabPanelItem}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to remove.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to activate.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanelItem", + "desc" : "The TabPanelItem." + } + ] + }, + { + "name" : "syncHeight", + "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "targetHeight", + "type" : "Number", + "desc" : "(optional) Override the starting height from the elements height", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addTabItem", + "desc" : "Adds an existing {@link Roo.TabPanelItem}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.TabPanelItem", + "desc" : "The TabPanelItem to add", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hideTab", + "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to hide.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforetabchange", + "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.TabPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "Set cancel to true on this object to cancel the tab change", + "isOptional" : false + }, + { + "name" : "tab", + "type" : "Roo.TabPanelItem", + "desc" : "The tab being changed to", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "tabchange", + "desc" : "Fires when the active tab changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.TabPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "activePanel", + "type" : "Roo.TabPanelItem", + "desc" : "The new active tab", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.TabPanelItem.json b/docs2/symbols/Roo.TabPanelItem.json new file mode 100644 index 0000000000..5c29e7b9d2 --- /dev/null +++ b/docs2/symbols/Roo.TabPanelItem.json @@ -0,0 +1,733 @@ +{ + "name" : "Roo.TabPanelItem", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "Represents an individual item (tab plus body) in a TabPanel.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "setUrl", + "desc" : "Set a URL to be used to load the content for this TabPanelItem.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanelItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "String/Function", + "desc" : "The URL to load the content from, or a function to call to get the URL", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)", + "isOptional" : false + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this TabPanelItem is activated. (Defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "getText", + "desc" : "Returns the text for this tab", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanelItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "isHidden", + "desc" : "Returns true if this tab is \"hidden\"", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanelItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "setText", + "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanelItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The tab's text and tooltip", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Activates this TabPanelItem -- this does deactivate the currently active TabPanelItem.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanelItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isActive", + "desc" : "Returns true if this tab is the active tab.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanelItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "setContent", + "desc" : "Sets the content for this TabPanelItem.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanelItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "content", + "type" : "String", + "desc" : "The content", + "isOptional" : false + }, + { + "name" : "loadScripts", + "type" : "Boolean", + "desc" : "true to look for and load scripts", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "refresh", + "desc" : "Forces a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the setUrl method has not been called.\n This does not activate the panel, just updates its content.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanelItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setHidden", + "desc" : "Show or hide the tab", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanelItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to hide or false to show.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setTooltip", + "desc" : "Set the tooltip for the tab.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanelItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tooltip", + "type" : "String", + "desc" : "The tab's tooltip", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Enables this TabPanelItem if it was previously disabled.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanelItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getUpdateManager", + "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanelItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "disable", + "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanelItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanelItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Shows this TabPanelItem -- this does not deactivate the currently active TabPanelItem.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.TabPanelItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforeclose", + "desc" : "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.TabPanelItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "Set cancel to true on this object to cancel the close.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "close", + "desc" : "Fires when this tab is closed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.TabPanelItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Fires when this tab becomes the active tab.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tabPanel", + "type" : "Roo.TabPanel", + "desc" : "The parent TabPanel", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Roo.TabPanelItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "deactivate", + "desc" : "Fires when this tab is no longer the active tab.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tabPanel", + "type" : "Roo.TabPanel", + "desc" : "The parent TabPanel", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Roo.TabPanelItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Template.json b/docs2/symbols/Roo.Template.json new file mode 100644 index 0000000000..f392df2594 --- /dev/null +++ b/docs2/symbols/Roo.Template.json @@ -0,0 +1,345 @@ +{ + "name" : "Roo.Template", + "augments" : [ + ], + "desc" : "Represents an HTML fragment template. Templates can be precompiled for greater performance.\nFor a list of available format functions, see {@link Roo.util.Format}.
\nUsage:\n
\nvar t = new Roo.Template({\n    html :  '<div name=\"{id}\">' + \n        '<span class=\"{cls}\">{name:trim} {someval:this.myformat}{value:ellipsis(10)}</span>' +\n        '</div>',\n    myformat: function (value, allValues) {\n        return 'XX' + value;\n    }\n});\nt.append('some-element', {id: 'myid', cls: 'myclass', name: 'foo', value: 'bar'});\n
\nFor more information see this blog post with examples:\n DomHelper\n - Create Elements using DOM, HTML fragments and Templates.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "html", + "type" : "String", + "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")", + "memberOf" : "Roo.Template", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...", + "memberOf" : "Roo.Template", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "insertFirst", + "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "overwrite", + "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "insertBefore", + "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "applyTemplate", + "desc" : "Returns an HTML fragment of this template with the specified values applied.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The HTML fragment" + } + ] + }, + { + "name" : "compile", + "desc" : "Compiles the template into an internal function, eliminating the RegEx overhead.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Template", + "desc" : "this" + } + ] + }, + { + "name" : "set", + "desc" : "Sets the HTML used as the template and optionally compiles it.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "compile", + "type" : "Boolean", + "desc" : "(optional) True to compile the template (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Template", + "desc" : "this" + } + ] + }, + { + "name" : "from", + "desc" : "Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement", + "desc" : "A DOM element or its id", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "insertAfter", + "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "append", + "desc" : "Applies the supplied values to the template and appends the new node(s) to el.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "apply", + "desc" : "Alias for {@link #applyTemplate}", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Toolbar.Button.json b/docs2/symbols/Roo.Toolbar.Button.json new file mode 100644 index 0000000000..4530db5cb3 --- /dev/null +++ b/docs2/symbols/Roo.Toolbar.Button.json @@ -0,0 +1,884 @@ +{ + "name" : "Roo.Toolbar.Button", + "augments" : [ + "Roo.Button", + "Roo.util.Observable" + ], + "desc" : "A button that renders into a toolbar.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "String/Object", + "desc" : "The tooltip for the button - can be a string or QuickTips config object", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "text", + "type" : "String", + "desc" : "The button text", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "renderTo", + "type" : "String/HTMLElement/Element", + "desc" : "The element to append the button to", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to start hidden (defaults to false)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "toggleGroup", + "type" : "String", + "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "handleMouseEvents", + "type" : "Boolean", + "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "menu", + "type" : "Mixed", + "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "enableToggle", + "type" : "Boolean", + "desc" : "True to enable pressed/not pressed toggling (defaults to false)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function called when the button is clicked (can be used instead of click event)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "The scope of the handler", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum width for this button (used to give a set of buttons a common width)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to start disabled (defaults to false)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "pressed", + "type" : "Boolean", + "desc" : "True to start pressed (only if enableToggle = true)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "template", + "type" : "Roo.Template", + "desc" : "(Optional)\nAn {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the button's main element.", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The DOM tabIndex for this button (defaults to undefined)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "iconCls", + "type" : "String", + "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "menuAlign", + "type" : "String", + "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "icon", + "type" : "String", + "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "tooltipType", + "type" : "String", + "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "clickEvent", + "type" : "String", + "desc" : "The type of event to map to the button's event handler (defaults to 'click')", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "repeat", + "type" : "Boolean/Object", + "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "type", + "type" : "String", + "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).", + "memberOf" : "Roo.Button", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "disable", + "desc" : "Disables this item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Enables this item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Removes and destroys this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hides this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Shows this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Focus the button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setHandler", + "desc" : "Assigns this button's click handler", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "handler", + "type" : "Function", + "desc" : "The function to call when the button is clicked", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) Scope for the function passed in", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns the button's underlying element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for boolean enable/disable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "enabled", + "type" : "Boolean", + "desc" : "True to enable, false to disable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function for boolean show/hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getText", + "desc" : "Gets the text for this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The button text" + } + ] + }, + { + "name" : "setText", + "desc" : "Sets this button's text", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The button text", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toggle", + "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "state", + "type" : "Boolean", + "desc" : "(optional) Force a particular state", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "render", + "desc" : "Fires when the button is rendered", + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fires when this button is clicked", + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "EventObject", + "desc" : "The click event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseover", + "desc" : "Fires when the mouse hovers over the button", + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toggle", + "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)", + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "pressed", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseout", + "desc" : "Fires when the mouse exits the button", + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Toolbar.Fill.json b/docs2/symbols/Roo.Toolbar.Fill.json new file mode 100644 index 0000000000..9111a6c378 --- /dev/null +++ b/docs2/symbols/Roo.Toolbar.Fill.json @@ -0,0 +1,175 @@ +{ + "name" : "Roo.Toolbar.Fill", + "augments" : [ + "Roo.Toolbar.Spacer", + "Roo.Toolbar.Item" + ], + "desc" : "A simple element that adds a greedy (100% width) horizontal space to a toolbar.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "disable", + "desc" : "Disables this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hides this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Shows this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Get this item's HTML Element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "" + } + ] + }, + { + "name" : "destroy", + "desc" : "Removes and destroys this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Enables this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function for boolean show/hide.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "true to show/false to hide", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "render", + "desc" : "Fires when the button is rendered", + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Toolbar.Item.json b/docs2/symbols/Roo.Toolbar.Item.json new file mode 100644 index 0000000000..4468163bb9 --- /dev/null +++ b/docs2/symbols/Roo.Toolbar.Item.json @@ -0,0 +1,173 @@ +{ + "name" : "Roo.Toolbar.Item", + "augments" : [ + ], + "desc" : "The base class that other classes should extend in order to get some basic common toolbar item functionality.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "disable", + "desc" : "Disables this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hides this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Shows this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Get this item's HTML Element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "" + } + ] + }, + { + "name" : "destroy", + "desc" : "Removes and destroys this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Enables this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function for boolean show/hide.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "true to show/false to hide", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "render", + "desc" : "Fires when the button is rendered", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Toolbar.Separator.json b/docs2/symbols/Roo.Toolbar.Separator.json new file mode 100644 index 0000000000..4a3b59eba0 --- /dev/null +++ b/docs2/symbols/Roo.Toolbar.Separator.json @@ -0,0 +1,174 @@ +{ + "name" : "Roo.Toolbar.Separator", + "augments" : [ + "Roo.Toolbar.Item" + ], + "desc" : "A simple toolbar separator class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "disable", + "desc" : "Disables this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hides this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Shows this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Get this item's HTML Element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "" + } + ] + }, + { + "name" : "destroy", + "desc" : "Removes and destroys this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Enables this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function for boolean show/hide.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "true to show/false to hide", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "render", + "desc" : "Fires when the button is rendered", + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Toolbar.Spacer.json b/docs2/symbols/Roo.Toolbar.Spacer.json new file mode 100644 index 0000000000..c48759f19e --- /dev/null +++ b/docs2/symbols/Roo.Toolbar.Spacer.json @@ -0,0 +1,174 @@ +{ + "name" : "Roo.Toolbar.Spacer", + "augments" : [ + "Roo.Toolbar.Item" + ], + "desc" : "A simple element that adds extra horizontal space to a toolbar.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "disable", + "desc" : "Disables this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hides this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Shows this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Get this item's HTML Element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "" + } + ] + }, + { + "name" : "destroy", + "desc" : "Removes and destroys this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Enables this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function for boolean show/hide.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "true to show/false to hide", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "render", + "desc" : "Fires when the button is rendered", + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Toolbar.SplitButton.json b/docs2/symbols/Roo.Toolbar.SplitButton.json new file mode 100644 index 0000000000..e23b015ef3 --- /dev/null +++ b/docs2/symbols/Roo.Toolbar.SplitButton.json @@ -0,0 +1,954 @@ +{ + "name" : "Roo.Toolbar.SplitButton", + "augments" : [ + "Roo.SplitButton", + "Roo.Button", + "Roo.util.Observable" + ], + "desc" : "A menu button that renders into a toolbar.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "String/Object", + "desc" : "The tooltip for the button - can be a string or QuickTips config object", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "text", + "type" : "String", + "desc" : "The button text", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "renderTo", + "type" : "String/HTMLElement/Element", + "desc" : "The element to append the button to", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to start hidden (defaults to false)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "toggleGroup", + "type" : "String", + "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "handleMouseEvents", + "type" : "Boolean", + "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "menu", + "type" : "Mixed", + "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "enableToggle", + "type" : "Boolean", + "desc" : "True to enable pressed/not pressed toggling (defaults to false)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "arrowHandler", + "type" : "Function", + "desc" : "A function called when the arrow button is clicked (can be used instead of click event)", + "memberOf" : "Roo.SplitButton", + "values" : [ + ] + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function called when the button is clicked (can be used instead of click event)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "The scope of the handler", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum width for this button (used to give a set of buttons a common width)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to start disabled (defaults to false)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "pressed", + "type" : "Boolean", + "desc" : "True to start pressed (only if enableToggle = true)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "template", + "type" : "Roo.Template", + "desc" : "(Optional)\nAn {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the button's main element.", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The DOM tabIndex for this button (defaults to undefined)", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "iconCls", + "type" : "String", + "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "menuAlign", + "type" : "String", + "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "icon", + "type" : "String", + "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "tooltipType", + "type" : "String", + "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "arrowTooltip", + "type" : "String", + "desc" : "The title attribute of the arrow", + "memberOf" : "Roo.SplitButton", + "values" : [ + ] + }, + { + "name" : "clickEvent", + "type" : "String", + "desc" : "The type of event to map to the button's event handler (defaults to 'click')", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "repeat", + "type" : "Boolean/Object", + "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).", + "memberOf" : "Roo.Button", + "values" : [ + ] + }, + { + "name" : "type", + "type" : "String", + "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).", + "memberOf" : "Roo.Button", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "destroy", + "desc" : "Removes and destroys this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.SplitButton", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hides this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.SplitButton", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Shows this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.SplitButton", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setArrowHandler", + "desc" : "Sets this button's arrow click handler", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitButton", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "handler", + "type" : "Function", + "desc" : "The function to call when the arrow is clicked", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) Scope for the function passed above", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Focus the button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitButton", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setHandler", + "desc" : "Sets this button's click handler", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.SplitButton", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "handler", + "type" : "Function", + "desc" : "The function to call when the button is clicked", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) Scope for the function passed above", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Disable this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Enable this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns the button's underlying element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for boolean enable/disable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "enabled", + "type" : "Boolean", + "desc" : "True to enable, false to disable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function for boolean show/hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getText", + "desc" : "Gets the text for this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The button text" + } + ] + }, + { + "name" : "setText", + "desc" : "Sets this button's text", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The button text", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toggle", + "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "state", + "type" : "Boolean", + "desc" : "(optional) Force a particular state", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "arrowclick", + "desc" : "Fires when this button's arrow is clicked", + "memberOf" : "Roo.SplitButton", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SplitButton", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "EventObject", + "desc" : "The click event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires when the button is rendered", + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fires when this button is clicked", + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "EventObject", + "desc" : "The click event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseover", + "desc" : "Fires when the mouse hovers over the button", + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toggle", + "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)", + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "pressed", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseout", + "desc" : "Fires when the mouse exits the button", + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Toolbar.TextItem.json b/docs2/symbols/Roo.Toolbar.TextItem.json new file mode 100644 index 0000000000..c1e4dd1c6d --- /dev/null +++ b/docs2/symbols/Roo.Toolbar.TextItem.json @@ -0,0 +1,174 @@ +{ + "name" : "Roo.Toolbar.TextItem", + "augments" : [ + "Roo.Toolbar.Item" + ], + "desc" : "A simple class that renders text directly into a toolbar.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "disable", + "desc" : "Disables this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hides this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Shows this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Get this item's HTML Element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "" + } + ] + }, + { + "name" : "destroy", + "desc" : "Removes and destroys this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Enables this item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function for boolean show/hide.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "true to show/false to hide", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "render", + "desc" : "Fires when the button is rendered", + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.Toolbar.json b/docs2/symbols/Roo.Toolbar.json new file mode 100644 index 0000000000..e814105774 --- /dev/null +++ b/docs2/symbols/Roo.Toolbar.json @@ -0,0 +1,397 @@ +{ + "name" : "Roo.Toolbar", + "augments" : [ + ], + "desc" : "Basic Toolbar class.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "The id or element that will contain the toolbar", + "memberOf" : "Roo.Toolbar", + "values" : [ + ] + }, + { + "name" : "items", + "type" : "Array", + "desc" : "array of button configs or elements to add (will be converted to a MixedCollection)", + "memberOf" : "Roo", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "addDom", + "desc" : "Adds a new element to the toolbar from the passed {@link Roo.DomHelper} config.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Item", + "desc" : "The element's item" + } + ] + }, + { + "name" : "addElement", + "desc" : "Adds any standard HTML element to the toolbar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The element or id of the element to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Item", + "desc" : "The element's item" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the Element for this toolbar.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide the toolbar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "addSeparator", + "desc" : "Adds a separator", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Item", + "desc" : "The separator item" + } + ] + }, + { + "name" : "show", + "desc" : "Show the toolbar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "addFill", + "desc" : "Adds a fill element that forces subsequent additions to the right side of the toolbar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Fill", + "desc" : "The fill item" + } + ] + }, + { + "name" : "addSpacer", + "desc" : "Adds a spacer element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Spacer", + "desc" : "The spacer item" + } + ] + }, + { + "name" : "add", + "desc" : "Adds element(s) to the toolbar -- this function takes a variable number of \narguments of mixed type and adds them to the toolbar.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "arg1", + "type" : "Mixed", + "desc" : "The following types of arguments are all valid:
\n
    \n
  • {@link Roo.Toolbar.Button} config: A valid button config object (equivalent to {@link #addButton})
  • \n
  • HtmlElement: Any standard HTML element (equivalent to {@link #addElement})
  • \n
  • Field: Any form field (equivalent to {@link #addField})
  • \n
  • Item: Any subclass of {@link Roo.Toolbar.Item} (equivalent to {@link #addItem})
  • \n
  • String: Any generic string (gets wrapped in a {@link Roo.Toolbar.TextItem}, equivalent to {@link #addText}).\nNote that there are a few special strings that are treated differently as explained nRoo.
  • \n
  • 'separator' or '-': Creates a separator element (equivalent to {@link #addSeparator})
  • \n
  • ' ': Creates a spacer element (equivalent to {@link #addSpacer})
  • \n
  • '->': Creates a fill element (equivalent to {@link #addFill})
  • \n
", + "isOptional" : false + }, + { + "name" : "arg2", + "type" : "Mixed", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addField", + "desc" : "Adds a dynamically rendered Roo.form field (TextField, ComboBox, etc).\nNote: the field should not have been rendered yet. For a field that has already been\nrendered, use {@link #addElement}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "field", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ToolbarItem", + "desc" : "" + } + ] + }, + { + "name" : "addText", + "desc" : "Adds text to the toolbar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The text to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Item", + "desc" : "The element's item" + } + ] + }, + { + "name" : "addItem", + "desc" : "Adds any Toolbar.Item or subclass", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.Toolbar.Item", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Item", + "desc" : "The item" + } + ] + }, + { + "name" : "addButton", + "desc" : "Adds a button (or buttons). See {@link Roo.Toolbar.Button} for more info on the config.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object/Array", + "desc" : "A button config or array of configs", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Button/Array", + "desc" : "" + } + ] + }, + { + "name" : "insertButton", + "desc" : "Inserts any {@link Roo.Toolbar.Item}/{@link Roo.Toolbar.Button} at the specified index.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index where the item is to be inserted", + "isOptional" : false + }, + { + "name" : "item", + "type" : "Object/Roo.Toolbar.Item/Roo.Toolbar.Button (may be Array)", + "desc" : "The button, or button config object to be inserted.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Button/Item", + "desc" : "" + } + ] + }, + { + "name" : "addxtype", + "desc" : "Add an Xtype element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Toolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "xtype", + "type" : "Object", + "desc" : "Xtype Object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "created Object" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.TreePanel.json b/docs2/symbols/Roo.TreePanel.json new file mode 100644 index 0000000000..b7674332cd --- /dev/null +++ b/docs2/symbols/Roo.TreePanel.json @@ -0,0 +1,862 @@ +{ + "name" : "Roo.TreePanel", + "augments" : [ + "Roo.ContentPanel", + "Roo.util.Observable" + ], + "desc" : "Create a new TreePanel. - defaults to fit/scoll contents.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "fitToFrame", + "type" : "Boolean", + "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "background", + "type" : "Boolean", + "desc" : "True if the panel should not be activated when it is added (defaults to false)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "toolbar", + "type" : "Toolbar", + "desc" : "A toolbar for this panel", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "region", + "type" : "String", + "desc" : "which region to put this panel on (when used with xtype constructors)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + "(center", + "north", + "south", + "east", + "west)" + ] + }, + { + "name" : "content", + "type" : "String", + "desc" : "Raw content to fill content panel with (uses setContent on construction.)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title for this panel", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "fitContainer", + "type" : "Boolean", + "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "True if the panel can be closed/removed", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "tree", + "type" : "Roo.tree.TreePanel", + "desc" : "The tree TreePanel, with config etc.", + "memberOf" : "Roo", + "values" : [ + ] + }, + { + "name" : "adjustments", + "type" : "Array", + "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "Calls {@link #setUrl} with this value", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + }, + { + "name" : "resizeEl", + "type" : "String/HTMLElement/Element", + "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", + "memberOf" : "Roo.ContentPanel", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "load", + "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "Object/String/Function", + "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n
\npanel.load({\n    url: \"your-url.php\",\n    params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n    callback: yourFunction,\n    scope: yourObject, //(optional scope)\n    discardUrl: false,\n    nocache: false,\n    text: \"Loading...\",\n    timeout: 30,\n    scripts: false\n});\n
\nThe only required property is url. The optional properties nocache, text and scripts\nare shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this panel UpdateManager instance.", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)", + "isOptional" : false + }, + { + "name" : "discardUrl", + "type" : "Boolean", + "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "this" + } + ] + }, + { + "name" : "getUpdateManager", + "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "isClosable", + "desc" : "Returns true is this panel was configured to be closable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this panel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns this panel's element - used by regiosn to add.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "setContent", + "desc" : "Updates this panel's element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "content", + "type" : "String", + "desc" : "The new content", + "isOptional" : false + }, + { + "name" : "loadScripts", + "type" : "Boolean", + "desc" : "(optional) true to look for and process scripts", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns this panel's id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "addxtype", + "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cfg", + "type" : "Object", + "desc" : "Xtype definition of item to add.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "refresh", + "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getTitle", + "desc" : "Returns this panel's title", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "setTitle", + "desc" : "Set this panel's title", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getToolbar", + "desc" : "Returns the toolbar for this Panel if one was configured.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar", + "desc" : "" + } + ] + }, + { + "name" : "setUrl", + "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "String/Function", + "desc" : "The URL to load the content from or a function to call to get the URL", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)", + "isOptional" : false + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "deactivate", + "desc" : "Fires when this panel is activated.", + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires when this panel is resized if fitToFrame is true.", + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The width after any component adjustments", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The height after any component adjustments", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires when this tab is created", + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Fires when this panel is activated.", + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.UpdateManager.BasicRenderer.json b/docs2/symbols/Roo.UpdateManager.BasicRenderer.json new file mode 100644 index 0000000000..1222b6a563 --- /dev/null +++ b/docs2/symbols/Roo.UpdateManager.BasicRenderer.json @@ -0,0 +1,55 @@ +{ + "name" : "Roo.UpdateManager.BasicRenderer", + "augments" : [ + ], + "desc" : "Default Content renderer. Updates the elements innerHTML with the responseText.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "render", + "desc" : "This is called when the transaction is completed and it's time to update the element - The BasicRenderer\nupdates the elements innerHTML with the responseText - To perform a custom render (i.e. XML or JSON processing),\ncreate an object with a \"render(el, response)\" method and pass it to setRenderer on the UpdateManager.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.UpdateManager.BasicRenderer", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "The element being rendered", + "isOptional" : false + }, + { + "name" : "response", + "type" : "Object", + "desc" : "The YUI Connect response object", + "isOptional" : false + }, + { + "name" : "updateManager", + "type" : "UpdateManager", + "desc" : "The calling update manager", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "A callback that will need to be called if loadScripts is true on the UpdateManager", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.UpdateManager.defaults.json b/docs2/symbols/Roo.UpdateManager.defaults.json new file mode 100644 index 0000000000..5a98afecf7 --- /dev/null +++ b/docs2/symbols/Roo.UpdateManager.defaults.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.UpdateManager.defaults", + "augments" : [ + ], + "desc" : "The defaults collection enables customizing the default properties of UpdateManager", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.UpdateManager.json b/docs2/symbols/Roo.UpdateManager.json new file mode 100644 index 0000000000..f4a0dac0d8 --- /dev/null +++ b/docs2/symbols/Roo.UpdateManager.json @@ -0,0 +1,729 @@ +{ + "name" : "Roo.UpdateManager", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "Provides AJAX-style update for Element object.

\nUsage:
\n
\n// Get it from a Roo.Element object\nvar el = Roo.get(\"foo\");\nvar mgr = el.getUpdateManager();\nmgr.update(\"http://myserver.com/index.php\", \"param1=1&param2=2\");\n...\nmgr.formUpdate(\"myFormId\", \"http://myserver.com/index.php\");\n
\n// or directly (returns the same UpdateManager instance)\nvar mgr = new Roo.UpdateManager(\"myElementId\");\nmgr.startAutoRefresh(60, \"http://myserver.com/index.php\");\nmgr.on(\"update\", myFcnNeedsToKnow);\n
\n // short handed call directly from the element object\n Roo.get(\"foo\").load({\n url: \"bar.php\",\n scripts:true,\n params: \"for=bar\",\n text: \"Loading Foo...\"\n });\n
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "update", + "desc" : "Performs an async request, updating this element with the response. If params are specified it uses POST, otherwise it uses GET.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.UpdateManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "Object/String/Function", + "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n
\num.update({
\n url: \"your-url.php\",
\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string
\n callback: yourFunction,
\n scope: yourObject, //(optional scope)
\n discardUrl: false,
\n nocache: false,
\n text: \"Loading...\",
\n timeout: 30,
\n scripts: false
\n});\n
\nThe only required property is url. The optional properties nocache, text and scripts\nare shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this UpdateManager instance.", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The parameters to pass as either a url encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)", + "isOptional" : false + }, + { + "name" : "discardUrl", + "type" : "Boolean", + "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "showLoading", + "desc" : "Called to update the element to \"Loading\" state. Override to perform custom action.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.UpdateManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDefaultUrl", + "desc" : "Set the defaultUrl used for updates", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.UpdateManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "defaultUrl", + "type" : "String/Function", + "desc" : "The url or a function to call to get the url", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "updateElement", + "desc" : "Static convenience method. This method is deprecated in favor of el.load({url:'foo.php', ...}).\nUsage:\n
Roo.UpdateManager.updateElement(\"my-div\", \"stuff.php\");
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.UpdateManager", + "example" : "", + "deprecated" : "This has been deprecated: ", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to update", + "isOptional" : false + }, + { + "name" : "url", + "type" : "String", + "desc" : "The url", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) Url encoded param string or an object of name/value pairs", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) A config object with any of the UpdateManager properties you want to set - for example: {disableCaching:true, indicatorText: \"Loading data...\"}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "refresh", + "desc" : "Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.UpdateManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Get the Element this UpdateManager is bound to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.UpdateManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "isUpdating", + "desc" : "Returns true if an update is in progress", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.UpdateManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "stopAutoRefresh", + "desc" : "Stop auto refresh on this element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.UpdateManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "startAutoRefresh", + "desc" : "Set this element to auto refresh.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.UpdateManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "interval", + "type" : "Number", + "desc" : "How often to update (in seconds).", + "isOptional" : false + }, + { + "name" : "url", + "type" : "String/Function", + "desc" : "(optional) The url for this request or a function to call to get the url (Defaults to the last used url)", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The parameters to pass as either a url encoded string \"¶m1=1¶m2=2\" or as an object {param1: 1, param2: 2}", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)", + "isOptional" : false + }, + { + "name" : "refreshNow", + "type" : "Boolean", + "desc" : "(optional) Whether to execute the refresh now, or wait the interval", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "abort", + "desc" : "Aborts the executing transaction", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.UpdateManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRenderer", + "desc" : "Set the content renderer for this UpdateManager. See {@link Roo.UpdateManager.BasicRenderer#render} for more details.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.UpdateManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "renderer", + "type" : "Object", + "desc" : "The object implementing the render() method", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "formUpdate", + "desc" : "Performs an async form post, updating this element with the response. If the form has the attribute enctype=\"multipart/form-data\", it assumes it's a file upload.\nUses this.sslBlankUrl for SSL file uploads to prevent IE security warning.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.UpdateManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "form", + "type" : "String/HTMLElement", + "desc" : "The form Id or form element", + "isOptional" : false + }, + { + "name" : "url", + "type" : "String", + "desc" : "(optional) The url to pass the form to. If omitted the action attribute on the form will be used.", + "isOptional" : false + }, + { + "name" : "reset", + "type" : "Boolean", + "desc" : "(optional) Whether to try to reset the form after the update", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "update", + "desc" : "Fired after successful update is made.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "oResponseObject", + "type" : "Object", + "desc" : "The response Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeupdate", + "desc" : "Fired before an update is made, return false from your handler and the update is cancelled.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "url", + "type" : "String/Object/Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "failure", + "desc" : "Fired on update failure.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "oResponseObject", + "type" : "Object", + "desc" : "The response Object", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.View.json b/docs2/symbols/Roo.View.json new file mode 100644 index 0000000000..6b970745e3 --- /dev/null +++ b/docs2/symbols/Roo.View.json @@ -0,0 +1,1056 @@ +{ + "name" : "Roo.View", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "Create a \"View\" for an element based on a data model or UpdateManager and the supplied DomHelper template. \nThis class also supports single and multi selection modes.
\nCreate a data model bound view:\n
\n var store = new Roo.data.Store(...);\n\n var view = new Roo.View({\n    el : \"my-element\",\n    tpl : '<div id=\"{0}\">{2} - {1}</div>', // auto create template\n \n    singleSelect: true,\n    selectedClass: \"ydataview-selected\",\n    store: store\n });\n\n // listen for node click?\n view.on(\"click\", function(vw, index, node, e){\n alert('Node \"' + node.id + '\" at index: ' + index + \" was clicked.\");\n });\n\n // load XML data\n dataModel.load(\"foobar.xml\");\n 
\n For an example of creating a JSON/UpdateManager view, see {@link Roo.JsonView}.\n

\nNote: The root of your template must be a single node. Table/row implementations may work but are not supported due to\nIE\"s limited insertion support with tables and Opera\"s faulty event bubbling.\n\nNote: old style constructor is still suported (container, template, config)", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "selectedClass", + "type" : "String", + "desc" : "The css class to add to selected nodes", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "dataName", + "type" : "String", + "desc" : "the named area of the template to use as the data area\n Works with domtemplates roo-name=\"name\"", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "text", + "type" : "String", + "desc" : "to display on mask (default Loading)", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "multiSelect", + "type" : "Boolean", + "desc" : "Allow multiple selection", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The empty text to show when nothing is loaded.", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "Data store to load data from.", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "toggleSelect", + "type" : "Boolean", + "desc" : "- selecting", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "singleSelect", + "type" : "Boolean", + "desc" : "Allow single selection", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "tickable", + "type" : "Boolean", + "desc" : "- selecting", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "el", + "type" : "String|Roo.Element", + "desc" : "The container element.", + "memberOf" : "Roo.View", + "values" : [ + ] + }, + { + "name" : "tpl", + "type" : "String|Roo.Template", + "desc" : "The template used by this View", + "memberOf" : "Roo.View", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getSelectedNodes", + "desc" : "Get the currently selected nodes.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "An array of HTMLElements" + } + ] + }, + { + "name" : "getNodes", + "desc" : "Gets a range template nodes.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "startIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "endIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "An array of nodes" + } + ] + }, + { + "name" : "select", + "desc" : "Selects nodes.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "nodeInfo", + "type" : "Array/HTMLElement/String/Number", + "desc" : "An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) true to keep existing selections", + "isOptional" : false + }, + { + "name" : "suppressEvent", + "type" : "Boolean", + "desc" : "(optional) true to skip firing of the selectionchange vent", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearSelections", + "desc" : "Clear all selections", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "suppressEvent", + "type" : "Boolean", + "desc" : "(optional) true to skip firing of the selectionchange event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isSelected", + "desc" : "Returns true if the passed node is selected", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement/Number", + "desc" : "The node or node index", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "refresh", + "desc" : "Refreshes the view. - called by datachanged on the store. - do not call directly.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onBeforeLoad", + "desc" : "onbeforeLoad - masks the loading area.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getSelectedIndexes", + "desc" : "Get the indexes of the selected nodes.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "" + } + ] + }, + { + "name" : "indexOf", + "desc" : "Finds the index of the passed node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "nodeInfo", + "type" : "HTMLElement/String/Number", + "desc" : "An HTMLElement template node, index of a template node or the id of a template node", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the node or -1" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the element this view is bound to.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "setStore", + "desc" : "Changes the data store this view uses and refresh the view.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "store", + "type" : "Store", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "refreshNode", + "desc" : "Refresh an individual node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "prepareData", + "desc" : "Function to override to reformat the data that is sent to\nthe template for each node.\nDEPRICATED - use the preparedata event handler.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "data", + "type" : "Array/Object", + "desc" : "The raw data (array of colData for a data model bound view or\na JSON object for an UpdateManager bound view).", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSelectionCount", + "desc" : "Get the number of selected nodes.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "findItemFromChild", + "desc" : "Returns the template node the passed child belongs to or null if it doesn't belong to one.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "The template node" + } + ] + }, + { + "name" : "unselect", + "desc" : "Unselects nodes.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "nodeInfo", + "type" : "Array/HTMLElement/String/Number", + "desc" : "An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) true IGNORED (for campatibility with select)", + "isOptional" : false + }, + { + "name" : "suppressEvent", + "type" : "Boolean", + "desc" : "(optional) true to skip firing of the selectionchange vent", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getNode", + "desc" : "Gets a template node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.View", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "nodeInfo", + "type" : "HTMLElement/String/Number", + "desc" : "An HTMLElement template node, index of a template node or the id of a template node", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "The node or null if it wasn't found" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "dblclick", + "desc" : "Fires when a template node is double clicked.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the target node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "The target node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The raw event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "preparedata", + "desc" : "Fires on every row to render, to allow you to change the data.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "to be rendered (change this)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "selectionchange", + "desc" : "Fires when the selected nodes change.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "selections", + "type" : "Array", + "desc" : "Array of the selected nodes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeselect", + "desc" : "Fires before a selection is made. If any handlers return false, the selection is cancelled.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "The node to be selected", + "isOptional" : false + }, + { + "name" : "selections", + "type" : "Array", + "desc" : "Array of currently selected nodes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeclick", + "desc" : "Fires before a click is processed. Returns false to cancel the default action.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the target node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "The target node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The raw event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fires when a template node is clicked.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the target node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "The target node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The raw event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "contextmenu", + "desc" : "Fires when a template node is right clicked.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the target node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "The target node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The raw event object", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.XComponent.event.events.json b/docs2/symbols/Roo.XComponent.event.events.json new file mode 100644 index 0000000000..4bf1b4ad30 --- /dev/null +++ b/docs2/symbols/Roo.XComponent.event.events.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.XComponent.event.events", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.XComponent.json b/docs2/symbols/Roo.XComponent.json new file mode 100644 index 0000000000..fd2fecb00f --- /dev/null +++ b/docs2/symbols/Roo.XComponent.json @@ -0,0 +1,500 @@ +{ + "name" : "Roo.XComponent", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "A delayed Element creator...\nOr a way to group chunks of interface together.\ntechnically this is a wrapper around a tree of Roo elements (which defines a 'module'),\n used in conjunction with XComponent.build() it will create an instance of each element,\n then call addxtype() to build the User interface.\n\nMypart.xyx = new Roo.XComponent({\n\n parent : 'Mypart.xyz', // empty == document.element.!!\n order : '001',\n name : 'xxxx'\n region : 'xxxx'\n disabled : function() {} \n \n tree : function() { // return an tree of xtype declared components\n var MODULE = this;\n return \n {\n xtype : 'NestedLayoutPanel',\n // technicall\n }\n ]\n})\n\n\nIt can be used to build a big heiracy, with parent etc.\nor you can just use this to render a single compoent to a dom element\nMYPART.render(Roo.Element | String(id) | dom_element )\n\n\nUsage patterns.\n\nClassic Roo\n\nRoo is designed primarily as a single page application, so the UI build for a standard interface will\nexpect a single 'TOP' level module normally indicated by the 'parent' of the XComponent definition being defined as false.\n\nEach sub module is expected to have a parent pointing to the class name of it's parent module.\n\nWhen the top level is false, a 'Roo.BorderLayout' is created and the element is flagged as 'topModule'\n- if mulitple topModules exist, the last one is defined as the top module.\n\nEmbeded Roo\n\nWhen the top level or multiple modules are to embedded into a existing HTML page,\nthe parent element can container '#id' of the element where the module will be drawn.\n\nBootstrap Roo\n\nUnlike classic Roo, the bootstrap tends not to be used as a single page.\nit relies more on a include mechanism, where sub modules are included into an outer page.\nThis is normally managed by the builder tools using Roo.apply( options, Included.Sub.Module )\n\nBootstrap Roo Included elements\n\nOur builder application needs the ability to preview these sub compoennts. They will normally have parent=false set,\nhence confusing the component builder as it thinks there are multiple top level elements. \n\nString Over-ride & Translations\n\nOur builder application writes all the strings as _strings and _named_strings. This is to enable the translation of elements,\nand also the 'overlaying of string values - needed when different versions of the same application with different text content\nare needed. @see Roo.XComponent.overlayString", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "region", + "type" : "String", + "desc" : "Region to render component to (defaults to center)", + "memberOf" : "Roo.XComponent", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Function|boolean", + "desc" : "If this module is disabled by some rule, return true from the funtion", + "memberOf" : "Roo.XComponent", + "values" : [ + ] + }, + { + "name" : "order", + "type" : "String", + "desc" : "Used to set the order in which elements are created (usefull for multiple tabs)", + "memberOf" : "Roo.XComponent", + "values" : [ + ] + }, + { + "name" : "items", + "type" : "Array", + "desc" : "A single item array - the first element is the root of the tree..\nIt's done this way to stay compatible with the Xtype system...", + "memberOf" : "Roo.XComponent", + "values" : [ + ] + }, + { + "name" : "parent", + "type" : "String", + "desc" : "Name of parent element which it get xtype added to..", + "memberOf" : "Roo.XComponent", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "String to display while loading.", + "memberOf" : "Roo.XComponent", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "overlayStrings", + "desc" : "Overlay a set of modified strings onto a component\nThis is dependant on our builder exporting the strings and 'named strings' elements.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.XComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "Object", + "desc" : "to overlay on - eg. Pman.Dialog.Login", + "isOptional" : false + }, + { + "name" : "associative", + "type" : "Object", + "desc" : "array of 'named' string and it's new value.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "preBuild", + "desc" : "move modules into their correct place in the tree..", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.XComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "toObject", + "desc" : "convert a string to an object..\neg. 'AAA.BBB' -> finds AAA.BBB", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.XComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "render\nrender element to dom or tree", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.XComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "optional", + "type" : "Roo.Element|String|DomElement", + "desc" : "render to if parent is not set.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "buildOrder", + "desc" : "make a list of modules to build.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.XComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "list of modules." + } + ] + }, + { + "name" : "register", + "desc" : "Register components to be built later.\n\nThis solves the following issues\n- Building is not done on page load, but after an authentication process has occured.\n- Interface elements are registered on page load\n- Parent Interface elements may not be loaded before child, so this handles that..\n\n\nexample:\n\nMyApp.register({\n order : '000001',\n module : 'Pman.Tab.projectMgr',\n region : 'center',\n parent : 'Pman.layout',\n disabled : false, // or use a function..\n })\n* @param {Object} details about module", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.XComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "build", + "desc" : "Build the registered modules.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.XComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "parent", + "type" : "Object", + "desc" : "element.", + "isOptional" : false + }, + { + "name" : "optional", + "type" : "Function", + "desc" : "method to call after module has been added.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "built", + "desc" : "Fires when this the componnt is built", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "c", + "type" : "Roo.XComponent", + "desc" : "the component", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.XTemplate.json b/docs2/symbols/Roo.XTemplate.json new file mode 100644 index 0000000000..8ece7e03ea --- /dev/null +++ b/docs2/symbols/Roo.XTemplate.json @@ -0,0 +1,375 @@ +{ + "name" : "Roo.XTemplate", + "augments" : [ + "Roo.Template" + ], + "desc" : "Provides a template that can have nested templates for loops or conditionals. The syntax is:\n
\nvar t = new Roo.XTemplate(\n\t'<select name=\"{name}\">',\n\t\t'<tpl for=\"options\"><option value=\"{value:trim}\">{text:ellipsis(10)}</option></tpl>',\n\t'</select>'\n);\n \n// then append, applying the master template values\n 
\n\nSupported features:\n\n Tags:\n\n
\n      {a_variable} - output encoded.\n      {a_variable.format:(\"Y-m-d\")} - call a method on the variable\n      {a_variable:raw} - unencoded output\n      {a_variable:toFixed(1,2)} - Roo.util.Format.\"toFixed\"\n      {a_variable:this.method_on_template(...)} - call a method on the template object.\n \n
\n The tpl tag:\n
\n        <tpl for=\"a_variable or condition..\"></tpl>\n        <tpl if=\"a_variable or condition\"></tpl>\n        <tpl exec=\"some javascript\"></tpl>\n        <tpl name=\"named_template\"></tpl> (experimental)\n  \n        <tpl for=\".\"></tpl> - just iterate the property..\n        <tpl for=\"..\"></tpl> - iterates with the parent (probably the template) \n
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "html", + "type" : "String", + "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")", + "memberOf" : "Roo.Template", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...", + "memberOf" : "Roo.Template", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "applySubTemplate", + "desc" : "same as applyTemplate, except it's done to one of the subTemplates\nwhen using named templates, you can do:\n\nvar str = pl.applySubTemplate('your-name', values);", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.XTemplate", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "Number", + "desc" : "of the template", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "to apply to template", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Object", + "desc" : "(normaly the instance of this object)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "compile", + "desc" : "compile the template\n\nThis is not recursive, so I'm not sure how nested templates are really going to be handled..", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.XTemplate", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "insertFirst", + "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "overwrite", + "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "insertBefore", + "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "applyTemplate", + "desc" : "Returns an HTML fragment of this template with the specified values applied.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The HTML fragment" + } + ] + }, + { + "name" : "set", + "desc" : "Sets the HTML used as the template and optionally compiles it.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "compile", + "type" : "Boolean", + "desc" : "(optional) True to compile the template (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Template", + "desc" : "this" + } + ] + }, + { + "name" : "from", + "desc" : "Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement", + "desc" : "A DOM element or its id", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "insertAfter", + "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "append", + "desc" : "Applies the supplied values to the template and appends the new node(s) to el.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] + }, + { + "name" : "apply", + "desc" : "Alias for {@link #applyTemplate}", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Template", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Alert.json b/docs2/symbols/Roo.bootstrap.Alert.json new file mode 100644 index 0000000000..70130d0848 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Alert.json @@ -0,0 +1,1017 @@ +{ + "name" : "Roo.bootstrap.Alert", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Alert class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title of alert", + "memberOf" : "Roo.bootstrap.Alert", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "The content of alert", + "memberOf" : "Roo.bootstrap.Alert", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "faicon", + "type" : "String", + "desc" : "font-awesomeicon", + "memberOf" : "Roo.bootstrap.Alert", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "weight", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Alert", + "values" : [ + "( success", + "info", + "warning", + "danger )" + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.BezierSignature.json b/docs2/symbols/Roo.bootstrap.BezierSignature.json new file mode 100644 index 0000000000..fd87ce6a4f --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.BezierSignature.json @@ -0,0 +1,981 @@ +{ + "name" : "Roo.bootstrap.BezierSignature", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap BezierSignature class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Body.json b/docs2/symbols/Roo.bootstrap.Body.json new file mode 100644 index 0000000000..401c50859b --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Body.json @@ -0,0 +1,981 @@ +{ + "name" : "Roo.bootstrap.Body", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Body class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Brick.json b/docs2/symbols/Roo.bootstrap.Brick.json new file mode 100644 index 0000000000..5407598376 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Brick.json @@ -0,0 +1,1054 @@ +{ + "name" : "Roo.bootstrap.Brick", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Brick class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "video", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Brick", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Brick", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Brick", + "values" : [ + ] + }, + { + "name" : "square", + "type" : "Boolean", + "desc" : "", + "memberOf" : "Roo.bootstrap.Brick", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Brick", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "href", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Brick", + "values" : [ + ] + }, + { + "name" : "bgimage", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Brick", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "When a Brick is click", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Brick", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Button.json b/docs2/symbols/Roo.bootstrap.Button.json new file mode 100644 index 0000000000..4079974c01 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Button.json @@ -0,0 +1,1312 @@ +{ + "name" : "Roo.bootstrap.Button", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Button class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "toggle", + "type" : "Boolean", + "desc" : "is it a slidy toggle button", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + ] + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "dark themed version", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + ] + }, + { + "name" : "badge", + "type" : "String", + "desc" : "text for badge", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "default false;", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "weight", + "type" : "String", + "desc" : "default", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + "(default", + "primary", + "secondary", + "success", + "info", + "warning", + "danger", + "link )" + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "ontext", + "type" : "String", + "desc" : "text for on slidy toggle state", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + ] + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : "default true (stop click event triggering the URL if it's a link.)", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + ] + }, + { + "name" : "theme", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + "(default", + "glow)" + ] + }, + { + "name" : "target", + "type" : "String", + "desc" : "target for a href. (_self|_blank|_parent|_top| other)", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + ] + }, + { + "name" : "glyphicon", + "type" : "String", + "desc" : "depricated - use fa", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "isClose", + "type" : "Boolean", + "desc" : "default false;", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "fa", + "type" : "String", + "desc" : "fontawesome icon - eg. 'comment' - without the fa/fas etc..", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + ] + }, + { + "name" : "size", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + "( lg", + "sm", + "xs)" + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "badge_weight", + "type" : "String", + "desc" : "default (same as button)", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + "(default", + "primary", + "secondary", + "success", + "info", + "warning", + "danger", + "link )" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "href", + "type" : "String", + "desc" : "empty or href", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + ] + }, + { + "name" : "tag", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + "( a", + "input", + "submit)" + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "outline", + "type" : "Boolean", + "desc" : "default false (except for weight=default which emulates old behaveiour with an outline)", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + ] + }, + { + "name" : "offtext", + "type" : "String", + "desc" : "text for off slidy toggle state", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + ] + }, + { + "name" : "removeClass", + "type" : "Boolean", + "desc" : "remove the standard class..", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "The button content", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + ] + }, + { + "name" : "pressed", + "type" : "Boolean", + "desc" : "default null - if the button ahs active state", + "memberOf" : "Roo.bootstrap.Button", + "values" : [ + "(true", + "false)" + ] + } + ], + "methods" : [ + { + "name" : "setText", + "desc" : "set the text of the first selected button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isActive", + "desc" : "get the current active state", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if it's active" + } + ] + }, + { + "name" : "setActive", + "desc" : "sets the active state on/off,", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "state", + "type" : "Boolean", + "desc" : "(optional) Force a particular state", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toggleActive", + "desc" : "toggles the current active state", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getText", + "desc" : "get the text of the first selected button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Enables this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Disable this button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "toggle", + "desc" : "After the button has been toggles", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "btn", + "type" : "Roo.bootstrap.Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "pressed", + "type" : "boolean", + "desc" : "(also available as button.pressed)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "When a butotn is pressed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "btn", + "type" : "Roo.bootstrap.Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.ButtonGroup.json b/docs2/symbols/Roo.bootstrap.ButtonGroup.json new file mode 100644 index 0000000000..a3d58f6e49 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.ButtonGroup.json @@ -0,0 +1,1037 @@ +{ + "name" : "Roo.bootstrap.ButtonGroup", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap ButtonGroup class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "btn", + "type" : "Boolean", + "desc" : "true | false", + "memberOf" : "Roo.bootstrap.ButtonGroup", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "vertical | justified (default none)", + "memberOf" : "Roo.bootstrap.ButtonGroup", + "values" : [ + ] + }, + { + "name" : "direction", + "type" : "String", + "desc" : "up | down (default down)", + "memberOf" : "Roo.bootstrap.ButtonGroup", + "values" : [ + ] + }, + { + "name" : "toolbar", + "type" : "Boolean", + "desc" : "false | true", + "memberOf" : "Roo.bootstrap.ButtonGroup", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "size", + "type" : "String", + "desc" : "lg | sm | xs (default empty normal)", + "memberOf" : "Roo.bootstrap.ButtonGroup", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "addItem", + "desc" : "Add a button to the group (similar to NavItem API.)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ButtonGroup", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Calendar.json b/docs2/symbols/Roo.bootstrap.Calendar.json new file mode 100644 index 0000000000..0c672ec907 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Calendar.json @@ -0,0 +1,1132 @@ +{ + "name" : "Roo.bootstrap.Calendar", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Calendar class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "startDay", + "type" : "Number", + "desc" : "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)", + "memberOf" : "Roo.bootstrap.Calendar", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "loadMask", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.Calendar", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "header", + "type" : "Object", + "desc" : "generate the user specific header of the calendar, default false", + "memberOf" : "Roo.bootstrap.Calendar", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "select", + "desc" : "Fires when a date is selected", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "DatePicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Date", + "desc" : "The selected date", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "eventclick", + "desc" : "Fires when the mouse click an", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Calendar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "", + "type" : "event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "monthchange", + "desc" : "Fires when the displayed month changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "DatePicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Date", + "desc" : "The selected month", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "evententer", + "desc" : "Fires when mouse over an event", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Calendar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "Event", + "type" : "event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "eventleave", + "desc" : "Fires when the mouse leaves an", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Calendar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "", + "type" : "event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.CheckBox.json b/docs2/symbols/Roo.bootstrap.CheckBox.json new file mode 100644 index 0000000000..115dd6a4ca --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.CheckBox.json @@ -0,0 +1,1935 @@ +{ + "name" : "Roo.bootstrap.CheckBox", + "augments" : [ + "Roo.bootstrap.Input", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap CheckBox class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "accept", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(image", + "video", + "audio)" + ] + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "inputValue", + "type" : "String", + "desc" : "The value that should go into the generated input element's value when checked.", + "memberOf" : "Roo.bootstrap.CheckBox", + "values" : [ + ] + }, + { + "name" : "weight", + "type" : "String", + "desc" : "The text that appears beside the checkbox", + "memberOf" : "Roo.bootstrap.CheckBox", + "values" : [ + "(primary", + "warning", + "info", + "danger", + "success)" + ] + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "String", + "desc" : "label tooltip", + "memberOf" : "Roo.bootstrap.CheckBox", + "values" : [ + ] + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(top", + "left)" + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "boxLabel", + "type" : "String", + "desc" : "The text that appears beside the checkbox", + "memberOf" : "Roo.bootstrap.CheckBox", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "groupId", + "type" : "String", + "desc" : "the checkbox group id // normal just use for checkbox", + "memberOf" : "Roo.bootstrap.CheckBox", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : "default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "Default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "center", + "right)" + ] + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "initnal the element", + "memberOf" : "Roo.bootstrap.CheckBox", + "values" : [ + ] + }, + { + "name" : "inline", + "type" : "Boolean", + "desc" : "inline the element (default false)", + "memberOf" : "Roo.bootstrap.CheckBox", + "values" : [ + ] + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "capture", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(user", + "camera)" + ] + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "valueOff", + "type" : "String", + "desc" : "The value that should go into the generated input element's value when unchecked.", + "memberOf" : "Roo.bootstrap.CheckBox", + "values" : [ + ] + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : "Default false", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "register", + "desc" : "register a CheckBox Group", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.CheckBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.CheckBox", + "desc" : "CheckBox to add", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "markValid", + "desc" : "Mark this field as valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.CheckBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "inputEl", + "desc" : "return the real input element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.CheckBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.CheckBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "get", + "desc" : "fetch a CheckBox Group based on the group ID", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.CheckBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "string", + "desc" : "group ID", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "getName", + "desc" : "Returns the name of the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "check", + "desc" : "Fires when the element is checked or unchecked.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.CheckBox", + "desc" : "This input", + "isOptional" : false + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "The new checked value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fires when the element is click.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.CheckBox", + "desc" : "This input", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Column.json b/docs2/symbols/Roo.bootstrap.Column.json new file mode 100644 index 0000000000..f9d4933515 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Column.json @@ -0,0 +1,1108 @@ +{ + "name" : "Roo.bootstrap.Column", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Column class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "hide the element", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + ] + }, + { + "name" : "xsoff", + "type" : "Number", + "desc" : "colspan offset out of 12 for mobile-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + ] + }, + { + "name" : "smoff", + "type" : "Number", + "desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + ] + }, + { + "name" : "mdoff", + "type" : "Number", + "desc" : "colspan offset out of 12 for computer-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + ] + }, + { + "name" : "lgoff", + "type" : "Number", + "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "content of column.", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "icon", + "type" : "String", + "desc" : "glyphicon name", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + "(info-sign", + "check", + "...)" + ] + }, + { + "name" : "alert", + "type" : "String", + "desc" : "type alert (changes background / border...)", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + "(success", + "info", + "warning", + "danger)" + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "fa", + "type" : "String", + "desc" : "font awesome icon", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + "(ban", + "check", + "...)" + ] + }, + { + "name" : "fasize", + "type" : "Number", + "desc" : "font awsome size", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + "(1", + "2", + "....)" + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.ComboBox.json b/docs2/symbols/Roo.bootstrap.ComboBox.json new file mode 100644 index 0000000000..6f9a877e69 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.ComboBox.json @@ -0,0 +1,2776 @@ +{ + "name" : "Roo.bootstrap.ComboBox", + "augments" : [ + "Roo.bootstrap.TriggerField", + "Roo.bootstrap.Input", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "A combobox control with support for autocomplete, remote-loading, paging and many other features.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "growMax", + "type" : "Number", + "desc" : "", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "capture", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(user", + "camera)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "queryDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "triggerAction", + "type" : "String", + "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "resizable", + "type" : "Boolean", + "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "mobileTouchView", + "type" : "Boolean", + "desc" : "show mobile touch view when using a mobile default true", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "editable", + "type" : "Boolean", + "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(top", + "left)" + ] + }, + { + "name" : "listWidth", + "type" : "Number", + "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "alwaysQuery", + "type" : "Boolean", + "desc" : "Disable caching of results, and always send query", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "handleHeight", + "type" : "Number", + "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "emptyResultText", + "type" : "Boolean", + "desc" : "only for touch device", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "queryParam", + "type" : "String", + "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "tpl", + "type" : "String/Roo.Template", + "desc" : "The template to use to render the output", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "selectedClass", + "type" : "String", + "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hiddenName", + "type" : "String", + "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "removable", + "type" : "Boolean", + "desc" : "special filter default false", + "memberOf" : "Roo.bootstrap.TriggerField", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "minChars", + "type" : "Number", + "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "animate", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "btnPosition", + "type" : "String", + "desc" : "set the position of the trigger button (left | right) default right", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disableClear", + "type" : "Boolean", + "desc" : "Disable showing of clear button.", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "lazyRender", + "type" : "Boolean", + "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : "default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "listAlign", + "type" : "String", + "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "showToggleBtn", + "type" : "Boolean", + "desc" : "show toggle button or not (true|false) default true", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "triggerList", + "type" : "Boolean", + "desc" : "trigger show the list or not (true|false) default true", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : "Default false", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "mode", + "type" : "String", + "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "typeAhead", + "type" : "Boolean", + "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "triggerText", + "type" : "String", + "desc" : "multiple combobox trigger button text default 'Select'", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be appended if specified.", + "memberOf" : "Roo.bootstrap.TriggerField", + "values" : [ + ] + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - uses BS4 is-valid now", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "modalTitle", + "type" : "String", + "desc" : "The title of the dialog that pops up on mobile views.", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "accept", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(image", + "video", + "audio)" + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "valueField", + "type" : "String", + "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "The data store to which this combo is bound (defaults to undefined)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - uses BS4 is-valid now", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "listClass", + "type" : "String", + "desc" : "CSS class to apply to the dropdown list element (defaults to '')", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "displayField", + "type" : "String", + "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "tickable", + "type" : "Boolean", + "desc" : "ComboBox with tickable selections (true|false), default false", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "specialFilter", + "type" : "Boolean", + "desc" : "special filter default false", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "emptyTitle", + "type" : "String", + "desc" : "default ''", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "typeAheadDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "loadingText", + "type" : "String", + "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "caret", + "type" : "String", + "desc" : "a fontawesome for the trigger icon see http://fortawesome.github.io/Font-Awesome/icons/", + "memberOf" : "Roo.bootstrap.TriggerField", + "values" : [ + "(search", + "calendar)" + ] + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "Roo.bootstrap.TriggerField", + "values" : [ + ] + }, + { + "name" : "minListWidth", + "type" : "Number", + "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "multiple", + "type" : "Boolean", + "desc" : "ComboBobArray, default false", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxHeight", + "type" : "Number", + "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "mobile_restrict_height", + "type" : "Boolean", + "desc" : "restrict height for touch view", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "valueNotFoundText", + "type" : "String", + "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "autoFocus", + "type" : "Boolean", + "desc" : "auto focus the first item, default true", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "pageSize", + "type" : "Number", + "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "useNativeIOS", + "type" : "Boolean", + "desc" : "render it as classic select for ios, not support dynamic load data (default false)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "forceSelection", + "type" : "Boolean", + "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "append", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allQuery", + "type" : "String", + "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "blockFocus", + "type" : "Boolean", + "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "Default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "center", + "right)" + ] + } + ], + "methods" : [ + { + "name" : "select", + "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The zero-based index of the list item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "expand", + "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "collapse", + "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Returns the currently selected field value or empty string if no value is set.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "value The selected value" + } + ] + }, + { + "name" : "selectByValue", + "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The data value of the item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value matched an item in the list, else false" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value to match", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setFromData", + "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Object", + "desc" : "the value to set as. or false on reset?", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setEditable", + "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean", + "desc" : "True to allow the user to directly edit the field text", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearValue", + "desc" : "Clears any text/value currently set in the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isExpanded", + "desc" : "Returns true if the dropdown list is expanded, else false.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "doQuery", + "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "query", + "type" : "String", + "desc" : "The SQL query to execute", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onTriggerClick", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autoSize", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "markValid", + "desc" : "Mark this field as valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name of the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "inputEl", + "desc" : "return the real input element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "edit", + "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record|false", + "desc" : "The data record returned from the underlying store (or false on nothing selected)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "afterremove", + "desc" : "Fires when the remove value from the combobox array", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "touchviewdisplay", + "desc" : "Fires when touch view require special display (default is using displayField)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "cfg", + "type" : "Object", + "desc" : "set html .", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforequery", + "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "query", + "type" : "String", + "desc" : "The query", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "true to force \"all\" query", + "isOptional" : false + }, + { + "name" : "cancel", + "type" : "Boolean", + "desc" : "true to cancel the query", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The query event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Fires when the remove value from the combobox array", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeselect", + "desc" : "Fires before a list item is selected. Return false to cancel the selection.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The data record returned from the underlying store", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the selected item in the dropdown list", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "tick", + "desc" : "Fires when tick the element", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "add", + "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "expand", + "desc" : "Fires when the dropdown list is expanded", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialfilter", + "desc" : "Fires when specialfilter", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collapse", + "desc" : "Fires when the dropdown list is collapsed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "select", + "desc" : "Fires when a list item is selected", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The data record returned from the underlying store (or false on clear)", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the selected item in the dropdown list", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Component.json b/docs2/symbols/Roo.bootstrap.Component.json new file mode 100644 index 0000000000..450a32b4e9 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Component.json @@ -0,0 +1,980 @@ +{ + "name" : "Roo.bootstrap.Component", + "augments" : [ + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Component base class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Container.json b/docs2/symbols/Roo.bootstrap.Container.json new file mode 100644 index 0000000000..52642fcdbc --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Container.json @@ -0,0 +1,1202 @@ +{ + "name" : "Roo.bootstrap.Container", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Container class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "panel", + "type" : "String", + "desc" : "render as panel - type - primary/success.....", + "memberOf" : "Roo.bootstrap.Container", + "values" : [ + "(default", + "primary", + "success", + "info", + "warning", + "danger)" + ] + }, + { + "name" : "footer", + "type" : "String", + "desc" : "content of footer (for panel)", + "memberOf" : "Roo.bootstrap.Container", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "jumbotron", + "type" : "Boolean", + "desc" : "is it a jumbotron element", + "memberOf" : "Roo.bootstrap.Container", + "values" : [ + ] + }, + { + "name" : "sticky", + "type" : "String", + "desc" : "block to use as footer or body- needs css-bootstrap/sticky-footer.css", + "memberOf" : "Roo.bootstrap.Container", + "values" : [ + "(footer", + "wrap", + "push)" + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "hide the element", + "memberOf" : "Roo.bootstrap.Container", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "expanded", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.Container", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "rheader", + "type" : "String", + "desc" : "contet on the right of header", + "memberOf" : "Roo.bootstrap.Container", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "tag", + "type" : "String", + "desc" : "type of HTML tag.", + "memberOf" : "Roo.bootstrap.Container", + "values" : [ + "(header", + "aside", + "section)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "well", + "type" : "String", + "desc" : "a well, large, small or medium.", + "memberOf" : "Roo.bootstrap.Container", + "values" : [ + "(lg", + "sm", + "md)" + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "content of element", + "memberOf" : "Roo.bootstrap.Container", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "clickable", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.Container", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "header", + "type" : "String", + "desc" : "content of header (for panel)", + "memberOf" : "Roo.bootstrap.Container", + "values" : [ + ] + }, + { + "name" : "icon", + "type" : "String", + "desc" : "glyphicon name", + "memberOf" : "Roo.bootstrap.Container", + "values" : [ + "(info-sign", + "check", + "...)" + ] + }, + { + "name" : "expandable", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.Container", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "alert", + "type" : "String", + "desc" : "type alert (changes background / border...)", + "memberOf" : "Roo.bootstrap.Container", + "values" : [ + "(success", + "info", + "warning", + "danger)" + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "fa", + "type" : "String", + "desc" : "font awesome icon", + "memberOf" : "Roo.bootstrap.Container", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "When a element is chick", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Container", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collapse", + "desc" : "After the panel has been collapsed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Container", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "expand", + "desc" : "After the panel has been expand", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Container", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.DateField.json b/docs2/symbols/Roo.bootstrap.DateField.json new file mode 100644 index 0000000000..22235bb2b2 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.DateField.json @@ -0,0 +1,1954 @@ +{ + "name" : "Roo.bootstrap.DateField", + "augments" : [ + "Roo.bootstrap.Input", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap DateField class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "accept", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(image", + "video", + "audio)" + ] + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "todayHighlight", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.DateField", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(top", + "left)" + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "altFormats", + "type" : "String", + "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').", + "memberOf" : "Roo.bootstrap.DateField", + "values" : [ + ] + }, + { + "name" : "viewMode", + "type" : "String", + "desc" : "default empty, (months|years)", + "memberOf" : "Roo.bootstrap.DateField", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "singleMode", + "type" : "Boolean", + "desc" : "default false (true | false)", + "memberOf" : "Roo.bootstrap.DateField", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "daysOfWeekDisabled", + "type" : "Object", + "desc" : "default empty", + "memberOf" : "Roo.bootstrap.DateField", + "values" : [ + ] + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "endDate", + "type" : "Number", + "desc" : "default Infinity", + "memberOf" : "Roo.bootstrap.DateField", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : "default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "Default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "center", + "right)" + ] + }, + { + "name" : "language", + "type" : "String", + "desc" : "default en", + "memberOf" : "Roo.bootstrap.DateField", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "keyboardNavigation", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.DateField", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "calendarWeeks", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.DateField", + "values" : [ + ] + }, + { + "name" : "minViewMode", + "type" : "String", + "desc" : "default empty, (months|years)", + "memberOf" : "Roo.bootstrap.DateField", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "startDate", + "type" : "Number", + "desc" : "default -Infinity", + "memberOf" : "Roo.bootstrap.DateField", + "values" : [ + ] + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "format", + "type" : "String", + "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').", + "memberOf" : "Roo.bootstrap.DateField", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "weekStart", + "type" : "Number", + "desc" : "default 0", + "memberOf" : "Roo.bootstrap.DateField", + "values" : [ + ] + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "capture", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(user", + "camera)" + ] + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "todayBtn", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.DateField", + "values" : [ + ] + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : "Default false", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "markValid", + "desc" : "Mark this field as valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name of the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "inputEl", + "desc" : "return the real input element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforeselect", + "desc" : "Fires when before select a date.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DateField", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Mixed", + "desc" : "The date value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires when this field show.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DateField", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Mixed", + "desc" : "The date value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "select", + "desc" : "Fires when select a date.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DateField", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Mixed", + "desc" : "The date value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.DateSplitField.json b/docs2/symbols/Roo.bootstrap.DateSplitField.json new file mode 100644 index 0000000000..f30cacb791 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.DateSplitField.json @@ -0,0 +1,1233 @@ +{ + "name" : "Roo.bootstrap.DateSplitField", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap DateSplitField class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "labelAlign", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.DateSplitField", + "values" : [ + "(top", + "left)" + ] + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.DateSplitField", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "yearPlaceholder", + "type" : "string", + "desc" : "", + "memberOf" : "Roo.bootstrap.DateSplitField", + "values" : [ + ] + }, + { + "name" : "monthFormat", + "type" : "string", + "desc" : "default 'm'", + "memberOf" : "Roo.bootstrap.DateSplitField", + "values" : [ + ] + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.DateSplitField", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.DateSplitField", + "values" : [ + ] + }, + { + "name" : "monthAllowBlank", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.DateSplitField", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label (0-12)", + "memberOf" : "Roo.bootstrap.DateSplitField", + "values" : [ + ] + }, + { + "name" : "monthPlaceholder", + "type" : "string", + "desc" : "", + "memberOf" : "Roo.bootstrap.DateSplitField", + "values" : [ + ] + }, + { + "name" : "yearFormat", + "type" : "string", + "desc" : "default 'Y'", + "memberOf" : "Roo.bootstrap.DateSplitField", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.DateSplitField", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dayAllowBlank", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.DateSplitField", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "yearAllowBlank", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.DateSplitField", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "dayPlaceholder", + "type" : "string", + "desc" : "", + "memberOf" : "Roo.bootstrap.DateSplitField", + "values" : [ + ] + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.DateSplitField", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "dayFormat", + "type" : "string", + "desc" : "default 'd'", + "memberOf" : "Roo.bootstrap.DateSplitField", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.DateSplitField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "days", + "desc" : "getting the data of days", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DateSplitField", + "desc" : "", + "isOptional" : false + }, + { + "name" : "days", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "years", + "desc" : "getting the data of years", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DateSplitField", + "desc" : "", + "isOptional" : false + }, + { + "name" : "years", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.DocumentManager.json b/docs2/symbols/Roo.bootstrap.DocumentManager.json new file mode 100644 index 0000000000..2d8cc2dccc --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.DocumentManager.json @@ -0,0 +1,1387 @@ +{ + "name" : "Roo.bootstrap.DocumentManager", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap DocumentManager class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "labelAlign", + "type" : "String", + "desc" : "default left", + "memberOf" : "Roo.bootstrap.DocumentManager", + "values" : [ + "(left", + "top)" + ] + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.DocumentManager", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.DocumentManager", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.DocumentManager", + "values" : [ + ] + }, + { + "name" : "toolTipName", + "type" : "String", + "desc" : "default 'filename'", + "memberOf" : "Roo.bootstrap.DocumentManager", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "method", + "type" : "String", + "desc" : "default POST", + "memberOf" : "Roo.bootstrap.DocumentManager", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "paramName", + "type" : "String", + "desc" : "default 'imageUpload'", + "memberOf" : "Roo.bootstrap.DocumentManager", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "default 4", + "memberOf" : "Roo.bootstrap.DocumentManager", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "editable", + "type" : "Boolean", + "desc" : "allow edit when upload a image default true", + "memberOf" : "Roo.bootstrap.DocumentManager", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.DocumentManager", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "boxes", + "type" : "Number", + "desc" : "number of boxes, 0 is no limit.. default 0", + "memberOf" : "Roo.bootstrap.DocumentManager", + "values" : [ + ] + }, + { + "name" : "multiple", + "type" : "Boolean", + "desc" : "multiple upload default true", + "memberOf" : "Roo.bootstrap.DocumentManager", + "values" : [ + ] + }, + { + "name" : "thumbSize", + "type" : "Number", + "desc" : "default 300", + "memberOf" : "Roo.bootstrap.DocumentManager", + "values" : [ + ] + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.DocumentManager", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "action url", + "memberOf" : "Roo.bootstrap.DocumentManager", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "refresh", + "desc" : "Fire after refresh the file", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "afterupload", + "desc" : "Fire when xhr load exception", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + }, + { + "name" : "xhr", + "type" : "XMLHttpRequest", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeselectfile", + "desc" : "Fire before select file", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Fire when remove the file", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + }, + { + "name" : "file", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "process", + "desc" : "Fire before process file", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + }, + { + "name" : "file", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "inspect", + "desc" : "inspect selected file", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + }, + { + "name" : "file", + "type" : "File", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "initial", + "desc" : "Fire when initial the DocumentManager", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "exception", + "desc" : "Fire when xhr load exception", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + }, + { + "name" : "xhr", + "type" : "XMLHttpRequest", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "prepare", + "desc" : "prepare the form data", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + }, + { + "name" : "formData", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fire after click the image", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + }, + { + "name" : "file", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "edit", + "desc" : "Fire when upload a image and editable set to true", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + }, + { + "name" : "file", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "previewrendered", + "desc" : "Fire when preview rendered", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + }, + { + "name" : "file", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.DocumentSlider.json b/docs2/symbols/Roo.bootstrap.DocumentSlider.json new file mode 100644 index 0000000000..2a2a027405 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.DocumentSlider.json @@ -0,0 +1,1038 @@ +{ + "name" : "Roo.bootstrap.DocumentSlider", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap DocumentSlider class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "Fire after click", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentSlider", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "initial", + "desc" : "Fire after initEvent", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentSlider", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "update", + "desc" : "Fire after update", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentSlider", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.DocumentViewer.json b/docs2/symbols/Roo.bootstrap.DocumentViewer.json new file mode 100644 index 0000000000..80a8896a2e --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.DocumentViewer.json @@ -0,0 +1,1077 @@ +{ + "name" : "Roo.bootstrap.DocumentViewer", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap DocumentViewer class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "showTrash", + "type" : "Boolean", + "desc" : "show trash button (default true)", + "memberOf" : "Roo.bootstrap.DocumentViewer", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "showDownload", + "type" : "Boolean", + "desc" : "show download button (default true)", + "memberOf" : "Roo.bootstrap.DocumentViewer", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "download", + "desc" : "Fire after download button", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentViewer", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "initial", + "desc" : "Fire after initEvent", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentViewer", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "trash", + "desc" : "Fire after trash button", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentViewer", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fire after click", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentViewer", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Element.json b/docs2/symbols/Roo.bootstrap.Element.json new file mode 100644 index 0000000000..7f31cba277 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Element.json @@ -0,0 +1,1042 @@ +{ + "name" : "Roo.bootstrap.Element", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Element class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "tag", + "type" : "String", + "desc" : "tag of the element", + "memberOf" : "Roo.bootstrap.Element", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "class of the element", + "memberOf" : "Roo.bootstrap.Element", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "contents of the element", + "memberOf" : "Roo.bootstrap.Element", + "values" : [ + ] + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.Element", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "clickable", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.Element", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "When a element is chick", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.FieldLabel.json b/docs2/symbols/Roo.bootstrap.FieldLabel.json new file mode 100644 index 0000000000..7e36ae3cd1 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.FieldLabel.json @@ -0,0 +1,1175 @@ +{ + "name" : "Roo.bootstrap.FieldLabel", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap FieldLabel class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - BS4 uses is-valid", + "memberOf" : "Roo.bootstrap.FieldLabel", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "tag", + "type" : "String", + "desc" : "tag of the element default label", + "memberOf" : "Roo.bootstrap.FieldLabel", + "values" : [ + ] + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : "default left", + "memberOf" : "Roo.bootstrap.FieldLabel", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "class of the element", + "memberOf" : "Roo.bootstrap.FieldLabel", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "contents of the element", + "memberOf" : "Roo.bootstrap.FieldLabel", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "target allowBlank default true", + "memberOf" : "Roo.bootstrap.FieldLabel", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - BS4 uses is-invalid", + "memberOf" : "Roo.bootstrap.FieldLabel", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "iconTooltip", + "type" : "String", + "desc" : "default \"This field is required\"", + "memberOf" : "Roo.bootstrap.FieldLabel", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "target", + "type" : "String", + "desc" : "label target", + "memberOf" : "Roo.bootstrap.FieldLabel", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "markValid", + "desc" : "Mark this field as valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.FieldLabel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "get", + "desc" : "fetch a FieldLabel Group based on the target", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.FieldLabel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "string", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.FieldLabel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "register", + "desc" : "register a FieldLabel Group", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.FieldLabel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.FieldLabel", + "desc" : "FieldLabel to add", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.FieldLabel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.FieldLabel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Form.json b/docs2/symbols/Roo.bootstrap.Form.json new file mode 100644 index 0000000000..990c7f0508 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Form.json @@ -0,0 +1,1417 @@ +{ + "name" : "Roo.bootstrap.Form", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Form class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "labelAlign", + "type" : "String", + "desc" : "top | left (default top)", + "memberOf" : "Roo.bootstrap.Form", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "fileUpload", + "type" : "Boolean", + "desc" : "Set to true if this form is a file upload.", + "memberOf" : "Roo.bootstrap.Form", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "left | right - for navbars", + "memberOf" : "Roo.bootstrap.Form", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "method", + "type" : "String", + "desc" : "GET | POST (default POST)", + "memberOf" : "Roo.bootstrap.Form", + "values" : [ + ] + }, + { + "name" : "errorMask", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.Form", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "timeout", + "type" : "Number", + "desc" : "Timeout for form actions in seconds (default is 30 seconds).", + "memberOf" : "Roo.bootstrap.Form", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "loadMask", + "type" : "Boolean", + "desc" : "load mask when submit (default true)", + "memberOf" : "Roo.bootstrap.Form", + "values" : [ + ] + }, + { + "name" : "baseParams", + "type" : "Object", + "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.", + "memberOf" : "Roo.bootstrap.Form", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "maskBody", + "type" : "Boolean", + "desc" : "", + "memberOf" : "Roo.bootstrap.Form", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "The URL to use for form actions if one isn't supplied in the action options.", + "memberOf" : "Roo.bootstrap.Form", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "maskOffset", + "type" : "Number", + "desc" : "Default 100", + "memberOf" : "Roo.bootstrap.Form", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "doAction", + "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "actionName", + "type" : "String", + "desc" : "The name of the action type", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n
\nProperty          Type             Description\n----------------  ---------------  ----------------------------------------------------------------------------------\nurl               String           The url for the action (defaults to the form's url)\nmethod            String           The form method to use (defaults to the form's method, or POST if not defined)\nparams            String/Object    The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation  Boolean          Applies to submit only.  Pass true to call form.isValid() prior to posting to\n                                   validate the form on the client (defaults to false)\n
", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "setValues", + "desc" : "Set values for fields in this form in bulk.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "values", + "type" : "Array/Object", + "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "getFieldValues", + "desc" : "Returns the fields in this form as an object with key/value pairs.\nThis differs from getValues as it calls getValue on each child item, rather than using dom data.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark fields in this form invalid in bulk.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "errors", + "type" : "Array/Object", + "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clears all invalid messages in this form.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "findField", + "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The value to search for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Field" + } + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if any fields in this form have changed since their original load.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets this form.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "getValues", + "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "asString", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] + }, + { + "name" : "isValid", + "desc" : "Returns true if client-side validation on the form is successful.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "actionfailed", + "desc" : "Fires when an action fails.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "action", + "type" : "Action", + "desc" : "The action that failed", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "actioncomplete", + "desc" : "Fires when an action is completed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "action", + "type" : "Action", + "desc" : "The action that completed", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeaction", + "desc" : "Fires before any action is performed. Return false to cancel the action.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "action", + "type" : "Action", + "desc" : "The action to be performed", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clientvalidation", + "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "valid", + "type" : "Boolean", + "desc" : "true if the form has passed client-side validation", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Graph.json b/docs2/symbols/Roo.bootstrap.Graph.json new file mode 100644 index 0000000000..c736b7f8b1 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Graph.json @@ -0,0 +1,1056 @@ +{ + "name" : "Roo.bootstrap.Graph", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Graph class\n> Prameters\n -sm {number} sm 4\n -md {number} md 5", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "g_y", + "type" : "number", + "desc" : "coodinator | centre y (pie)", + "memberOf" : "Roo.bootstrap.Graph", + "values" : [ + ] + }, + { + "name" : "g_height", + "type" : "number", + "desc" : "height of the chart (respected by all elements in the set)", + "memberOf" : "Roo.bootstrap.Graph", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "g_r", + "type" : "number", + "desc" : "radius (pie)", + "memberOf" : "Roo.bootstrap.Graph", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "Object", + "desc" : "The title of the chart\n \n -{Array} values\n -opts (object) options for the chart \n o {\n o type (string) type of endings of the bar. Default: 'square'. Other options are: 'round', 'sharp', 'soft'.\n o gutter (number)(string) default '20%' (WHAT DOES IT DO?)\n o vgutter (number)\n o colors (array) colors be used repeatedly to plot the bars. If multicolumn bar is used each sequence of bars with use a different color.\n o stacked (boolean) whether or not to tread values as in a stacked bar chart\n o to\n o stretch (boolean)\n o }\n -opts (object) options for the pie\n o{\n o cut\n o startAngle (number)\n o endAngle (number)\n }", + "memberOf" : "Roo.bootstrap.Graph", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "graphtype", + "type" : "String", + "desc" : "bar | vbar | pie", + "memberOf" : "Roo.bootstrap.Graph", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "g_width", + "type" : "number", + "desc" : "width of the chart (respected by all elements in the set)", + "memberOf" : "Roo.bootstrap.Graph", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "g_x", + "type" : "number", + "desc" : "coodinator | centre x (pie)", + "memberOf" : "Roo.bootstrap.Graph", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "The img click event for the img.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Header.json b/docs2/symbols/Roo.bootstrap.Header.json new file mode 100644 index 0000000000..d9172faff9 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Header.json @@ -0,0 +1,1003 @@ +{ + "name" : "Roo.bootstrap.Header", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Header class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "level", + "type" : "Number", + "desc" : "default 1", + "memberOf" : "Roo.bootstrap.Header", + "values" : [ + "(1", + "2", + "3", + "4", + "5", + "6)" + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "content of header", + "memberOf" : "Roo.bootstrap.Header", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.HtmlEditor.json b/docs2/symbols/Roo.bootstrap.HtmlEditor.json new file mode 100644 index 0000000000..751727f5b4 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.HtmlEditor.json @@ -0,0 +1,2092 @@ +{ + "name" : "Roo.bootstrap.HtmlEditor", + "augments" : [ + "Roo.bootstrap.TextArea", + "Roo.bootstrap.Input", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap HtmlEditor class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "accept", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(image", + "video", + "audio)" + ] + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "resizable", + "type" : "String", + "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.", + "memberOf" : "Roo.bootstrap.HtmlEditor", + "values" : [ + ] + }, + { + "name" : "toolbars", + "type" : "Array", + "desc" : "Array of toolbars. - defaults to just the Standard one", + "memberOf" : "Roo.bootstrap.HtmlEditor", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "(in pixels)", + "memberOf" : "Roo.bootstrap.HtmlEditor", + "values" : [ + ] + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(top", + "left)" + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "(in pixels)", + "memberOf" : "Roo.bootstrap.HtmlEditor", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : "default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "Default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "center", + "right)" + ] + }, + { + "name" : "wrap", + "type" : "string", + "desc" : "Specifies how the text in a text area is to be wrapped when submitted in a form", + "memberOf" : "Roo.bootstrap.TextArea", + "values" : [ + "(soft", + "hard)" + ] + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "buttons", + "type" : "Array", + "desc" : "Array of toolbar's buttons. - defaults to empty", + "memberOf" : "Roo.bootstrap.HtmlEditor", + "values" : [ + ] + }, + { + "name" : "rows", + "type" : "Number", + "desc" : "Specifies the visible number of lines in a text area", + "memberOf" : "Roo.bootstrap.TextArea", + "values" : [ + ] + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "cols", + "type" : "Number", + "desc" : "Specifies the visible width of a text area", + "memberOf" : "Roo.bootstrap.TextArea", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "stylesheets", + "type" : "Array", + "desc" : "url of stylesheets. set to [] to disable stylesheets.", + "memberOf" : "Roo.bootstrap.HtmlEditor", + "values" : [ + ] + }, + { + "name" : "resize", + "type" : "string", + "desc" : "", + "memberOf" : "Roo.bootstrap.TextArea", + "values" : [ + "(none", + "both", + "horizontal", + "vertical", + "inherit", + "initial)" + ] + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "capture", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(user", + "camera)" + ] + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "string", + "desc" : "text", + "memberOf" : "Roo.bootstrap.TextArea", + "values" : [ + ] + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : "Default false", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "toggleSourceEdit", + "desc" : "Toggles the editor between standard and source edit mode.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.HtmlEditor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sourceEdit", + "type" : "Boolean", + "desc" : "(optional) True for source edit, false for standard", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "createToolbar", + "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.HtmlEditor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "editor", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "inputEl", + "desc" : "return the real textarea element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TextArea", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TextArea", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "markValid", + "desc" : "Mark this field as valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TextArea", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TextArea", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "getName", + "desc" : "Returns the name of the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "initialize", + "desc" : "Fires when the editor is fully initialized (including the iframe)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforesync", + "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "push", + "desc" : "Fires when the iframe editor is updated with content from the textarea.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "editorevent", + "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "sync", + "desc" : "Fires when the textarea is updated with content from the editor iframe.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autosave", + "desc" : "Auto save the htmlEditor value as a file into Events", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "savedpreview", + "desc" : "preview the saved version of htmlEditor", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "editmodechange", + "desc" : "Fires when the editor switches edit modes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "sourceEdit", + "type" : "Boolean", + "desc" : "True if source edit, false if standard editing.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "firstfocus", + "desc" : "Fires when on first focus - needed by toolbars..", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforepush", + "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Img.json b/docs2/symbols/Roo.bootstrap.Img.json new file mode 100644 index 0000000000..4d9139065e --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Img.json @@ -0,0 +1,1106 @@ +{ + "name" : "Roo.bootstrap.Img", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Img class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "src", + "type" : "String", + "desc" : "image source", + "memberOf" : "Roo.bootstrap.Img", + "values" : [ + ] + }, + { + "name" : "border", + "type" : "String", + "desc" : "rounded | circle | thumbnail", + "memberOf" : "Roo.bootstrap.Img", + "values" : [ + ] + }, + { + "name" : "xsUrl", + "type" : "String", + "desc" : "xs image source", + "memberOf" : "Roo.bootstrap.Img", + "values" : [ + ] + }, + { + "name" : "smUrl", + "type" : "String", + "desc" : "sm image source", + "memberOf" : "Roo.bootstrap.Img", + "values" : [ + ] + }, + { + "name" : "mdUrl", + "type" : "String", + "desc" : "md image source", + "memberOf" : "Roo.bootstrap.Img", + "values" : [ + ] + }, + { + "name" : "lgUrl", + "type" : "String", + "desc" : "lg image source", + "memberOf" : "Roo.bootstrap.Img", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "imgResponsive", + "type" : "Boolean", + "desc" : "false | true", + "memberOf" : "Roo.bootstrap.Img", + "values" : [ + ] + }, + { + "name" : "alt", + "type" : "String", + "desc" : "image alternative text", + "memberOf" : "Roo.bootstrap.Img", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "target", + "type" : "String", + "desc" : "target for a href.", + "memberOf" : "Roo.bootstrap.Img", + "values" : [ + "(_self", + "_blank", + "_parent", + "_top)" + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "href", + "type" : "String", + "desc" : "a tag href", + "memberOf" : "Roo.bootstrap.Img", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "setSrc", + "desc" : "Sets the url of the image - used to update it", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Img", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "String", + "desc" : "the url of the image", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "The img click event for the img.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Input.json b/docs2/symbols/Roo.bootstrap.Input.json new file mode 100644 index 0000000000..1432044018 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Input.json @@ -0,0 +1,1785 @@ +{ + "name" : "Roo.bootstrap.Input", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Input class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "accept", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(image", + "video", + "audio)" + ] + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(top", + "left)" + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : "default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "Default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "center", + "right)" + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "capture", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(user", + "camera)" + ] + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : "Default false", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "markValid", + "desc" : "Mark this field as valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name of the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "inputEl", + "desc" : "return the real input element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.LayoutMasonry.json b/docs2/symbols/Roo.bootstrap.LayoutMasonry.json new file mode 100644 index 0000000000..1ad377b397 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.LayoutMasonry.json @@ -0,0 +1,1244 @@ +{ + "name" : "Roo.bootstrap.LayoutMasonry", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Layout Masonry class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "alternativePadWidth", + "type" : "Number", + "desc" : "padding below box..", + "memberOf" : "Roo.bootstrap.LayoutMasonry", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "maxCols", + "type" : "Number", + "desc" : "maximum number of columns", + "memberOf" : "Roo.bootstrap.LayoutMasonry", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "isLayoutInstant", + "type" : "Boolean", + "desc" : "= no animation?", + "memberOf" : "Roo.bootstrap.LayoutMasonry", + "values" : [ + ] + }, + { + "name" : "boxWidth", + "type" : "Number", + "desc" : "width of the columns", + "memberOf" : "Roo.bootstrap.LayoutMasonry", + "values" : [ + ] + }, + { + "name" : "isHorizontal", + "type" : "Boolean", + "desc" : "defalut false", + "memberOf" : "Roo.bootstrap.LayoutMasonry", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "isAutoInitial", + "type" : "Boolean", + "desc" : "defalut true", + "memberOf" : "Roo.bootstrap.LayoutMasonry", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "padWidth", + "type" : "Number", + "desc" : "padding below box..", + "memberOf" : "Roo.bootstrap.LayoutMasonry", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "gutter", + "type" : "Number", + "desc" : "gutter width..", + "memberOf" : "Roo.bootstrap.LayoutMasonry", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "boxHeight", + "type" : "Number", + "desc" : "- 0 for square, or fix it at a certian height", + "memberOf" : "Roo.bootstrap.LayoutMasonry", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "removeBrick", + "desc" : "remove a Masonry Brick", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.LayoutMasonry", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.MasonryBrick", + "desc" : "masonry brick to remove", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "_processVerticalLayoutQueue", + "desc" : "Sets position of item in DOM", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.LayoutMasonry", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "item", + "type" : "Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "- horizontal position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "- vertical position", + "isOptional" : false + }, + { + "name" : "isInstant", + "type" : "Boolean", + "desc" : "- disables transitions", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addBrick", + "desc" : "adds a Masonry Brick", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.LayoutMasonry", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.MasonryBrick", + "desc" : "masonry brick to add", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "register", + "desc" : "register a Masonry Brick", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.LayoutMasonry", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.MasonryBrick", + "desc" : "masonry brick to add", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearAll", + "desc" : "clear all the Masonry Brick", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.LayoutMasonry", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "register", + "desc" : "register a Masonry Layout", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.LayoutMasonry", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.LayoutMasonry", + "desc" : "masonry layout to add", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "get", + "desc" : "fetch a Masonry Layout based on the masonry layout ID", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.LayoutMasonry", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "string", + "desc" : "masonry layout to add", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "layout", + "desc" : "Fire after layout the items", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LayoutMasonry", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.LayoutMasonryAuto.json b/docs2/symbols/Roo.bootstrap.LayoutMasonryAuto.json new file mode 100644 index 0000000000..edebeeea74 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.LayoutMasonryAuto.json @@ -0,0 +1,1131 @@ +{ + "name" : "Roo.bootstrap.LayoutMasonryAuto", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Layout Masonry class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "isResizingContainer", + "type" : "Boolean", + "desc" : "= not sure if this is used..", + "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "maxCols", + "type" : "Number", + "desc" : "maximum number of columns", + "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", + "values" : [ + ] + }, + { + "name" : "isOriginLeft", + "type" : "Boolean", + "desc" : "= left align?", + "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "isLayoutInstant", + "type" : "Boolean", + "desc" : "= no animation?", + "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", + "values" : [ + ] + }, + { + "name" : "padHeight", + "type" : "Number", + "desc" : "padding below box..", + "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "isAutoInitial", + "type" : "Boolean", + "desc" : "defalut true", + "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "columnWidth", + "type" : "Number", + "desc" : "width of the columns", + "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "isOriginTop", + "type" : "Boolean", + "desc" : "= top align?", + "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "isFitWidth", + "type" : "Boolean", + "desc" : "- resize the width..", + "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "_postLayout", + "desc" : "Any logic you want to do after each layout,\ni.e. size the container", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "_processLayoutQueue", + "desc" : "Sets position of item in DOM", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "item", + "type" : "Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "- horizontal position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "- vertical position", + "isOptional" : false + }, + { + "name" : "isInstant", + "type" : "Boolean", + "desc" : "- disables transitions", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "_getColGroup", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "colSpan", + "type" : "Number", + "desc" : "- number of columns the element spans", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Link.json b/docs2/symbols/Roo.bootstrap.Link.json new file mode 100644 index 0000000000..03114c9ac0 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Link.json @@ -0,0 +1,1062 @@ +{ + "name" : "Roo.bootstrap.Link", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Link Class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "anchor", + "type" : "String", + "desc" : "name for the anchor link", + "memberOf" : "Roo.bootstrap.Link", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "the content of the link.", + "memberOf" : "Roo.bootstrap.Link", + "values" : [ + ] + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.Link", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "alt", + "type" : "String", + "desc" : "image alternative text", + "memberOf" : "Roo.bootstrap.Link", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "target", + "type" : "String", + "desc" : "target for a href.", + "memberOf" : "Roo.bootstrap.Link", + "values" : [ + "(_self", + "_blank", + "_parent", + "_top)" + ] + }, + { + "name" : "fa", + "type" : "String", + "desc" : "- favicon", + "memberOf" : "Roo.bootstrap.Link", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "href", + "type" : "String", + "desc" : "a tag href", + "memberOf" : "Roo.bootstrap.Link", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "The img click event for the img.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.LocationPicker.json b/docs2/symbols/Roo.bootstrap.LocationPicker.json new file mode 100644 index 0000000000..18d856e505 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.LocationPicker.json @@ -0,0 +1,1382 @@ +{ + "name" : "Roo.bootstrap.LocationPicker", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap LocationPicker class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "streetViewControl", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.LocationPicker", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "disableDoubleClickZoom", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.LocationPicker", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "latitude", + "type" : "Number", + "desc" : "Position when init default 0", + "memberOf" : "Roo.bootstrap.LocationPicker", + "values" : [ + ] + }, + { + "name" : "enableAutocomplete", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.LocationPicker", + "values" : [ + ] + }, + { + "name" : "markerTitle", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.LocationPicker", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "zoom", + "type" : "Number", + "desc" : "default 15", + "memberOf" : "Roo.bootstrap.LocationPicker", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "longitude", + "type" : "Number", + "desc" : "Position when init default 0", + "memberOf" : "Roo.bootstrap.LocationPicker", + "values" : [ + ] + }, + { + "name" : "mapTypeControl", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.LocationPicker", + "values" : [ + ] + }, + { + "name" : "radius", + "type" : "Number", + "desc" : "default 0", + "memberOf" : "Roo.bootstrap.LocationPicker", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "mapTypeId", + "type" : "String", + "desc" : "default google.maps.MapTypeId.ROADMAP", + "memberOf" : "Roo.bootstrap.LocationPicker", + "values" : [ + ] + }, + { + "name" : "scrollwheel", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.LocationPicker", + "values" : [ + ] + }, + { + "name" : "locationName", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.LocationPicker", + "values" : [ + ] + }, + { + "name" : "enableReverseGeocode", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.LocationPicker", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "draggable", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.LocationPicker", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "mapRightClick", + "desc" : "Fires when right click the map.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Map event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mapClick", + "desc" : "Fires when click the map.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Map event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires when the map resize.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "OverlayViewOnRemove", + "desc" : "Fires when OverlayView Draw", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "OverlayViewDraw", + "desc" : "Fires when OverlayView Draw", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "OverlayViewOnAdd", + "desc" : "Fires when OverlayView Draw", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "OverlayViewHide", + "desc" : "Fires when OverlayView Draw", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "OverlayViewShow", + "desc" : "Fires when OverlayView Draw", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "cpx", + "type" : "Pixel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "initial", + "desc" : "Fires when the picker initialized.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "location", + "type" : "Google Location", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "positionchanged", + "desc" : "Fires when the picker position changed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "location", + "type" : "Google Location", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "markerClick", + "desc" : "Fires when click the marker.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Map event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "loadexception", + "desc" : "Fires when load google lib failed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires when the map hide.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "markerRightClick", + "desc" : "Fires when right click the marker.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Map event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires when the map show.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.MasonryBrick.json b/docs2/symbols/Roo.bootstrap.MasonryBrick.json new file mode 100644 index 0000000000..d3f4aab7ec --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.MasonryBrick.json @@ -0,0 +1,1139 @@ +{ + "name" : "Roo.bootstrap.MasonryBrick", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap MasonryBrick class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "placetitle", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.MasonryBrick", + "values" : [ + "(center", + "bottom)" + ] + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "defalut false", + "memberOf" : "Roo.bootstrap.MasonryBrick", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.MasonryBrick", + "values" : [ + ] + }, + { + "name" : "videourl", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.MasonryBrick", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.MasonryBrick", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.MasonryBrick", + "values" : [ + ] + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : "defalut false", + "memberOf" : "Roo.bootstrap.MasonryBrick", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "size", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.MasonryBrick", + "values" : [ + "(xs", + "sm", + "md", + "md-left", + "md-right", + "tall", + "wide)" + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "bgimage", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.MasonryBrick", + "values" : [ + ] + }, + { + "name" : "isFitContainer", + "type" : "Boolean", + "desc" : "defalut true", + "memberOf" : "Roo.bootstrap.MasonryBrick", + "values" : [ + ] + }, + { + "name" : "href", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.MasonryBrick", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "register", + "desc" : "register a Masonry Brick", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.MasonryBrick", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.MasonryBrick", + "desc" : "masonry brick to add", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "get", + "desc" : "fetch a masonry brick based on the masonry brick ID", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.MasonryBrick", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "string", + "desc" : "masonry brick to add", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "When a MasonryBrick is clcik", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.MasonryBrick", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Menu.json b/docs2/symbols/Roo.bootstrap.Menu.json new file mode 100644 index 0000000000..d5226f7f9f --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Menu.json @@ -0,0 +1,1198 @@ +{ + "name" : "Roo.bootstrap.Menu", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Menu class - container for MenuItems", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "isLink", + "type" : "bool", + "desc" : "the menu has link disable auto expand and collaspe (default false)", + "memberOf" : "Roo.bootstrap.Menu", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "hidden", + "type" : "bool", + "desc" : "if the menu should be hidden when rendered.", + "memberOf" : "Roo.bootstrap.Menu", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "stopEvent", + "type" : "bool", + "desc" : "Stop event after trigger press (default true)", + "memberOf" : "Roo.bootstrap.Menu", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "registerMenu", + "type" : "Boolean", + "desc" : "True (default) - means that clicking on screen etc. hides it.", + "memberOf" : "Roo.bootstrap.Menu", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "type", + "type" : "String", + "desc" : "type of menu", + "memberOf" : "Roo.bootstrap.Menu", + "values" : [ + "(dropdown", + "treeview", + "submenu)" + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "hide", + "desc" : "Hides this menu and optionally all parent menus", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "showAt", + "desc" : "Displays this menu at a specific xy position", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "xyPosition", + "type" : "Array", + "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "parentMenu", + "type" : "Roo.menu.Menu", + "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Displays this menu relative to another element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)", + "isOptional" : false + }, + { + "name" : "parentMenu", + "type" : "Roo.menu.Menu", + "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "mouseout", + "desc" : "Fires when the mouse exits this menu", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseover", + "desc" : "Fires when the mouse is hovering over this menu", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after this menu is hidden", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after this menu is displayed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before this menu is hidden", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "itemclick", + "desc" : "Fires when a menu item contained in this menu is clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "baseItem", + "type" : "Roo.menu.BaseItem", + "desc" : "The BaseItem that was clicked", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before this menu is displayed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.MenuItem.json b/docs2/symbols/Roo.bootstrap.MenuItem.json new file mode 100644 index 0000000000..824bd958ad --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.MenuItem.json @@ -0,0 +1,1062 @@ +{ + "name" : "Roo.bootstrap.MenuItem", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap MenuItem class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "isContainer", + "type" : "Boolean", + "desc" : "is it a container - just returns a drop down item..", + "memberOf" : "Roo.bootstrap.MenuItem", + "values" : [ + ] + }, + { + "name" : "menu", + "type" : "Roo.bootsrap.Menu", + "desc" : "the child menu.", + "memberOf" : "Roo.bootstrap.MenuItem", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : "do not trigger A href on clicks (default false).", + "memberOf" : "Roo.bootstrap.MenuItem", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "the menu label", + "memberOf" : "Roo.bootstrap.MenuItem", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : "used on sidebars to highlight active itesm", + "memberOf" : "Roo.bootstrap.MenuItem", + "values" : [ + ] + }, + { + "name" : "fa", + "type" : "String", + "desc" : "favicon to show on left of menu item.", + "memberOf" : "Roo.bootstrap.MenuItem", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "href", + "type" : "String", + "desc" : "the link", + "memberOf" : "Roo.bootstrap.MenuItem", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "The raw click event for the entire grid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.MenuItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.MenuMgr.json b/docs2/symbols/Roo.bootstrap.MenuMgr.json new file mode 100644 index 0000000000..1a7427d5cf --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.MenuMgr.json @@ -0,0 +1,53 @@ +{ + "name" : "Roo.bootstrap.MenuMgr", + "augments" : [ + ], + "desc" : "Provides a common registry of all menu items on a page so that they can be easily accessed by id.", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "hideAll", + "desc" : "Hides all menus that are currently visible", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.MenuMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "get", + "desc" : "Returns a {@link Roo.menu.Menu} object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.MenuMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "menu", + "type" : "String/Object", + "desc" : "The string menu id, an existing menu object reference, or a Menu config that will\nbe used to generate and return a new Menu instance.", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.MenuSeparator.json b/docs2/symbols/Roo.bootstrap.MenuSeparator.json new file mode 100644 index 0000000000..6a0fe0935b --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.MenuSeparator.json @@ -0,0 +1,981 @@ +{ + "name" : "Roo.bootstrap.MenuSeparator", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap MenuSeparator class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.MessageBar.json b/docs2/symbols/Roo.bootstrap.MessageBar.json new file mode 100644 index 0000000000..0b3fcf8bd8 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.MessageBar.json @@ -0,0 +1,1029 @@ +{ + "name" : "Roo.bootstrap.MessageBar", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap MessageBar class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "beforeClass", + "type" : "String", + "desc" : "insert the bar before the given class", + "memberOf" : "Roo.bootstrap.MessageBar", + "values" : [ + ] + }, + { + "name" : "fixed", + "type" : "Boolean", + "desc" : "default false, fix the bar at the top", + "memberOf" : "Roo.bootstrap.MessageBar", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "contents of the MessageBar", + "memberOf" : "Roo.bootstrap.MessageBar", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.MessageBar", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "weight", + "type" : "String", + "desc" : "default info", + "memberOf" : "Roo.bootstrap.MessageBar", + "values" : [ + "(info", + "success", + "warning", + "danger)" + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.MessageBox.json b/docs2/symbols/Roo.bootstrap.MessageBox.json new file mode 100644 index 0000000000..a11128748b --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.MessageBox.json @@ -0,0 +1,367 @@ +{ + "name" : "Roo.bootstrap.MessageBox", + "augments" : [ + ], + "desc" : "Utility class for generating different styles of message boxes. The alias Roo.Msg can also be used.\nExample usage:\n
\n// Basic alert:\nRoo.Msg.alert('Status', 'Changes saved successfully.');\n\n// Prompt for user data:\nRoo.Msg.prompt('Name', 'Please enter your name:', function(btn, text){\n    if (btn == 'ok'){\n        // process text value...\n    }\n});\n\n// Show a dialog using config options:\nRoo.Msg.show({\n   title:'Save Changes?',\n   msg: 'Your are closing a tab that has unsaved changes. Would you like to save your changes?',\n   buttons: Roo.Msg.YESNOCANCEL,\n   fn: processResult,\n   animEl: 'elId'\n});\n
", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "alert", + "desc" : "Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).\nIf a callback function is passed it will be called after the user clicks the button, and the\nid of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.MessageBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "The title bar text", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The message box body text", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "(optional) The callback function invoked after the message box is closed", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the callback function", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.MessageBox", + "desc" : "This message box" + } + ] + }, + { + "name" : "confirm", + "desc" : "Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).\nIf a callback function is passed it will be called after the user clicks either button, and the id of the\nbutton that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.MessageBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "The title bar text", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The message box body text", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "(optional) The callback function invoked after the message box is closed", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the callback function", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.MessageBox", + "desc" : "This message box" + } + ] + }, + { + "name" : "getDialog", + "desc" : "Returns a reference to the underlying {@link Roo.BasicDialog} element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.MessageBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "The BasicDialog element" + } + ] + }, + { + "name" : "progress", + "desc" : "Displays a message box with a progress bar. This message box has no buttons and is not closeable by\nthe user. You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}\nand closing the message box when the process is complete.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.MessageBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "The title bar text", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The message box body text", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.MessageBox", + "desc" : "This message box" + } + ] + }, + { + "name" : "hide", + "desc" : "Hides the message box if it is displayed", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.MessageBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.\nThe following config object properties are supported:\n
\nProperty    Type             Description\n----------  ---------------  ------------------------------------------------------------------------------------\nanimEl            String/Element   An id or Element from which the message box should animate as it opens and\n                                   closes (defaults to undefined)\nbuttons           Object/Boolean   A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',\n                                   cancel:'Bar'}), or false to not show any buttons (defaults to false)\nclosable          Boolean          False to hide the top-right close button (defaults to true).  Note that\n                                   progress and wait dialogs will ignore this property and always hide the\n                                   close button as they can only be closed programmatically.\ncls               String           A custom CSS class to apply to the message box element\ndefaultTextHeight Number           The default height in pixels of the message box's multiline textarea if\n                                   displayed (defaults to 75)\nfn                Function         A callback function to execute after closing the dialog.  The arguments to the\n                                   function will be btn (the name of the button that was clicked, if applicable,\n                                   e.g. \"ok\"), and text (the value of the active text field, if applicable).\n                                   Progress and wait dialogs will ignore this option since they do not respond to\n                                   user actions and can only be closed programmatically, so any required function\n                                   should be called by the same code after it closes the dialog.\nicon              String           A CSS class that provides a background image to be used as an icon for\n                                   the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')\nmaxWidth          Number           The maximum width in pixels of the message box (defaults to 600)\nminWidth          Number           The minimum width in pixels of the message box (defaults to 100)\nmodal             Boolean          False to allow user interaction with the page while the message box is\n                                   displayed (defaults to true)\nmsg               String           A string that will replace the existing message box body text (defaults\n                                   to the XHTML-compliant non-breaking space character ' ')\nmultiline         Boolean          True to prompt the user to enter multi-line text (defaults to false)\nprogress          Boolean          True to display a progress bar (defaults to false)\nprogressText      String           The text to display inside the progress bar if progress = true (defaults to '')\nprompt            Boolean          True to prompt the user to enter single-line text (defaults to false)\nproxyDrag         Boolean          True to display a lightweight proxy while dragging (defaults to false)\ntitle             String           The title text\nvalue             String           The string value to set into the active textbox element if displayed\nwait              Boolean          True to display a progress bar (defaults to false)\nwidth             Number           The width of the dialog in pixels\n
\n\nExample usage:\n
\nRoo.Msg.show({\n   title: 'Address',\n   msg: 'Please enter your address:',\n   width: 300,\n   buttons: Roo.MessageBox.OKCANCEL,\n   multiline: true,\n   fn: saveAddress,\n   animEl: 'addAddressBtn'\n});\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.MessageBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "Configuration options", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.MessageBox", + "desc" : "This message box" + } + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if the message box is currently displayed", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.MessageBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the message box is visible, else false" + } + ] + }, + { + "name" : "wait", + "desc" : "Displays a message box with an infinitely auto-updating progress bar. This can be used to block user\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.MessageBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The message box body text", + "isOptional" : false + }, + { + "name" : "title", + "type" : "String", + "desc" : "(optional) The title bar text", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.MessageBox", + "desc" : "This message box" + } + ] + }, + { + "name" : "updateText", + "desc" : "Updates the message box body text", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.MessageBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "(optional) Replaces the message box element's innerHTML with the specified string (defaults to\nthe XHTML-compliant non-breaking space character '&#160;')", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.MessageBox", + "desc" : "This message box" + } + ] + }, + { + "name" : "updateProgress", + "desc" : "Updates a progress-style message box's text and progress bar. Only relevant on message boxes\ninitiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.MessageBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Number", + "desc" : "Any number between 0 and 1 (e.g., .5)", + "isOptional" : false + }, + { + "name" : "text", + "type" : "String", + "desc" : "(optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.MessageBox", + "desc" : "This message box" + } + ] + }, + { + "name" : "prompt", + "desc" : "Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to\nJavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function\nis passed it will be called after the user clicks either button, and the id of the button that was clicked\n(could also be the top-right close button) and the text that was entered will be passed as the two\nparameters to the callback.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.MessageBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "The title bar text", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The message box body text", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "(optional) The callback function invoked after the message box is closed", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the callback function", + "isOptional" : false + }, + { + "name" : "multiline", + "type" : "Boolean/Number", + "desc" : "(optional) True to create a multiline textbox using the defaultTextHeight\nproperty, or the height in pixels to create the textbox (defaults to false / single-line)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.MessageBox", + "desc" : "This message box" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Modal.json b/docs2/symbols/Roo.bootstrap.Modal.json new file mode 100644 index 0000000000..095a73b5e1 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Modal.json @@ -0,0 +1,1184 @@ +{ + "name" : "Roo.bootstrap.Modal", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Modal class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "max_width", + "type" : "Number", + "desc" : "set the max width of modal", + "memberOf" : "Roo.bootstrap.Modal", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "buttons", + "type" : "Array", + "desc" : "Array of buttons or standard button set..", + "memberOf" : "Roo.bootstrap.Modal", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "Title of dialog", + "memberOf" : "Roo.bootstrap.Modal", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tmpl", + "type" : "Roo.Template", + "desc" : "- a template with variables. to use it, add a handler in show:method adn", + "memberOf" : "Roo.bootstrap.Modal", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "- the body of the dialog (for simple ones) - you can also use template..", + "memberOf" : "Roo.bootstrap.Modal", + "values" : [ + ] + }, + { + "name" : "buttonPosition", + "type" : "String", + "desc" : "default right (DEPRICATED) - use mr-auto on buttons to put them on the left", + "memberOf" : "Roo.bootstrap.Modal", + "values" : [ + "(left", + "right", + "center)" + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "fitwindow", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.Modal", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "specificTitle", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.Modal", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allow_close", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.Modal", + "values" : [ + ] + }, + { + "name" : "size", + "type" : "String", + "desc" : "default empty", + "memberOf" : "Roo.bootstrap.Modal", + "values" : [ + "(sm", + "lg)" + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "animate", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.Modal", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "applyBody", + "desc" : "Set the body of the Dialog using the template", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Modal", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "data", + "type" : "Obj", + "desc" : "- apply this data to the template and replace the body contents.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setTitle", + "desc" : "Set the title of the Dialog", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Modal", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "str", + "type" : "String", + "desc" : "new Title", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setBody", + "desc" : "Set the body of the Dialog", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Modal", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "str", + "type" : "String", + "desc" : "new Title", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "btnclick", + "desc" : "The raw btnclick event for the button", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fire when dialog resize", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Modal", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.MoneyField.json b/docs2/symbols/Roo.bootstrap.MoneyField.json new file mode 100644 index 0000000000..f735097742 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.MoneyField.json @@ -0,0 +1,2891 @@ +{ + "name" : "Roo.bootstrap.MoneyField", + "augments" : [ + "Roo.bootstrap.ComboBox", + "Roo.bootstrap.TriggerField", + "Roo.bootstrap.Input", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap MoneyField class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "growMax", + "type" : "Number", + "desc" : "", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "capture", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(user", + "camera)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "queryDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "triggerAction", + "type" : "String", + "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "resizable", + "type" : "Boolean", + "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "mobileTouchView", + "type" : "Boolean", + "desc" : "show mobile touch view when using a mobile default true", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "editable", + "type" : "Boolean", + "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "defaults", + "type" : "String", + "desc" : "currency of the MoneyField\nvalue should be in lkey", + "memberOf" : "Roo.bootstrap.MoneyField", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "thousandsDelimiter", + "type" : "String", + "desc" : "Symbol of thousandsDelimiter", + "memberOf" : "Roo.bootstrap.MoneyField", + "values" : [ + ] + }, + { + "name" : "castInt", + "type" : "Boolean", + "desc" : "cast int if true (defalut true)", + "memberOf" : "Roo.bootstrap.MoneyField", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(top", + "left)" + ] + }, + { + "name" : "listWidth", + "type" : "Number", + "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "alwaysQuery", + "type" : "Boolean", + "desc" : "Disable caching of results, and always send query", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "handleHeight", + "type" : "Number", + "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "emptyResultText", + "type" : "Boolean", + "desc" : "only for touch device", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "allowZero", + "type" : "Boolean", + "desc" : "False to blank out if the user enters '0' (defaults to true)", + "memberOf" : "Roo.bootstrap.MoneyField", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "max_length", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.MoneyField", + "values" : [ + ] + }, + { + "name" : "minValue", + "type" : "Number", + "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)", + "memberOf" : "Roo.bootstrap.MoneyField", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "queryParam", + "type" : "String", + "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "tpl", + "type" : "String/Roo.Template", + "desc" : "The template to use to render the output", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "selectedClass", + "type" : "String", + "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hiddenName", + "type" : "String", + "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "allowNegative", + "type" : "Boolean", + "desc" : "False to prevent entering a negative sign (defaults to true)", + "memberOf" : "Roo.bootstrap.MoneyField", + "values" : [ + ] + }, + { + "name" : "removable", + "type" : "Boolean", + "desc" : "special filter default false", + "memberOf" : "Roo.bootstrap.TriggerField", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "minChars", + "type" : "Number", + "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "animate", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "btnPosition", + "type" : "String", + "desc" : "set the position of the trigger button (left | right) default right", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disableClear", + "type" : "Boolean", + "desc" : "Disable showing of clear button.", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "lazyRender", + "type" : "Boolean", + "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : "default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "listAlign", + "type" : "String", + "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "showToggleBtn", + "type" : "Boolean", + "desc" : "show toggle button or not (true|false) default true", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "triggerList", + "type" : "Boolean", + "desc" : "trigger show the list or not (true|false) default true", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : "Default false", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "mode", + "type" : "String", + "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "typeAhead", + "type" : "Boolean", + "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "triggerText", + "type" : "String", + "desc" : "multiple combobox trigger button text default 'Select'", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "minText", + "type" : "String", + "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")", + "memberOf" : "Roo.bootstrap.MoneyField", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be appended if specified.", + "memberOf" : "Roo.bootstrap.TriggerField", + "values" : [ + ] + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - uses BS4 is-valid now", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "modalTitle", + "type" : "String", + "desc" : "The title of the dialog that pops up on mobile views.", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "accept", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(image", + "video", + "audio)" + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "valueField", + "type" : "String", + "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "The data store to which this combo is bound (defaults to undefined)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - uses BS4 is-valid now", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "listClass", + "type" : "String", + "desc" : "CSS class to apply to the dropdown list element (defaults to '')", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "displayField", + "type" : "String", + "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "tickable", + "type" : "Boolean", + "desc" : "ComboBox with tickable selections (true|false), default false", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "specialFilter", + "type" : "Boolean", + "desc" : "special filter default false", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "emptyTitle", + "type" : "String", + "desc" : "default ''", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "typeAheadDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "loadingText", + "type" : "String", + "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "caret", + "type" : "String", + "desc" : "a fontawesome for the trigger icon see http://fortawesome.github.io/Font-Awesome/icons/", + "memberOf" : "Roo.bootstrap.TriggerField", + "values" : [ + "(search", + "calendar)" + ] + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "Roo.bootstrap.TriggerField", + "values" : [ + ] + }, + { + "name" : "minListWidth", + "type" : "Number", + "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "multiple", + "type" : "Boolean", + "desc" : "ComboBobArray, default false", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxHeight", + "type" : "Number", + "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "maxValue", + "type" : "Number", + "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.MoneyField", + "values" : [ + ] + }, + { + "name" : "mobile_restrict_height", + "type" : "Boolean", + "desc" : "restrict height for touch view", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "allowDecimals", + "type" : "Boolean", + "desc" : "False to disallow decimal values (defaults to true)", + "memberOf" : "Roo.bootstrap.MoneyField", + "values" : [ + ] + }, + { + "name" : "nanText", + "type" : "String", + "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")", + "memberOf" : "Roo.bootstrap.MoneyField", + "values" : [ + ] + }, + { + "name" : "valueNotFoundText", + "type" : "String", + "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "decimalSeparator", + "type" : "String", + "desc" : "Character(s) to allow as the decimal separator (defaults to '.')", + "memberOf" : "Roo.bootstrap.MoneyField", + "values" : [ + ] + }, + { + "name" : "autoFocus", + "type" : "Boolean", + "desc" : "auto focus the first item, default true", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "pageSize", + "type" : "Number", + "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "useNativeIOS", + "type" : "Boolean", + "desc" : "render it as classic select for ios, not support dynamic load data (default false)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "forceSelection", + "type" : "Boolean", + "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "append", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allQuery", + "type" : "String", + "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "blockFocus", + "type" : "Boolean", + "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right", + "memberOf" : "Roo.bootstrap.ComboBox", + "values" : [ + ] + }, + { + "name" : "maxText", + "type" : "String", + "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")", + "memberOf" : "Roo.bootstrap.MoneyField", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "Default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "center", + "right)" + ] + }, + { + "name" : "decimalPrecision", + "type" : "Number", + "desc" : "The maximum precision to display after the decimal separator (defaults to 2)", + "memberOf" : "Roo.bootstrap.MoneyField", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "select", + "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The zero-based index of the list item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "expand", + "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "collapse", + "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Returns the currently selected field value or empty string if no value is set.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "value The selected value" + } + ] + }, + { + "name" : "selectByValue", + "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The data value of the item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value matched an item in the list, else false" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value to match", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setFromData", + "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Object", + "desc" : "the value to set as. or false on reset?", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setEditable", + "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean", + "desc" : "True to allow the user to directly edit the field text", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearValue", + "desc" : "Clears any text/value currently set in the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isExpanded", + "desc" : "Returns true if the dropdown list is expanded, else false.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "doQuery", + "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "query", + "type" : "String", + "desc" : "The SQL query to execute", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onTriggerClick", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autoSize", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "markValid", + "desc" : "Mark this field as valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name of the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "inputEl", + "desc" : "return the real input element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "edit", + "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record|false", + "desc" : "The data record returned from the underlying store (or false on nothing selected)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "afterremove", + "desc" : "Fires when the remove value from the combobox array", + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "touchviewdisplay", + "desc" : "Fires when touch view require special display (default is using displayField)", + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "cfg", + "type" : "Object", + "desc" : "set html .", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforequery", + "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:", + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "query", + "type" : "String", + "desc" : "The query", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "true to force \"all\" query", + "isOptional" : false + }, + { + "name" : "cancel", + "type" : "Boolean", + "desc" : "true to cancel the query", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The query event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Fires when the remove value from the combobox array", + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeselect", + "desc" : "Fires before a list item is selected. Return false to cancel the selection.", + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The data record returned from the underlying store", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the selected item in the dropdown list", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "tick", + "desc" : "Fires when tick the element", + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "add", + "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)", + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "expand", + "desc" : "Fires when the dropdown list is expanded", + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialfilter", + "desc" : "Fires when specialfilter", + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collapse", + "desc" : "Fires when the dropdown list is collapsed", + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "select", + "desc" : "Fires when a list item is selected", + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The data record returned from the underlying store (or false on clear)", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the selected item in the dropdown list", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.MonthField.json b/docs2/symbols/Roo.bootstrap.MonthField.json new file mode 100644 index 0000000000..b33f301ee4 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.MonthField.json @@ -0,0 +1,1831 @@ +{ + "name" : "Roo.bootstrap.MonthField", + "augments" : [ + "Roo.bootstrap.Input", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap MonthField class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "accept", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(image", + "video", + "audio)" + ] + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(top", + "left)" + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : "default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "Default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "center", + "right)" + ] + }, + { + "name" : "language", + "type" : "String", + "desc" : "default en", + "memberOf" : "Roo.bootstrap.MonthField", + "values" : [ + ] + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "capture", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(user", + "camera)" + ] + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : "Default false", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "markValid", + "desc" : "Mark this field as valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name of the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "inputEl", + "desc" : "return the real input element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "show", + "desc" : "Fires when this field show.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.MonthField", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Mixed", + "desc" : "The date value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "select", + "desc" : "Fires when select a date.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.MonthField", + "desc" : "", + "isOptional" : false + }, + { + "name" : "oldvalue", + "type" : "String", + "desc" : "The old value", + "isOptional" : false + }, + { + "name" : "newvalue", + "type" : "String", + "desc" : "The new value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.NavGroup.json b/docs2/symbols/Roo.bootstrap.NavGroup.json new file mode 100644 index 0000000000..24c285f27e --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.NavGroup.json @@ -0,0 +1,1196 @@ +{ + "name" : "Roo.bootstrap.NavGroup", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap NavGroup class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.NavGroup", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "", + "memberOf" : "Roo.bootstrap.NavGroup", + "values" : [ + ] + }, + { + "name" : "navId", + "type" : "String", + "desc" : "- reference Id for navbar.", + "memberOf" : "Roo.bootstrap.NavGroup", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "type", + "type" : "String", + "desc" : "default nav", + "memberOf" : "Roo.bootstrap.NavGroup", + "values" : [ + "(nav", + "pills", + "tab)" + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "register", + "desc" : "register a Navigation item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.NavGroup", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.NavItem", + "desc" : "navitem to add", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getActive", + "desc" : "gets the active Navigation item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.NavGroup", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.bootstrap.NavItem", + "desc" : "the current navitem" + } + ] + }, + { + "name" : "addItem", + "desc" : "adds a Navigation item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.NavGroup", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.NavItem", + "desc" : "navitem to add", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "register", + "desc" : "register a Navigation Group", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.NavGroup", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.NavGroup", + "desc" : "navgroup to add", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "get", + "desc" : "fetch a Navigation Group based on the navigation ID", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.NavGroup", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "string", + "desc" : "navgroup to add", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setActiveItem", + "desc" : "sets the active Navigation item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.NavGroup", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.NavItem", + "desc" : "new current navitem", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearAll", + "desc" : "clear all the Navigation item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.NavGroup", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "changed", + "desc" : "Fires when the active item changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.NavGroup", + "desc" : "", + "isOptional" : false + }, + { + "name" : "selected", + "type" : "Roo.bootstrap.Navbar.Item", + "desc" : "The item selected", + "isOptional" : false + }, + { + "name" : "prev", + "type" : "Roo.bootstrap.Navbar.Item", + "desc" : "The previously selected item", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.NavHeaderbar.json b/docs2/symbols/Roo.bootstrap.NavHeaderbar.json new file mode 100644 index 0000000000..0f42f8d360 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.NavHeaderbar.json @@ -0,0 +1,1147 @@ +{ + "name" : "Roo.bootstrap.NavHeaderbar", + "augments" : [ + "Roo.bootstrap.NavSimplebar", + "Roo.bootstrap.Navbar", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Sidebar class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "brand_href", + "type" : "String", + "desc" : "href of the brand", + "memberOf" : "Roo.bootstrap.NavHeaderbar", + "values" : [ + ] + }, + { + "name" : "desktopCenter", + "type" : "Boolean", + "desc" : "should the header be centered on desktop using a container class", + "memberOf" : "Roo.bootstrap.NavHeaderbar", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "is inverted color", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "alignment", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "brand", + "type" : "String", + "desc" : "what is brand", + "memberOf" : "Roo.bootstrap.NavHeaderbar", + "values" : [ + ] + }, + { + "name" : "position", + "type" : "String", + "desc" : "position", + "memberOf" : "Roo.bootstrap.NavHeaderbar", + "values" : [ + "(fixed-top", + "fixed-bottom", + "static-top)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "srButton", + "type" : "Boolean", + "desc" : "generate the (screen reader / mobile) sr-only button default true", + "memberOf" : "Roo.bootstrap.NavHeaderbar", + "values" : [ + ] + }, + { + "name" : "tag", + "type" : "String", + "desc" : "default is nav", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + "(header", + "footer", + "nav", + "div)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "mobilerow", + "type" : "Roo.bootstrap.Row", + "desc" : "- a row to display on mobile only..", + "memberOf" : "Roo.bootstrap.NavHeaderbar", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "arrangement", + "type" : "Boolean", + "desc" : "stacked | justified", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + ] + }, + { + "name" : "loadMask", + "type" : "Boolean", + "desc" : "loadMask on the bar", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "main", + "type" : "Boolean", + "desc" : "main nav bar? default false", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "type", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + "(nav", + "pills", + "tabs)" + ] + }, + { + "name" : "weight", + "type" : "String", + "desc" : "default is light.", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + "(light", + "primary", + "secondary", + "success", + "danger", + "warning", + "info", + "dark", + "white)" + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "autohide", + "type" : "Boolean", + "desc" : "a top nav bar header that hides on scroll.", + "memberOf" : "Roo.bootstrap.NavHeaderbar", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforetoggle", + "desc" : "Fire before toggle the menu", + "memberOf" : "Roo.bootstrap.Navbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.NavItem.json b/docs2/symbols/Roo.bootstrap.NavItem.json new file mode 100644 index 0000000000..efed548a55 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.NavItem.json @@ -0,0 +1,1185 @@ +{ + "name" : "Roo.bootstrap.NavItem", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Navbar.NavItem class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tagtype", + "type" : "String", + "desc" : "render as a href or span?", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + "(a", + "span)" + ] + }, + { + "name" : "animateRef", + "type" : "Boolean", + "desc" : "link to element default false", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "tabId", + "type" : "String", + "desc" : "the tab that this item activates.", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "badge", + "type" : "String", + "desc" : "text inside badge", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "Is item disabled", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "content of button", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + ] + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "glyphicon", + "type" : "String", + "desc" : "DEPRICATED - use fa", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "icon", + "type" : "String", + "desc" : "DEPRICATED - use fa", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + ] + }, + { + "name" : "badgecls", + "type" : "String", + "desc" : "the extra classes for the badge", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + "(bg-green", + "bg-red", + "bg-yellow)" + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "button_weight", + "type" : "String", + "desc" : "default none", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + "(default", + "primary", + "secondary", + "success", + "info", + "warning", + "danger", + "link )" + ] + }, + { + "name" : "fa", + "type" : "String", + "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + ] + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : "Is item active", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "href", + "type" : "String", + "desc" : "link to", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.NavItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "changed", + "desc" : "Fires when the active item active state changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.NavItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "state", + "type" : "boolean", + "desc" : "the new state", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "scrollto", + "desc" : "Fires when scroll to element", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.NavItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "The raw click event for the entire grid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.NavProgressBar.json b/docs2/symbols/Roo.bootstrap.NavProgressBar.json new file mode 100644 index 0000000000..0cb44a2dbd --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.NavProgressBar.json @@ -0,0 +1,1012 @@ +{ + "name" : "Roo.bootstrap.NavProgressBar", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap NavProgressBar class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "changed", + "desc" : "Fires when the active item changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.NavProgressBar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "selected", + "type" : "Roo.bootstrap.NavProgressItem", + "desc" : "The item selected", + "isOptional" : false + }, + { + "name" : "prev", + "type" : "Roo.bootstrap.NavProgressItem", + "desc" : "The previously selected item", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.NavProgressItem.json b/docs2/symbols/Roo.bootstrap.NavProgressItem.json new file mode 100644 index 0000000000..bdfd269bc5 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.NavProgressItem.json @@ -0,0 +1,1060 @@ +{ + "name" : "Roo.bootstrap.NavProgressItem", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap NavProgressItem class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "rid", + "type" : "String", + "desc" : "the reference id", + "memberOf" : "Roo.bootstrap.NavProgressItem", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "position", + "type" : "String", + "desc" : "text position default bottom", + "memberOf" : "Roo.bootstrap.NavProgressItem", + "values" : [ + "(top", + "bottom)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "Is item active default false", + "memberOf" : "Roo.bootstrap.NavProgressItem", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.NavProgressItem", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "icon", + "type" : "String", + "desc" : "show icon instead of number", + "memberOf" : "Roo.bootstrap.NavProgressItem", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : "Is item active default false", + "memberOf" : "Roo.bootstrap.NavProgressItem", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "The raw click event for the entire grid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.NavProgressItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.NavSidebar.json b/docs2/symbols/Roo.bootstrap.NavSidebar.json new file mode 100644 index 0000000000..a9f712ca02 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.NavSidebar.json @@ -0,0 +1,1001 @@ +{ + "name" : "Roo.bootstrap.NavSidebar", + "augments" : [ + "Roo.bootstrap.Navbar", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Sidebar class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforetoggle", + "desc" : "Fire before toggle the menu", + "memberOf" : "Roo.bootstrap.Navbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.NavSidebarItem.json b/docs2/symbols/Roo.bootstrap.NavSidebarItem.json new file mode 100644 index 0000000000..7126d54ea5 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.NavSidebarItem.json @@ -0,0 +1,1186 @@ +{ + "name" : "Roo.bootstrap.NavSidebarItem", + "augments" : [ + "Roo.bootstrap.NavItem", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Navbar.NavSidebarItem class\n{String} badgeWeight (default|primary|success|info|warning|danger)the extra classes for the badge\n{Boolean} open is the menu open\n{Boolean} buttonView use button as the tigger el rather that a (default false)\n{String} buttonWeight (default|primary|success|info|warning|danger)the extra classes for the button\n{String} buttonSize (sm|md|lg)the extra classes for the button\n{Boolean} showArrow show arrow next to the text (default true)", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tagtype", + "type" : "String", + "desc" : "render as a href or span?", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + "(a", + "span)" + ] + }, + { + "name" : "animateRef", + "type" : "Boolean", + "desc" : "link to element default false", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "tabId", + "type" : "String", + "desc" : "the tab that this item activates.", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "badge", + "type" : "String", + "desc" : "text inside badge", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "Is item disabled", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "content of button", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + ] + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "glyphicon", + "type" : "String", + "desc" : "DEPRICATED - use fa", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "icon", + "type" : "String", + "desc" : "DEPRICATED - use fa", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + ] + }, + { + "name" : "badgecls", + "type" : "String", + "desc" : "the extra classes for the badge", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + "(bg-green", + "bg-red", + "bg-yellow)" + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "button_weight", + "type" : "String", + "desc" : "default none", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + "(default", + "primary", + "secondary", + "success", + "info", + "warning", + "danger", + "link )" + ] + }, + { + "name" : "fa", + "type" : "String", + "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + ] + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : "Is item active", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "href", + "type" : "String", + "desc" : "link to", + "memberOf" : "Roo.bootstrap.NavItem", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.NavItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "changed", + "desc" : "Fires when the active item active state changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.NavSidebarItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "state", + "type" : "boolean", + "desc" : "the new state", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "The raw click event for the entire grid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "scrollto", + "desc" : "Fires when scroll to element", + "memberOf" : "Roo.bootstrap.NavItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.NavItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.NavSimplebar.json b/docs2/symbols/Roo.bootstrap.NavSimplebar.json new file mode 100644 index 0000000000..e31d2de039 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.NavSimplebar.json @@ -0,0 +1,1087 @@ +{ + "name" : "Roo.bootstrap.NavSimplebar", + "augments" : [ + "Roo.bootstrap.Navbar", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Sidebar class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "is inverted color", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "alignment", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "tag", + "type" : "String", + "desc" : "default is nav", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + "(header", + "footer", + "nav", + "div)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "arrangement", + "type" : "Boolean", + "desc" : "stacked | justified", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + ] + }, + { + "name" : "loadMask", + "type" : "Boolean", + "desc" : "loadMask on the bar", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "main", + "type" : "Boolean", + "desc" : "main nav bar? default false", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "type", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + "(nav", + "pills", + "tabs)" + ] + }, + { + "name" : "weight", + "type" : "String", + "desc" : "default is light.", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + "(light", + "primary", + "secondary", + "success", + "danger", + "warning", + "info", + "dark", + "white)" + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforetoggle", + "desc" : "Fire before toggle the menu", + "memberOf" : "Roo.bootstrap.Navbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Navbar.json b/docs2/symbols/Roo.bootstrap.Navbar.json new file mode 100644 index 0000000000..87ae428ce3 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Navbar.json @@ -0,0 +1,1000 @@ +{ + "name" : "Roo.bootstrap.Navbar", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Navbar class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforetoggle", + "desc" : "Fire before toggle the menu", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.NumberField.json b/docs2/symbols/Roo.bootstrap.NumberField.json new file mode 100644 index 0000000000..65f06d9e47 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.NumberField.json @@ -0,0 +1,1882 @@ +{ + "name" : "Roo.bootstrap.NumberField", + "augments" : [ + "Roo.bootstrap.Input", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap NumberField class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "accept", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(image", + "video", + "audio)" + ] + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(top", + "left)" + ] + }, + { + "name" : "nanText", + "type" : "String", + "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")", + "memberOf" : "Roo.bootstrap.NumberField", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxValue", + "type" : "Number", + "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.NumberField", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "minValue", + "type" : "Number", + "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)", + "memberOf" : "Roo.bootstrap.NumberField", + "values" : [ + ] + }, + { + "name" : "decimalPrecision", + "type" : "Number", + "desc" : "The maximum precision to display after the decimal separator (defaults to 2)", + "memberOf" : "Roo.bootstrap.NumberField", + "values" : [ + ] + }, + { + "name" : "minText", + "type" : "String", + "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")", + "memberOf" : "Roo.bootstrap.NumberField", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : "default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "Default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "center", + "right)" + ] + }, + { + "name" : "allowDecimals", + "type" : "Boolean", + "desc" : "False to disallow decimal values (defaults to true)", + "memberOf" : "Roo.bootstrap.NumberField", + "values" : [ + ] + }, + { + "name" : "allowNegative", + "type" : "Boolean", + "desc" : "False to prevent entering a negative sign (defaults to true)", + "memberOf" : "Roo.bootstrap.NumberField", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "valueAlign", + "type" : "String", + "desc" : "alignment of value", + "memberOf" : "Roo.bootstrap.NumberField", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "thousandsDelimiter", + "type" : "String", + "desc" : "Symbol of thousandsDelimiter", + "memberOf" : "Roo.bootstrap.NumberField", + "values" : [ + ] + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "decimalSeparator", + "type" : "String", + "desc" : "Character(s) to allow as the decimal separator (defaults to '.')", + "memberOf" : "Roo.bootstrap.NumberField", + "values" : [ + ] + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxText", + "type" : "String", + "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")", + "memberOf" : "Roo.bootstrap.NumberField", + "values" : [ + ] + }, + { + "name" : "capture", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(user", + "camera)" + ] + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : "Default false", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowZero", + "type" : "Boolean", + "desc" : "False to blank out if the user enters '0' (defaults to true)", + "memberOf" : "Roo.bootstrap.NumberField", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "markValid", + "desc" : "Mark this field as valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name of the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "inputEl", + "desc" : "return the real input element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Pagination.json b/docs2/symbols/Roo.bootstrap.Pagination.json new file mode 100644 index 0000000000..ace64598b0 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Pagination.json @@ -0,0 +1,997 @@ +{ + "name" : "Roo.bootstrap.Pagination", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Pagination class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "false | true", + "memberOf" : "Roo.bootstrap.Pagination", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "size", + "type" : "String", + "desc" : "xs | sm | md | lg", + "memberOf" : "Roo.bootstrap.Pagination", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.PaginationItem.json b/docs2/symbols/Roo.bootstrap.PaginationItem.json new file mode 100644 index 0000000000..2a3bb631ec --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.PaginationItem.json @@ -0,0 +1,1044 @@ +{ + "name" : "Roo.bootstrap.PaginationItem", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap PaginationItem class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.PaginationItem", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.PaginationItem", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "text", + "memberOf" : "Roo.bootstrap.PaginationItem", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.PaginationItem", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "href", + "type" : "String", + "desc" : "the link", + "memberOf" : "Roo.bootstrap.PaginationItem", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "The raw click event for the entire grid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.PagingToolbar.json b/docs2/symbols/Roo.bootstrap.PagingToolbar.json new file mode 100644 index 0000000000..9d8c8fa556 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.PagingToolbar.json @@ -0,0 +1,1180 @@ +{ + "name" : "Roo.bootstrap.PagingToolbar", + "augments" : [ + "Roo.bootstrap.NavSimplebar", + "Roo.bootstrap.Navbar", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "A specialized toolbar that is bound to a {@link Roo.data.Store} and provides automatic paging controls.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "is inverted color", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "alignment", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "pageSize", + "type" : "Number", + "desc" : "The number of records to display per page (defaults to 20)", + "memberOf" : "Roo.bootstrap.PagingToolbar", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "tag", + "type" : "String", + "desc" : "default is nav", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + "(header", + "footer", + "nav", + "div)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataSource", + "type" : "Roo.data.Store", + "desc" : "The underlying data store providing the paged data", + "memberOf" : "Roo.bootstrap.PagingToolbar", + "values" : [ + ] + }, + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "container The id or element that will contain the toolbar", + "memberOf" : "Roo.bootstrap.PagingToolbar", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "arrangement", + "type" : "Boolean", + "desc" : "stacked | justified", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + ] + }, + { + "name" : "loadMask", + "type" : "Boolean", + "desc" : "loadMask on the bar", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "emptyMsg", + "type" : "String", + "desc" : "The message to display when no records are found (defaults to \"No data to display\")", + "memberOf" : "Roo.bootstrap.PagingToolbar", + "values" : [ + ] + }, + { + "name" : "main", + "type" : "Boolean", + "desc" : "main nav bar? default false", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "displayInfo", + "type" : "Boolean", + "desc" : "True to display the displayMsg (defaults to false)", + "memberOf" : "Roo.bootstrap.PagingToolbar", + "values" : [ + ] + }, + { + "name" : "displayMsg", + "type" : "String", + "desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")", + "memberOf" : "Roo.bootstrap.PagingToolbar", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "type", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + "(nav", + "pills", + "tabs)" + ] + }, + { + "name" : "weight", + "type" : "String", + "desc" : "default is light.", + "memberOf" : "Roo.bootstrap.NavSimplebar", + "values" : [ + "(light", + "primary", + "secondary", + "success", + "danger", + "warning", + "info", + "dark", + "white)" + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "unbind", + "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.PagingToolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "The data store to unbind", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "bind", + "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.PagingToolbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "The data store to bind", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforetoggle", + "desc" : "Fire before toggle the menu", + "memberOf" : "Roo.bootstrap.Navbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.PhoneInput.json b/docs2/symbols/Roo.bootstrap.PhoneInput.json new file mode 100644 index 0000000000..d5daf6f264 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.PhoneInput.json @@ -0,0 +1,1877 @@ +{ + "name" : "Roo.bootstrap.PhoneInput", + "augments" : [ + "Roo.bootstrap.TriggerField", + "Roo.bootstrap.Input", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "An input with International dial-code selection", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be appended if specified.", + "memberOf" : "Roo.bootstrap.TriggerField", + "values" : [ + ] + }, + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "accept", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(image", + "video", + "audio)" + ] + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(top", + "left)" + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : "default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "Default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "center", + "right)" + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "Roo.bootstrap.TriggerField", + "values" : [ + ] + }, + { + "name" : "removable", + "type" : "Boolean", + "desc" : "special filter default false", + "memberOf" : "Roo.bootstrap.TriggerField", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "caret", + "type" : "String", + "desc" : "a fontawesome for the trigger icon see http://fortawesome.github.io/Font-Awesome/icons/", + "memberOf" : "Roo.bootstrap.TriggerField", + "values" : [ + "(search", + "calendar)" + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "defaultDialCode", + "type" : "String", + "desc" : "default '+852'", + "memberOf" : "Roo.bootstrap.PhoneInput", + "values" : [ + ] + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "capture", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(user", + "camera)" + ] + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "preferedCountries", + "type" : "Array", + "desc" : "default []", + "memberOf" : "Roo.bootstrap.PhoneInput", + "values" : [ + ] + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : "Default false", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "onTriggerClick", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autoSize", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "markValid", + "desc" : "Mark this field as valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name of the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "inputEl", + "desc" : "return the real input element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Popover.json b/docs2/symbols/Roo.bootstrap.Popover.json new file mode 100644 index 0000000000..0d48afd9df --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Popover.json @@ -0,0 +1,1029 @@ +{ + "name" : "Roo.bootstrap.Popover", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Popover class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "placement", + "type" : "String", + "desc" : "how it is placed", + "memberOf" : "Roo.bootstrap.Popover", + "values" : [ + ] + }, + { + "name" : "over", + "type" : "String", + "desc" : "what (parent or false to trigger manually.)", + "memberOf" : "Roo.bootstrap.Popover", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "delay", + "type" : "Number", + "desc" : "- delay before showing", + "memberOf" : "Roo.bootstrap.Popover", + "values" : [ + ] + }, + { + "name" : "trigger", + "type" : "String", + "desc" : "click || hover (or false to trigger manually)", + "memberOf" : "Roo.bootstrap.Popover", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "of popover (or false to hide)", + "memberOf" : "Roo.bootstrap.Popover", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "contents of the popover (or false to use children..)", + "memberOf" : "Roo.bootstrap.Popover", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "hide", + "desc" : "After the popover hide", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Popover", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "After the popover show", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Popover", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Progress.json b/docs2/symbols/Roo.bootstrap.Progress.json new file mode 100644 index 0000000000..74da95e09a --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Progress.json @@ -0,0 +1,997 @@ +{ + "name" : "Roo.bootstrap.Progress", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Progress class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "striped", + "type" : "Boolean", + "desc" : "striped of the progress bar", + "memberOf" : "Roo.bootstrap.Progress", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : "animated of the progress bar", + "memberOf" : "Roo.bootstrap.Progress", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.ProgressBar.json b/docs2/symbols/Roo.bootstrap.ProgressBar.json new file mode 100644 index 0000000000..93b2d9dc3b --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.ProgressBar.json @@ -0,0 +1,1041 @@ +{ + "name" : "Roo.bootstrap.ProgressBar", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap ProgressBar class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "label", + "type" : "String", + "desc" : "label for the progress bar", + "memberOf" : "Roo.bootstrap.ProgressBar", + "values" : [ + ] + }, + { + "name" : "panel", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.ProgressBar", + "values" : [ + "(success", + "info", + "warning", + "danger )" + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "aria_valuenow", + "type" : "Number", + "desc" : "aria-value now", + "memberOf" : "Roo.bootstrap.ProgressBar", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "aria_valuemax", + "type" : "Number", + "desc" : "aria-value max", + "memberOf" : "Roo.bootstrap.ProgressBar", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "aria_valuemin", + "type" : "Number", + "desc" : "aria-value min", + "memberOf" : "Roo.bootstrap.ProgressBar", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "role", + "type" : "String", + "desc" : "role of the progress bar", + "memberOf" : "Roo.bootstrap.ProgressBar", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "sr_only", + "type" : "String", + "desc" : "text", + "memberOf" : "Roo.bootstrap.ProgressBar", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Radio.json b/docs2/symbols/Roo.bootstrap.Radio.json new file mode 100644 index 0000000000..f18ad40445 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Radio.json @@ -0,0 +1,997 @@ +{ + "name" : "Roo.bootstrap.Radio", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Radio class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "value", + "type" : "String", + "desc" : "- the value of radio", + "memberOf" : "Roo.bootstrap.Radio", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "boxLabel", + "type" : "String", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Radio", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.RadioSet.json b/docs2/symbols/Roo.bootstrap.RadioSet.json new file mode 100644 index 0000000000..fd56a5ae9a --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.RadioSet.json @@ -0,0 +1,1865 @@ +{ + "name" : "Roo.bootstrap.RadioSet", + "augments" : [ + "Roo.bootstrap.Input", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap RadioSet class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "accept", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(image", + "video", + "audio)" + ] + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "weight", + "type" : "String", + "desc" : "The text that appears beside the radio", + "memberOf" : "Roo.bootstrap.RadioSet", + "values" : [ + "(primary", + "warning", + "info", + "danger", + "success)" + ] + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(top", + "left)" + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : "default left", + "memberOf" : "Roo.bootstrap.RadioSet", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "Default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "center", + "right)" + ] + }, + { + "name" : "inline", + "type" : "Boolean", + "desc" : "inline the element (default true)", + "memberOf" : "Roo.bootstrap.RadioSet", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "capture", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(user", + "camera)" + ] + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : "Default false", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "markValid", + "desc" : "Mark this field as valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name of the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "inputEl", + "desc" : "return the real input element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "Fires when the element is click.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.RadioSet", + "desc" : "This radio set", + "isOptional" : false + }, + { + "name" : "item", + "type" : "Roo.bootstrap.Radio", + "desc" : "The checked item", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "check", + "desc" : "Fires when the element is checked or unchecked.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.RadioSet", + "desc" : "This radio", + "isOptional" : false + }, + { + "name" : "item", + "type" : "Roo.bootstrap.Radio", + "desc" : "The checked item", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Row.json b/docs2/symbols/Roo.bootstrap.Row.json new file mode 100644 index 0000000000..fcbfdad220 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Row.json @@ -0,0 +1,981 @@ +{ + "name" : "Roo.bootstrap.Row", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Row class (contains columns...)", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.SecurePass.json b/docs2/symbols/Roo.bootstrap.SecurePass.json new file mode 100644 index 0000000000..5313702508 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.SecurePass.json @@ -0,0 +1,1810 @@ +{ + "name" : "Roo.bootstrap.SecurePass", + "augments" : [ + "Roo.bootstrap.Input", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap SecurePass class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "accept", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(image", + "video", + "audio)" + ] + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(top", + "left)" + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "errors", + "type" : "String/Object", + "desc" : "A Error spec, or true for a default spec (defaults to\n{\n PwdEmpty: \"Please type a password, and then retype it to confirm.\",\n PwdShort: \"Your password must be at least 6 characters long. Please type a different password.\",\n PwdLong: \"Your password can't contain more than 16 characters. Please type a different password.\",\n PwdBadChar: \"The password contains characters that aren't allowed. Please type a different password.\",\n IDInPwd: \"Your password can't include the part of your ID. Please type a different password.\",\n FNInPwd: \"Your password can't contain your first name. Please type a different password.\",\n LNInPwd: \"Your password can't contain your last name. Please type a different password.\"\n})", + "memberOf" : "Roo.bootstrap.SecurePass", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "Label", + "type" : "String/Object", + "desc" : "for the strength meter (defaults to\n'Password strength:')", + "memberOf" : "Roo.bootstrap.SecurePass", + "values" : [ + ] + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : "default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "Default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "center", + "right)" + ] + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "pwdStrengths", + "type" : "String/Object", + "desc" : "A pwdStrengths spec, or true for a default spec (defaults to\n['Weak', 'Medium', 'Strong'])", + "memberOf" : "Roo.bootstrap.SecurePass", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "capture", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(user", + "camera)" + ] + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : "Default false", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "markValid", + "desc" : "Mark this field as valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name of the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "inputEl", + "desc" : "return the real input element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Slider.json b/docs2/symbols/Roo.bootstrap.Slider.json new file mode 100644 index 0000000000..b8d592fcc0 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Slider.json @@ -0,0 +1,981 @@ +{ + "name" : "Roo.bootstrap.Slider", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Slider class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter.json b/docs2/symbols/Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter.json new file mode 100644 index 0000000000..765571d1a0 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter.json @@ -0,0 +1,72 @@ +{ + "name" : "Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter", + "augments" : [ + "Roo.bootstrap.SplitBar.BasicLayoutAdapter" + ], + "desc" : "Adapter that moves the splitter element to align with the resized sizing element. \nUsed with an absolute positioned SplitBar.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "setElementSize", + "desc" : "Called after drag operations to set the size of the resizing element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "s", + "type" : "Roo.bootstrap.SplitBar", + "desc" : "The SplitBar using this adapter", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size to set", + "isOptional" : false + }, + { + "name" : "onComplete", + "type" : "Function", + "desc" : "A function to be invoked when resizing is complete", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getElementSize", + "desc" : "Called before drag operations to get the current size of the resizing element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "s", + "type" : "Roo.bootstrap.SplitBar", + "desc" : "The SplitBar using this adapter", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.SplitBar.BasicLayoutAdapter.json b/docs2/symbols/Roo.bootstrap.SplitBar.BasicLayoutAdapter.json new file mode 100644 index 0000000000..ce27f0f6c3 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.SplitBar.BasicLayoutAdapter.json @@ -0,0 +1,71 @@ +{ + "name" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter", + "augments" : [ + ], + "desc" : "Default Adapter. It assumes the splitter and resizing element are not positioned\nelements and only gets/sets the width of the element. Generally used for table based layouts.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "setElementSize", + "desc" : "Called after drag operations to set the size of the resizing element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "s", + "type" : "Roo.bootstrap.SplitBar", + "desc" : "The SplitBar using this adapter", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size to set", + "isOptional" : false + }, + { + "name" : "onComplete", + "type" : "Function", + "desc" : "A function to be invoked when resizing is complete", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getElementSize", + "desc" : "Called before drag operations to get the current size of the resizing element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "s", + "type" : "Roo.bootstrap.SplitBar", + "desc" : "The SplitBar using this adapter", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.SplitBar.json b/docs2/symbols/Roo.bootstrap.SplitBar.json new file mode 100644 index 0000000000..0369a90f1c --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.SplitBar.json @@ -0,0 +1,568 @@ +{ + "name" : "Roo.bootstrap.SplitBar", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "Creates draggable splitter bar functionality from two elements (element to be dragged and element to be resized).\n

\nUsage:\n
\nvar split = new Roo.bootstrap.SplitBar(\"elementToDrag\", \"elementToSize\",\n                   Roo.bootstrap.SplitBar.HORIZONTAL, Roo.bootstrap.SplitBar.LEFT);\nsplit.setAdapter(new Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter(\"container\"));\nsplit.minSize = 100;\nsplit.maxSize = 600;\nsplit.animate = true;\nsplit.on('moved', splitterMoved);\n
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "setCurrentSize", + "desc" : "Sets the initialize size for the resizing element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.SplitBar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "size", + "type" : "Number", + "desc" : "The initial size", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setMinimumSize", + "desc" : "Sets the minimum size for the resizing element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.SplitBar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "minSize", + "type" : "Number", + "desc" : "The minimum size", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setAdapter", + "desc" : "Set the adapter this SplitBar uses", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.SplitBar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adapter", + "type" : "Object", + "desc" : "A SplitBar adapter object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getMinimumSize", + "desc" : "Gets the minimum size for the resizing element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.SplitBar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The minimum size" + } + ] + }, + { + "name" : "destroy", + "desc" : "Destroy this splitbar.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.SplitBar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "removeEl", + "type" : "Boolean", + "desc" : "True to remove the element", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setMaximumSize", + "desc" : "Sets the maximum size for the resizing element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.SplitBar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "maxSize", + "type" : "Number", + "desc" : "The maximum size", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getMaximumSize", + "desc" : "Gets the maximum size for the resizing element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.SplitBar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The maximum size" + } + ] + }, + { + "name" : "getAdapter", + "desc" : "Get the adapter this SplitBar uses", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.SplitBar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "The adapter object" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforeresize", + "desc" : "Fires before the splitter is dragged", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.SplitBar", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.SplitBar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "the new width or height", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "moved", + "desc" : "Fires when the splitter is moved", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.SplitBar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "the new width or height", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.TabGroup.json b/docs2/symbols/Roo.bootstrap.TabGroup.json new file mode 100644 index 0000000000..019ce570c6 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.TabGroup.json @@ -0,0 +1,1254 @@ +{ + "name" : "Roo.bootstrap.TabGroup", + "augments" : [ + "Roo.bootstrap.Column", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Column class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "xsoff", + "type" : "Number", + "desc" : "colspan offset out of 12 for mobile-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + ] + }, + { + "name" : "showarrow", + "type" : "Boolean", + "desc" : "show arrow default true", + "memberOf" : "Roo.bootstrap.TabGroup", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + ] + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "navId", + "type" : "String", + "desc" : "the navigation id (for use with navbars) - will be auto generated if it does not exist..", + "memberOf" : "Roo.bootstrap.TabGroup", + "values" : [ + ] + }, + { + "name" : "bullets", + "type" : "Boolean", + "desc" : "show bullets for the panels", + "memberOf" : "Roo.bootstrap.TabGroup", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "timer", + "type" : "Number", + "desc" : "auto slide timer .. default 0 millisecond", + "memberOf" : "Roo.bootstrap.TabGroup", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "autoslide", + "type" : "Boolean", + "desc" : "auto slide .. default false", + "memberOf" : "Roo.bootstrap.TabGroup", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "fasize", + "type" : "Number", + "desc" : "font awsome size", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + "(1", + "2", + "....)" + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "carousel", + "type" : "Boolean", + "desc" : "true to make the group behave like a carousel", + "memberOf" : "Roo.bootstrap.TabGroup", + "values" : [ + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "hide the element", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "fa", + "type" : "String", + "desc" : "font awesome icon", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + "(ban", + "check", + "...)" + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "icon", + "type" : "String", + "desc" : "glyphicon name", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + "(info-sign", + "check", + "...)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "alert", + "type" : "String", + "desc" : "type alert (changes background / border...)", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + "(success", + "info", + "warning", + "danger)" + ] + }, + { + "name" : "lgoff", + "type" : "Number", + "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "smoff", + "type" : "Number", + "desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "mdoff", + "type" : "Number", + "desc" : "colspan offset out of 12 for computer-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + ] + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens or 0 for hidden", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "content of column.", + "memberOf" : "Roo.bootstrap.Column", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "register", + "desc" : "register a Navigation item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TabGroup", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.NavItem", + "desc" : "navitem to add", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "register", + "desc" : "register a Navigation Group", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TabGroup", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.NavGroup", + "desc" : "navgroup to add", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "get", + "desc" : "fetch a Navigation Group based on the navigation ID\nif one does not exist , it will get created.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TabGroup", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "string", + "desc" : "navgroup to add", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "showPanel", + "desc" : "show a specific panel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TabGroup", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Roo.bootstrap.TabPanel|number|string", + "desc" : "to change to (use the tabId to specify a specific one)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "false if panel was not shown (invalid entry or beforedeactivate fails.)" + } + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.TabPanel.json b/docs2/symbols/Roo.bootstrap.TabPanel.json new file mode 100644 index 0000000000..60fbb92369 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.TabPanel.json @@ -0,0 +1,1070 @@ +{ + "name" : "Roo.bootstrap.TabPanel", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap TabPanel class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "tabId", + "type" : "String", + "desc" : "unique tab ID (will be autogenerated if not set. - used to match TabItem to Panel)", + "memberOf" : "Roo.bootstrap.TabPanel", + "values" : [ + ] + }, + { + "name" : "navId", + "type" : "String", + "desc" : "The Roo.bootstrap.NavGroup which triggers show hide ()", + "memberOf" : "Roo.bootstrap.TabPanel", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "panel content", + "memberOf" : "Roo.bootstrap.TabPanel", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : "panel active", + "memberOf" : "Roo.bootstrap.TabPanel", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "href", + "type" : "String", + "desc" : "click to link..", + "memberOf" : "Roo.bootstrap.TabPanel", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "changed", + "desc" : "Fires when the active status changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.TabPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "state", + "type" : "Boolean", + "desc" : "the new state", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedeactivate", + "desc" : "Fires before a tab is de-activated - can be used to do validation on a form.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.TabPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "false if there is an error" + } + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Table.AbstractSelectionModel.json b/docs2/symbols/Roo.bootstrap.Table.AbstractSelectionModel.json new file mode 100644 index 0000000000..9c82fb121d --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Table.AbstractSelectionModel.json @@ -0,0 +1,379 @@ +{ + "name" : "Roo.bootstrap.Table.AbstractSelectionModel", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "Abstract base class for grid SelectionModels. It provides the interface that should be\nimplemented by descendant classes. This class should not be directly instantiated.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "lock", + "desc" : "Locks the selections.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.AbstractSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "unlock", + "desc" : "Unlocks the selections.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.AbstractSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isLocked", + "desc" : "Returns true if the selections are locked.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.AbstractSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Table.RowSelectionModel.json b/docs2/symbols/Roo.bootstrap.Table.RowSelectionModel.json new file mode 100644 index 0000000000..7e4413abc5 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Table.RowSelectionModel.json @@ -0,0 +1,933 @@ +{ + "name" : "Roo.bootstrap.Table.RowSelectionModel", + "augments" : [ + "Roo.bootstrap.Table.AbstractSelectionModel", + "Roo.util.Observable" + ], + "desc" : "The default SelectionModel used by {@link Roo.bootstrap.Table}.\nIt supports multiple selections and keyboard selection/navigation.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "singleSelect", + "type" : "Boolean", + "desc" : "True to allow selection of only one row at a time (defaults to false)", + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getCount", + "desc" : "Gets the number of selected rows.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "getSelections", + "desc" : "Returns the selected records", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "Array of selected records" + } + ] + }, + { + "name" : "selectRange", + "desc" : "Selects a range of rows. All rows in between startRow and endRow are also selected.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "startRow", + "type" : "Number", + "desc" : "The index of the first row in the range", + "isOptional" : false + }, + { + "name" : "endRow", + "type" : "Number", + "desc" : "The index of the last row in the range", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to retain existing selections", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "selectFirstRow", + "desc" : "Selects the first row in the grid.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "selectLastRow", + "desc" : "Select the last row.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "deselectRow", + "desc" : "Deselects a row.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "row", + "type" : "Number", + "desc" : "The index of the row to deselect", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "selectNext", + "desc" : "Selects the row immediately following the last selected row.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "selectPrevious", + "desc" : "Selects the row that precedes the last selected row.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "selectRows", + "desc" : "Selects multiple rows.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "rows", + "type" : "Array", + "desc" : "Array of the indexes of the row to select", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "selectRecords", + "desc" : "Select records.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "records", + "type" : "Array", + "desc" : "The records to select", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hasSelection", + "desc" : "Returns True if there is a selection.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "isIdSelected", + "desc" : "Returns True if the specified record id is selected.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of record to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "selectAll", + "desc" : "Selects all rows.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "selectRow", + "desc" : "Selects a row.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "row", + "type" : "Number", + "desc" : "The index of the row to select", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSelected", + "desc" : "Returns the first selected record.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Record", + "desc" : "" + } + ] + }, + { + "name" : "isSelected", + "desc" : "Returns True if the specified row is selected.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "record", + "type" : "Number/Record", + "desc" : "The record or index of the record to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "clearSelections", + "desc" : "Clears all selections.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "deselectRange", + "desc" : "Deselects a range of rows. All rows in between startRow and endRow are also deselected.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "startRow", + "type" : "Number", + "desc" : "The index of the first row in the range", + "isOptional" : false + }, + { + "name" : "endRow", + "type" : "Number", + "desc" : "The index of the last row in the range", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "lock", + "desc" : "Locks the selections.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.AbstractSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "unlock", + "desc" : "Unlocks the selections.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.AbstractSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isLocked", + "desc" : "Returns true if the selections are locked.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table.AbstractSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "rowselect", + "desc" : "Fires when a row is selected.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "The selected index", + "isOptional" : false + }, + { + "name" : "r", + "type" : "Roo.data.Record", + "desc" : "The record", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerowselect", + "desc" : "Fires when a row is selected being selected, return false to cancel.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "The selected index", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "False if other selections will be cleared", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowdeselect", + "desc" : "Fires when a row is deselected.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "The selected index", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "afterselectionchange", + "desc" : "Fires after the selection changes (eg. by key press or clicking)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "selectionchange", + "desc" : "Fires when the selection changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Table.json b/docs2/symbols/Roo.bootstrap.Table.json new file mode 100644 index 0000000000..b0159d09a3 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Table.json @@ -0,0 +1,1690 @@ +{ + "name" : "Roo.bootstrap.Table", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Table class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "footerShow", + "type" : "Boolean", + "desc" : "generate tfoot, default true", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "auto_hide_footer", + "type" : "Boolean", + "desc" : "auto hide footer if only one page (default false)", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + }, + { + "name" : "scrollBody", + "type" : "Boolean", + "desc" : "default false - body scrolled / fixed header", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "border", + "type" : "Number", + "desc" : "Specifies whether the table cells should have borders or not", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "Specifies the width of a table", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + }, + { + "name" : "bordered", + "type" : "boolean", + "desc" : "Add borders to the table", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + }, + { + "name" : "rules", + "type" : "String", + "desc" : "Specifies which parts of the inside borders that should be visible", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "layout", + "type" : "String", + "desc" : "table layout (auto | fixed | initial | inherit)", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + }, + { + "name" : "condensed", + "type" : "boolean", + "desc" : "Format condensed", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "frame", + "type" : "String", + "desc" : "Specifies which parts of the outside borders that should be visible", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + }, + { + "name" : "cellSelection", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "sortable", + "type" : "String", + "desc" : "Specifies that the table should be sortable", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "striped", + "type" : "boolean", + "desc" : "Should the rows be alternative striped", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "cellspacing", + "type" : "Number", + "desc" : "Specifies the space between cells", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "Specifies the alignment of a table according to surrounding text", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + "(left", + "center", + "right)" + ] + }, + { + "name" : "lazyLoad", + "type" : "Boolean", + "desc" : "auto load data while scrolling to the end (default false)", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + }, + { + "name" : "footer", + "type" : "Roo.bootstrap.PagingToolbar", + "desc" : "a paging toolbar", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "table class", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + }, + { + "name" : "bgcolor", + "type" : "String", + "desc" : "Specifies the background color for a table", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + }, + { + "name" : "headerShow", + "type" : "Boolean", + "desc" : "generate thead, default true", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "loadMask", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "hover", + "type" : "boolean", + "desc" : "Add hover highlighting", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "cellpadding", + "type" : "Number", + "desc" : "Specifies the space between the cell wall and the cell content", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "summary", + "type" : "String", + "desc" : "Specifies a summary of the content of a table", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + }, + { + "name" : "rowSelection", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "responsive", + "type" : "boolean", + "desc" : "Format condensed", + "memberOf" : "Roo.bootstrap.Table", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "setRowVisibility", + "desc" : "Show or hide a row.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "to show or hide", + "isOptional" : false + }, + { + "name" : "state", + "type" : "Boolean", + "desc" : "hide", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getGridEl", + "desc" : "Returns the grid's underlying element = used by panel.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The element" + } + ] + }, + { + "name" : "autoSize", + "desc" : "Forces a resize - used by panel.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The element" + } + ] + }, + { + "name" : "clear", + "desc" : "Remove all rows", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Table", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "rowsrendered", + "desc" : "Fires when all the rows have been rendered", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "headercontextmenu", + "desc" : "Fires when a header is right clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowdblclick", + "desc" : "Fires when a row is double clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "contextmenu", + "desc" : "The raw contextmenu event for the entire grid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowcontextmenu", + "desc" : "Fires when a row is right clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "cellcontextmenu", + "desc" : "Fires when a cell is right clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "cellIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "celldblclick", + "desc" : "Fires when a cell is double clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowclass", + "desc" : "Fires when a row is rendered, so you can change add a style to it.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowcfg", + "type" : "Object", + "desc" : "contains record rowIndex colIndex and rowClass - set rowClass to add a style.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseover", + "desc" : "Fires when a mouseover occur", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseout", + "desc" : "Fires when a mouseout occur", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "cellclick", + "desc" : "Fires when a cell is clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowclick", + "desc" : "Fires when a row is clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.TableBody.json b/docs2/symbols/Roo.bootstrap.TableBody.json new file mode 100644 index 0000000000..19d3ea69e4 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.TableBody.json @@ -0,0 +1,1013 @@ +{ + "name" : "Roo.bootstrap.TableBody", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap TableBody class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "charoff", + "type" : "Number", + "desc" : "Sets the number of characters the content inside the element will be aligned from the character specified by the char attribute", + "memberOf" : "Roo.bootstrap.TableBody", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "Aligns the content inside the element", + "memberOf" : "Roo.bootstrap.TableBody", + "values" : [ + ] + }, + { + "name" : "valign", + "type" : "String", + "desc" : "Vertical aligns the content inside the element", + "memberOf" : "Roo.bootstrap.TableBody", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "tag", + "type" : "String", + "desc" : "element tag (thead|tbody|tfoot) default tbody", + "memberOf" : "Roo.bootstrap.TableBody", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "element class", + "memberOf" : "Roo.bootstrap.TableBody", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.TableCell.json b/docs2/symbols/Roo.bootstrap.TableCell.json new file mode 100644 index 0000000000..e349a3c549 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.TableCell.json @@ -0,0 +1,1101 @@ +{ + "name" : "Roo.bootstrap.TableCell", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap TableCell class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "abbr", + "type" : "String", + "desc" : "Specifies an abbreviated version of the content in a cell", + "memberOf" : "Roo.bootstrap.TableCell", + "values" : [ + ] + }, + { + "name" : "charoff", + "type" : "Number", + "desc" : "Sets the number of characters the content will be aligned from the character specified by the char attribute", + "memberOf" : "Roo.bootstrap.TableCell", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "axis", + "type" : "String", + "desc" : "Categorizes cells", + "memberOf" : "Roo.bootstrap.TableCell", + "values" : [ + ] + }, + { + "name" : "bgcolor", + "type" : "String", + "desc" : "Specifies the background color of a cell", + "memberOf" : "Roo.bootstrap.TableCell", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "Aligns the content in a cell", + "memberOf" : "Roo.bootstrap.TableCell", + "values" : [ + ] + }, + { + "name" : "valign", + "type" : "String", + "desc" : "Vertical aligns the content in a cell", + "memberOf" : "Roo.bootstrap.TableCell", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "tag", + "type" : "String", + "desc" : "cell tag (td|th) default td", + "memberOf" : "Roo.bootstrap.TableCell", + "values" : [ + ] + }, + { + "name" : "scope", + "type" : "String", + "desc" : "Defines a way to associate header cells and data cells in a table", + "memberOf" : "Roo.bootstrap.TableCell", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "cell contain text", + "memberOf" : "Roo.bootstrap.TableCell", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "cell class", + "memberOf" : "Roo.bootstrap.TableCell", + "values" : [ + ] + }, + { + "name" : "headers", + "type" : "String", + "desc" : "Specifies one or more header cells a cell is related to", + "memberOf" : "Roo.bootstrap.TableCell", + "values" : [ + ] + }, + { + "name" : "nowrap", + "type" : "String", + "desc" : "Specifies that the content inside a cell should not wrap", + "memberOf" : "Roo.bootstrap.TableCell", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "Specifies the width of a cell", + "memberOf" : "Roo.bootstrap.TableCell", + "values" : [ + ] + }, + { + "name" : "colspan", + "type" : "Number", + "desc" : "Specifies the number of columns a cell should span", + "memberOf" : "Roo.bootstrap.TableCell", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "Sets the height of a cell", + "memberOf" : "Roo.bootstrap.TableCell", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "rowspan", + "type" : "Number", + "desc" : "Sets the number of rows a cell should span", + "memberOf" : "Roo.bootstrap.TableCell", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.TableRow.json b/docs2/symbols/Roo.bootstrap.TableRow.json new file mode 100644 index 0000000000..ed245b8807 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.TableRow.json @@ -0,0 +1,1013 @@ +{ + "name" : "Roo.bootstrap.TableRow", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap TableRow class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "charoff", + "type" : "Number", + "desc" : "Sets the number of characters the content will be aligned from the character specified by the char attribute", + "memberOf" : "Roo.bootstrap.TableRow", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "bgcolor", + "type" : "String", + "desc" : "Specifies a background color for a table row", + "memberOf" : "Roo.bootstrap.TableRow", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "Aligns the content in a table row", + "memberOf" : "Roo.bootstrap.TableRow", + "values" : [ + ] + }, + { + "name" : "valign", + "type" : "String", + "desc" : "Vertical aligns the content in a table row", + "memberOf" : "Roo.bootstrap.TableRow", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "row class", + "memberOf" : "Roo.bootstrap.TableRow", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.TextArea.json b/docs2/symbols/Roo.bootstrap.TextArea.json new file mode 100644 index 0000000000..2cc205afc0 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.TextArea.json @@ -0,0 +1,1834 @@ +{ + "name" : "Roo.bootstrap.TextArea", + "augments" : [ + "Roo.bootstrap.Input", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap TextArea class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "accept", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(image", + "video", + "audio)" + ] + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(top", + "left)" + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : "default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "Default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "center", + "right)" + ] + }, + { + "name" : "wrap", + "type" : "string", + "desc" : "Specifies how the text in a text area is to be wrapped when submitted in a form", + "memberOf" : "Roo.bootstrap.TextArea", + "values" : [ + "(soft", + "hard)" + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "rows", + "type" : "Number", + "desc" : "Specifies the visible number of lines in a text area", + "memberOf" : "Roo.bootstrap.TextArea", + "values" : [ + ] + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "cols", + "type" : "Number", + "desc" : "Specifies the visible width of a text area", + "memberOf" : "Roo.bootstrap.TextArea", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "resize", + "type" : "string", + "desc" : "", + "memberOf" : "Roo.bootstrap.TextArea", + "values" : [ + "(none", + "both", + "horizontal", + "vertical", + "inherit", + "initial)" + ] + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "capture", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(user", + "camera)" + ] + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "string", + "desc" : "text", + "memberOf" : "Roo.bootstrap.TextArea", + "values" : [ + ] + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : "Default false", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "inputEl", + "desc" : "return the real textarea element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TextArea", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TextArea", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "markValid", + "desc" : "Mark this field as valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TextArea", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TextArea", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "getName", + "desc" : "Returns the name of the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.TimeField.json b/docs2/symbols/Roo.bootstrap.TimeField.json new file mode 100644 index 0000000000..95e6935703 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.TimeField.json @@ -0,0 +1,1825 @@ +{ + "name" : "Roo.bootstrap.TimeField", + "augments" : [ + "Roo.bootstrap.Input", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap DateField class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "accept", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(image", + "video", + "audio)" + ] + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(top", + "left)" + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : "default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "Default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "center", + "right)" + ] + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "format", + "type" : "String", + "desc" : "The default time format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'H:i').", + "memberOf" : "Roo.bootstrap.TimeField", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "capture", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(user", + "camera)" + ] + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : "Default false", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "markValid", + "desc" : "Mark this field as valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name of the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "inputEl", + "desc" : "return the real input element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "select", + "desc" : "Fires when select a date.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DateField", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Mixed", + "desc" : "The date value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires when this field show.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "thisthis", + "type" : "Roo.bootstrap.DateField", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Mixed", + "desc" : "The date value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.Tooltip.json b/docs2/symbols/Roo.bootstrap.Tooltip.json new file mode 100644 index 0000000000..3aeec0074b --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.Tooltip.json @@ -0,0 +1,31 @@ +{ + "name" : "Roo.bootstrap.Tooltip", + "augments" : [ + ], + "desc" : "Bootstrap Tooltip class\nThis is basic at present - all componets support it by default, however they should add tooltipEl() method\nto determine which dom element triggers the tooltip.\n\nIt needs to add support for additional attributes like tooltip-position", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "currentEl", + "desc" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Tooltip", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.TriggerField.json b/docs2/symbols/Roo.bootstrap.TriggerField.json new file mode 100644 index 0000000000..6327216c29 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.TriggerField.json @@ -0,0 +1,1860 @@ +{ + "name" : "Roo.bootstrap.TriggerField", + "augments" : [ + "Roo.bootstrap.Input", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Provides a convenient wrapper for TextFields that adds a clickable trigger button (looks like a combobox by default).\nThe trigger has no default action, so you must assign a function to implement the trigger click handler by\noverriding {@link #onTriggerClick}. You can create a TriggerField directly, as it renders exactly like a combobox\nfor which you can provide a custom implementation. For example:\n
\nvar trigger = new Roo.bootstrap.TriggerField();\ntrigger.onTriggerClick = myTriggerFn;\ntrigger.applyTo('my-field');\n
\n\nHowever, in general you will most likely want to use TriggerField as the base class for a reusable component.\n{@link Roo.bootstrap.DateField} and {@link Roo.bootstrap.ComboBox} are perfect examples of this.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be appended if specified.", + "memberOf" : "Roo.bootstrap.TriggerField", + "values" : [ + ] + }, + { + "name" : "validFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "colspan out of 12 for large computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "accept", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(image", + "video", + "audio)" + ] + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "colspan out of 12 for mobile-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is it disabled", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "name of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "autocomplete", + "type" : "String", + "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelAlign", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(top", + "left)" + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "-- Depricated - use Invalid Text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "labelmd", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "string", + "desc" : "default value of the input", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hasFeedback", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "colspan out of 12 for tablet-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "Specifies that the field should be read-only", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "indicatorpos", + "type" : "String", + "desc" : "default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "right)" + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "Default left", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(left", + "center", + "right)" + ] + }, + { + "name" : "size", + "type" : "string", + "desc" : "- (lg|sm) or leave empty..", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labellg", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "Roo.bootstrap.TriggerField", + "values" : [ + ] + }, + { + "name" : "removable", + "type" : "Boolean", + "desc" : "special filter default false", + "memberOf" : "Roo.bootstrap.TriggerField", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "labelxs", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "caret", + "type" : "String", + "desc" : "a fontawesome for the trigger icon see http://fortawesome.github.io/Font-Awesome/icons/", + "memberOf" : "Roo.bootstrap.TriggerField", + "values" : [ + "(search", + "calendar)" + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "string", + "desc" : "- the label associated", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "before", + "type" : "string", + "desc" : "- input group add on before", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "invalidFeedbackIcon", + "type" : "String", + "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "placeholder", + "type" : "string", + "desc" : "- placeholder to put in text.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "md", + "type" : "Number", + "desc" : "colspan out of 12 for computer-sized screens", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "set the width of label", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "capture", + "type" : "String", + "desc" : "use for file input only. (default empty)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(user", + "camera)" + ] + }, + { + "name" : "validClass", + "type" : "String", + "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "forceFeedback", + "type" : "Boolean", + "desc" : "Default false", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "labelsm", + "type" : "Number", + "desc" : "set the width of label (1-12)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "after", + "type" : "string", + "desc" : "- input group add on after", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", + "memberOf" : "Roo.bootstrap.Input", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "onTriggerClick", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autoSize", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "markValid", + "desc" : "Mark this field as valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name of the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "inputEl", + "desc" : "return the real input element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.UploadCropbox.json b/docs2/symbols/Roo.bootstrap.UploadCropbox.json new file mode 100644 index 0000000000..ef74f619dd --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.UploadCropbox.json @@ -0,0 +1,1401 @@ +{ + "name" : "Roo.bootstrap.UploadCropbox", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap UploadCropbox class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "errorTimeout", + "type" : "Number", + "desc" : "default 3000", + "memberOf" : "Roo.bootstrap.UploadCropbox", + "values" : [ + ] + }, + { + "name" : "buttons", + "type" : "Array", + "desc" : "default ['rotateLeft', 'pictureBtn', 'rotateRight']", + "memberOf" : "Roo.bootstrap.UploadCropbox", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "show when image has been loaded", + "memberOf" : "Roo.bootstrap.UploadCropbox", + "values" : [ + ] + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "default 300", + "memberOf" : "Roo.bootstrap.UploadCropbox", + "values" : [ + ] + }, + { + "name" : "method", + "type" : "String", + "desc" : "default POST", + "memberOf" : "Roo.bootstrap.UploadCropbox", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "paramName", + "type" : "String", + "desc" : "default 'imageUpload'", + "memberOf" : "Roo.bootstrap.UploadCropbox", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "minHeight", + "type" : "Number", + "desc" : "default 300", + "memberOf" : "Roo.bootstrap.UploadCropbox", + "values" : [ + ] + }, + { + "name" : "isDocument", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.UploadCropbox", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "loadMask", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.UploadCropbox", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "rotateNotify", + "type" : "String", + "desc" : "show when image too small to rotate", + "memberOf" : "Roo.bootstrap.UploadCropbox", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "action url", + "memberOf" : "Roo.bootstrap.UploadCropbox", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "loadingText", + "type" : "Boolean", + "desc" : "default 'Loading...'", + "memberOf" : "Roo.bootstrap.UploadCropbox", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "arrange", + "desc" : "Fire when arrange the file data", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + }, + { + "name" : "formData", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "inspect", + "desc" : "Fire when inspect the file", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + }, + { + "name" : "file", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "crop", + "desc" : "Fire after initEvent", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + }, + { + "name" : "data", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "upload", + "desc" : "Fire when xhr upload the file", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "initial", + "desc" : "Fire after initEvent", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fire when resize", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rotate", + "desc" : "Fire when rotate the image", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + }, + { + "name" : "pos", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "prepare", + "desc" : "Fire when preparing the file data", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + }, + { + "name" : "file", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeloadcanvas", + "desc" : "Fire before load the canvas", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + }, + { + "name" : "src", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "trash", + "desc" : "Fire when trash image", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeselectfile", + "desc" : "Fire before select file", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "footerbuttonclick", + "desc" : "Fire when footerbuttonclick", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + }, + { + "name" : "type", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "exception", + "desc" : "Fire when get exception", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + }, + { + "name" : "xhr", + "type" : "XMLHttpRequest", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "download", + "desc" : "Fire when download the image", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.dash.NumberBox.json b/docs2/symbols/Roo.bootstrap.dash.NumberBox.json new file mode 100644 index 0000000000..bdb27e29cc --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.dash.NumberBox.json @@ -0,0 +1,1021 @@ +{ + "name" : "Roo.bootstrap.dash.NumberBox", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap NumberBox class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "footer", + "type" : "String", + "desc" : "Footer text", + "memberOf" : "Roo.bootstrap.dash.NumberBox", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "content", + "type" : "String", + "desc" : "Box content", + "memberOf" : "Roo.bootstrap.dash.NumberBox", + "values" : [ + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "fhref", + "type" : "String", + "desc" : "Footer href", + "memberOf" : "Roo.bootstrap.dash.NumberBox", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "icon", + "type" : "String", + "desc" : "Box icon", + "memberOf" : "Roo.bootstrap.dash.NumberBox", + "values" : [ + ] + }, + { + "name" : "headline", + "type" : "String", + "desc" : "Box headline", + "memberOf" : "Roo.bootstrap.dash.NumberBox", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.dash.TabBox.json b/docs2/symbols/Roo.bootstrap.dash.TabBox.json new file mode 100644 index 0000000000..a94b82d3ae --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.dash.TabBox.json @@ -0,0 +1,1077 @@ +{ + "name" : "Roo.bootstrap.dash.TabBox", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap TabBox class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "Title of the TabBox", + "memberOf" : "Roo.bootstrap.dash.TabBox", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "icon", + "type" : "String", + "desc" : "Icon of the TabBox", + "memberOf" : "Roo.bootstrap.dash.TabBox", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "tabScrollable", + "type" : "Boolean", + "desc" : "tab scrollable when mobile view default false", + "memberOf" : "Roo.bootstrap.dash.TabBox", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "showtabs", + "type" : "Boolean", + "desc" : "show the tabs default true", + "memberOf" : "Roo.bootstrap.dash.TabBox", + "values" : [ + "(true", + "false)" + ] + } + ], + "methods" : [ + { + "name" : "setTitle", + "desc" : "Updates the box title", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.dash.TabBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "html", + "type" : "String", + "desc" : "to set the title to.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "activatepane", + "desc" : "When a pane is activated", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "pane", + "type" : "Roo.bootstrap.dash.TabPane", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addpane", + "desc" : "When a pane is added", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "pane", + "type" : "Roo.bootstrap.dash.TabPane", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.dash.TabPane.json b/docs2/symbols/Roo.bootstrap.dash.TabPane.json new file mode 100644 index 0000000000..0f749b0694 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.dash.TabPane.json @@ -0,0 +1,1040 @@ +{ + "name" : "Roo.bootstrap.dash.TabPane", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap TabPane class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "title of panel", + "memberOf" : "Roo.bootstrap.dash.TabPane", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : "Default false", + "memberOf" : "Roo.bootstrap.dash.TabPane", + "values" : [ + "(false", + "true)" + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "setTitle", + "desc" : "Updates the tab title", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.dash.TabPane", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "html", + "type" : "String", + "desc" : "to set the title to.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "activate", + "desc" : "When a pane is activated", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "pane", + "type" : "Roo.bootstrap.dash.TabPane", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.dash.json b/docs2/symbols/Roo.bootstrap.dash.json new file mode 100644 index 0000000000..52c07996d3 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.dash.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.bootstrap.dash", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.htmleditor.ToolbarStandard.json b/docs2/symbols/Roo.bootstrap.htmleditor.ToolbarStandard.json new file mode 100644 index 0000000000..6f3a283fea --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.htmleditor.ToolbarStandard.json @@ -0,0 +1,47 @@ +{ + "name" : "Roo.bootstrap.htmleditor.ToolbarStandard", + "augments" : [ + ], + "desc" : "Basic Toolbar\n\nUsage:\n\n new Roo.bootstrap.HtmlEditor({\n ....\n toolbars : [\n new Roo.bootstrap.HtmlEditorToolbar1({\n disable : { fonts: 1 , format: 1, ..., ... , ...],\n btns : [ .... ]\n })\n }", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "btns", + "type" : "Array", + "desc" : "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }", + "memberOf" : "Roo.bootstrap.htmleditor.ToolbarStandard", + "values" : [ + ] + }, + { + "name" : "disable", + "type" : "Object", + "desc" : "List of elements to disable..", + "memberOf" : "Roo.bootstrap.htmleditor.ToolbarStandard", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "updateToolbar", + "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.htmleditor.ToolbarStandard", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.htmleditor.json b/docs2/symbols/Roo.bootstrap.htmleditor.json new file mode 100644 index 0000000000..c2b80d87bc --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.htmleditor.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.bootstrap.htmleditor", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.json b/docs2/symbols/Roo.bootstrap.json new file mode 100644 index 0000000000..a1306ae253 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.bootstrap", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.layout.Basic.json b/docs2/symbols/Roo.bootstrap.layout.Basic.json new file mode 100644 index 0000000000..9d401e7b43 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.layout.Basic.json @@ -0,0 +1,597 @@ +{ + "name" : "Roo.bootstrap.layout.Basic", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "This class represents a lightweight region in a layout manager. This region does not move dom nodes\nand does not have a titlebar, tabs or any other features. All it does is size and position \npanels. To create a BasicLayoutRegion, add lightweight:true or basic:true to your regions config.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "skipConfig", + "type" : "bool", + "desc" : "skip config?", + "memberOf" : "Roo.bootstrap.layout.Basic", + "values" : [ + ] + }, + { + "name" : "region", + "type" : "string", + "desc" : "the region that it inhabits..", + "memberOf" : "Roo.bootstrap.layout.Basic", + "values" : [ + ] + }, + { + "name" : "mgr", + "type" : "Roo.bootstrap.layout.Manager", + "desc" : "The manager", + "memberOf" : "Roo.bootstrap.layout.Basic", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "remove", + "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Basic", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + }, + { + "name" : "preservePanel", + "type" : "Boolean", + "desc" : "Overrides the config preservePanel option", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel that was removed" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the container element for this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Basic", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "showPanel", + "desc" : "Show the specified panel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Basic", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panelId", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The shown panel or null" + } + ] + }, + { + "name" : "getPanel", + "desc" : "Returns the panel specified or null if it's not in this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Basic", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "" + } + ] + }, + { + "name" : "hasPanel", + "desc" : "Returns true if the panel is in this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Basic", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "resizeTo", + "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Basic", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new width or height", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getPosition", + "desc" : "Returns this regions position (north/south/east/west/center).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Basic", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "getActivePanel", + "desc" : "Get the active panel for this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Basic", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The active panel or null" + } + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this region is currently visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Basic", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "add", + "desc" : "Add the passed ContentPanel(s)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Basic", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "ContentPanel...", + "desc" : "The ContentPanel(s) to add (you can pass more than one)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel added (if only one was added)" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.layout.Border.json b/docs2/symbols/Roo.bootstrap.layout.Border.json new file mode 100644 index 0000000000..a3e76c738f --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.layout.Border.json @@ -0,0 +1,1362 @@ +{ + "name" : "Roo.bootstrap.layout.Border", + "augments" : [ + "Roo.bootstrap.layout.Manager", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "This class represents a common layout manager used in desktop applications. For screenshots and more details,\nplease see: examples/bootstrap/nested.html

\n \nThe container the layout is rendered into can be either the body element or any other element.\nIf it is not the body element, the container needs to either be an absolute positioned element,\nor you will need to add \"position:relative\" to the css of the container. You will also need to specify\nthe container size if it is not the body element.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "add", + "desc" : "Adds a ContentPanel (or subclass) to this layout.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Border", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The target region key (north, south, east, west or center).", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The added panel" + } + ] + }, + { + "name" : "remove", + "desc" : "Remove a ContentPanel (or subclass) to this layout.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Border", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The target region key (north, south, east, west or center).", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Number/String/Roo.ContentPanel", + "desc" : "The index, id or panel to remove", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The removed panel" + } + ] + }, + { + "name" : "addxtype", + "desc" : "Adds a xtype elements to the layout.\n
\n\nlayout.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\nlayout.addxtype({\n        xtype : 'NestedLayoutPanel',\n        region: 'west',\n        layout: {\n           center: { },\n           west: { }   \n        },\n        items : [ ... list of content panels or nested layout panels.. ]\n   }\n);\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Border", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cfg", + "type" : "Object", + "desc" : "Xtype definition of item to add.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addRegion", + "desc" : "Creates and adds a new region if it doesn't already exist.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Border", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The target region key (north, south, east, west or center).", + "isOptional" : false + }, + { + "name" : "config", + "type" : "Object", + "desc" : "The regions config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BorderLayoutRegion", + "desc" : "The new region" + } + ] + }, + { + "name" : "showPanel", + "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Border", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panelId", + "type" : "String/ContentPanel", + "desc" : "The panels id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The shown panel or null" + } + ] + }, + { + "name" : "findPanel", + "desc" : "Searches all regions for a panel with the specified id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Border", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panelId", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel or null if it wasn't found" + } + ] + }, + { + "name" : "layout", + "desc" : "Performs a layout update.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Border", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getViewSize", + "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The size as an object {width: (the width), height: (the height)}" + } + ] + }, + { + "name" : "isUpdating", + "desc" : "Returns true if this layout is currently being updated", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the Element this layout is bound to.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "endUpdate", + "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "noLayout", + "type" : "Boolean", + "desc" : "true to disable a layout update", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beginUpdate", + "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getRegion", + "desc" : "Returns the specified region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.LayoutRegion", + "desc" : "" + } + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "regioncollapsed", + "desc" : "Fires when a region is collapsed.", + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The collapsed region", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "regionexpanded", + "desc" : "Fires when a region is expanded.", + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The expanded region", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "layout", + "desc" : "Fires when a layout is performed.", + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutManager", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "regionresized", + "desc" : "Fires when the user resizes a region.", + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The resized region", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size (width for east/west, height for north/south)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.layout.Manager.json b/docs2/symbols/Roo.bootstrap.layout.Manager.json new file mode 100644 index 0000000000..4eee673d4b --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.layout.Manager.json @@ -0,0 +1,1170 @@ +{ + "name" : "Roo.bootstrap.layout.Manager", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Base class for layout managers.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getViewSize", + "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The size as an object {width: (the width), height: (the height)}" + } + ] + }, + { + "name" : "isUpdating", + "desc" : "Returns true if this layout is currently being updated", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the Element this layout is bound to.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "endUpdate", + "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "noLayout", + "type" : "Boolean", + "desc" : "true to disable a layout update", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beginUpdate", + "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getRegion", + "desc" : "Returns the specified region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.LayoutRegion", + "desc" : "" + } + ] + }, + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "regioncollapsed", + "desc" : "Fires when a region is collapsed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The collapsed region", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "regionexpanded", + "desc" : "Fires when a region is expanded.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The expanded region", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "layout", + "desc" : "Fires when a layout is performed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutManager", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "regionresized", + "desc" : "Fires when the user resizes a region.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The resized region", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size (width for east/west, height for north/south)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.layout.Region.json b/docs2/symbols/Roo.bootstrap.layout.Region.json new file mode 100644 index 0000000000..ac25e9b2bb --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.layout.Region.json @@ -0,0 +1,963 @@ +{ + "name" : "Roo.bootstrap.layout.Region", + "augments" : [ + "Roo.bootstrap.layout.Basic", + "Roo.util.Observable" + ], + "desc" : "This class represents a region in a layout manager.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "cmargins", + "type" : "Object", + "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "alwaysShowTabs", + "type" : "Boolean", + "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "overflow", + "type" : "String", + "desc" : "if you have menus in the region, then you need to set this to visible.", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + "(hidden", + "visible)" + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "margins", + "type" : "Object", + "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "preferredTabWidth", + "type" : "Number", + "desc" : "The preferred tab width (defaults to 150)", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "disableTabTips", + "type" : "Boolean", + "desc" : "True to disable tab tooltips", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "skipConfig", + "type" : "bool", + "desc" : "skip config?", + "memberOf" : "Roo.bootstrap.layout.Basic", + "values" : [ + ] + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to enable overflow scrolling (defaults to false)", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to start the region hidden (defaults to false)", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "toolbar", + "type" : "Boolean", + "desc" : "xtype configuration for a toolbar - shows on right of tabbar", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "region", + "type" : "string", + "desc" : "the region that it inhabits..", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title for the region (overrides panel titles)", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "hideWhenEmpty", + "type" : "Boolean", + "desc" : "True to hide the region when it has no panels", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "mgr", + "type" : "Roo.bootstrap.layout.Manager", + "desc" : "The manager", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "string", + "desc" : "Extra CSS classes to add to region", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "hideTabs", + "type" : "Boolean", + "desc" : "True to hide the tab strip (defaults to false)", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "resizeTabs", + "type" : "Boolean", + "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "tabPosition", + "type" : "String", + "desc" : "\"top\" or \"bottom\" (defaults to \"bottom\")", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + "(top", + "bottom)" + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "For East/West panels", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "minTabWidth", + "type" : "Number", + "desc" : "The minimum tab width (defaults to 40)", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "split", + "type" : "Boolean", + "desc" : "To show the splitter", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "titlebar", + "type" : "Boolean", + "desc" : "True to display a title bar (defaults to true)", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "preservePanels", + "type" : "Boolean", + "desc" : "True to preserve removed panels so they can be readded later (defaults to false)", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "closeOnTab", + "type" : "Boolean", + "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "For North/South panels", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "animate", + "type" : "Boolean", + "desc" : "True to animate expand/collapse (defaults to false)", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + }, + { + "name" : "autoHide", + "type" : "Boolean", + "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)", + "memberOf" : "Roo.bootstrap.layout.Region", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "unhidePanel", + "desc" : "Unhides the tab for a previously hidden panel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Region", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "showPanel", + "desc" : "Shows the specified panel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Region", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panelId", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The shown panel, or null if a panel could not be found from panelId" + } + ] + }, + { + "name" : "add", + "desc" : "Adds the passed ContentPanel(s) to this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Region", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "ContentPanel...", + "desc" : "The ContentPanel(s) to add (you can pass more than one)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel added (if only one was added; null otherwise)" + } + ] + }, + { + "name" : "animateCollapse", + "desc" : "Collapses this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Region", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "skipAnim", + "type" : "Boolean", + "desc" : "(optional) true to collapse the element without animation (if animate is true)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "animateExpand", + "desc" : "Expands this region if it was previously collapsed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Region", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event that triggered the expand (or null if calling manually)", + "isOptional" : false + }, + { + "name" : "skipAnim", + "type" : "Boolean", + "desc" : "(optional) true to expand the element without animation (if animate is true)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Region", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + }, + { + "name" : "preservePanel", + "type" : "Boolean", + "desc" : "Overrides the config preservePanel option", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel that was removed" + } + ] + }, + { + "name" : "hide", + "desc" : "Hides this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Region", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Shows this region if it was previously hidden.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Region", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Region", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hidePanel", + "desc" : "Hides the tab for the specified panel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Region", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getActivePanel", + "desc" : "Get the active panel for this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Region", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The active panel or null" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the container element for this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Region", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "getTabs", + "desc" : "Returns the TabPanel component used by this region", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Region", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanel", + "desc" : "" + } + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this region is currently visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Region", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getPanel", + "desc" : "Returns the panel specified or null if it's not in this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Basic", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "" + } + ] + }, + { + "name" : "hasPanel", + "desc" : "Returns true if the panel is in this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Basic", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "resizeTo", + "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Basic", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new width or height", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getPosition", + "desc" : "Returns this regions position (north/south/east/west/center).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Basic", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.layout.Split.json b/docs2/symbols/Roo.bootstrap.layout.Split.json new file mode 100644 index 0000000000..cd558c00f0 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.layout.Split.json @@ -0,0 +1,1253 @@ +{ + "name" : "Roo.bootstrap.layout.Split", + "augments" : [ + "Roo.LayoutRegion", + "Roo.BasicLayoutRegion", + "Roo.util.Observable" + ], + "desc" : "Adds a splitbar and other (private) useful functionality to a {@link Roo.LayoutRegion}.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "cmargins", + "type" : "Object", + "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "alwaysShowTabs", + "type" : "Boolean", + "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "margins", + "type" : "Object", + "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "preferredTabWidth", + "type" : "Number", + "desc" : "The preferred tab width (defaults to 150)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "disableTabTips", + "type" : "Boolean", + "desc" : "True to disable tab tooltips", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "collapsible", + "type" : "Boolean", + "desc" : "False to disable collapsing (defaults to true)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "collapsedTitle", + "type" : "String", + "desc" : "Optional string message to display in the collapsed block of a north or south region", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to enable overflow scrolling (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to start the region hidden (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "toolbar", + "type" : "Boolean", + "desc" : "xtype configuration for a toolbar - shows on right of tabbar", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title for the region (overrides panel titles)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "hideWhenEmpty", + "type" : "Boolean", + "desc" : "True to hide the region when it has no panels", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "collapsed", + "type" : "Boolean", + "desc" : "True to set the initial display to collapsed (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "hideTabs", + "type" : "Boolean", + "desc" : "True to hide the tab strip (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "resizeTabs", + "type" : "Boolean", + "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "tabPosition", + "type" : "String", + "desc" : "\"top\" or \"bottom\" (defaults to \"bottom\")", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + "(top", + "bottom)" + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "For East/West panels", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "floatable", + "type" : "Boolean", + "desc" : "False to disable floating (defaults to true)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "minTabWidth", + "type" : "Number", + "desc" : "The minimum tab width (defaults to 40)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "split", + "type" : "Boolean", + "desc" : "To show the splitter", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "titlebar", + "type" : "Boolean", + "desc" : "True to display a title bar (defaults to true)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "preservePanels", + "type" : "Boolean", + "desc" : "True to preserve removed panels so they can be readded later (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "closeOnTab", + "type" : "Boolean", + "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "For North/South panels", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "animate", + "type" : "Boolean", + "desc" : "True to animate expand/collapse (defaults to false)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "autoHide", + "type" : "Boolean", + "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + }, + { + "name" : "showPin", + "type" : "Boolean", + "desc" : "True to show a pin button", + "memberOf" : "Roo.LayoutRegion", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getSplitBar", + "desc" : "Returns the {@link Roo.SplitBar} for this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.layout.Split", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.SplitBar", + "desc" : "" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the container element for this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "remove", + "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + }, + { + "name" : "preservePanel", + "type" : "Boolean", + "desc" : "Overrides the config preservePanel option", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel that was removed" + } + ] + }, + { + "name" : "getActivePanel", + "desc" : "Get the active panel for this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The active panel or null" + } + ] + }, + { + "name" : "collapse", + "desc" : "Collapses this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "skipAnim", + "type" : "Boolean", + "desc" : "(optional) true to collapse the element without animation (if animate is true)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "unhidePanel", + "desc" : "Unhides the tab for a previously hidden panel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setCollapsedTitle", + "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getTabs", + "desc" : "Returns the TabPanel component used by this region", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanel", + "desc" : "" + } + ] + }, + { + "name" : "expand", + "desc" : "Expands this region if it was previously collapsed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event that triggered the expand (or null if calling manually)", + "isOptional" : false + }, + { + "name" : "skipAnim", + "type" : "Boolean", + "desc" : "(optional) true to expand the element without animation (if animate is true)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this region is currently visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "showPanel", + "desc" : "Shows the specified panel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panelId", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The shown panel, or null if a panel could not be found from panelId" + } + ] + }, + { + "name" : "hide", + "desc" : "Hides this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Shows this region if it was previously hidden.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "add", + "desc" : "Adds the passed ContentPanel(s) to this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "ContentPanel...", + "desc" : "The ContentPanel(s) to add (you can pass more than one)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel added (if only one was added; null otherwise)" + } + ] + }, + { + "name" : "hidePanel", + "desc" : "Hides the tab for the specified panel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.LayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hasPanel", + "desc" : "Returns true if the panel is in this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "resizeTo", + "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new width or height", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getPosition", + "desc" : "Returns this regions position (north/south/east/west/center).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "getPanel", + "desc" : "Returns the panel specified or null if it's not in this region.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "paneladded", + "desc" : "Fires when a panel is added.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalidated", + "desc" : "Fires when the layout for this region is changed.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "expanded", + "desc" : "Fires when this region is expanded.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeremove", + "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The cancel event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collapsed", + "desc" : "Fires when this region is collapsed.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "panelremoved", + "desc" : "Fires when a panel is removed.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforecollapse", + "desc" : "Fires when this region before collapse.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "slidehide", + "desc" : "Fires when this region slides out of view.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "visibilitychange", + "desc" : "Fires when this region is shown or hidden", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "visibility", + "type" : "Boolean", + "desc" : "true or false", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "slideshow", + "desc" : "Fires when this region is slid into view.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "panelactivated", + "desc" : "Fires when a panel is activated.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The activated panel", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resized", + "desc" : "Fires when the user resizes this region.", + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size (width for east/west, height for north/south)", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.layout.json b/docs2/symbols/Roo.bootstrap.layout.json new file mode 100644 index 0000000000..3baecee8b0 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.layout.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.bootstrap.layout", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.menu.Item.json b/docs2/symbols/Roo.bootstrap.menu.Item.json new file mode 100644 index 0000000000..e8a140c161 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.menu.Item.json @@ -0,0 +1,1112 @@ +{ + "name" : "Roo.bootstrap.menu.Item", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap MenuItem class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "text of the item", + "memberOf" : "Roo.bootstrap.menu.Item", + "values" : [ + ] + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : "default true", + "memberOf" : "Roo.bootstrap.menu.Item", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "pos", + "type" : "String", + "desc" : "Submenu align to (left | right) default right", + "memberOf" : "Roo.bootstrap.menu.Item", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "submenu", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.menu.Item", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "disable", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.bootstrap.menu.Item", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "icon", + "type" : "String", + "desc" : "Font awesome icon", + "memberOf" : "Roo.bootstrap.menu.Item", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "href", + "type" : "String", + "desc" : "the link", + "memberOf" : "Roo.bootstrap.menu.Item", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "mouseover", + "desc" : "Fires when the mouse is hovering over this menu", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.menu.Item", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseout", + "desc" : "Fires when the mouse exits this menu", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.menu.Item", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "The raw click event for the entire grid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.menu.Menu.json b/docs2/symbols/Roo.bootstrap.menu.Menu.json new file mode 100644 index 0000000000..6003c9f5a5 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.menu.Menu.json @@ -0,0 +1,1045 @@ +{ + "name" : "Roo.bootstrap.menu.Menu", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Menu class - container for Menu", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "html", + "type" : "String", + "desc" : "Text of the menu", + "memberOf" : "Roo.bootstrap.menu.Menu", + "values" : [ + ] + }, + { + "name" : "pos", + "type" : "String", + "desc" : "Menu align to (top | bottom) default bottom", + "memberOf" : "Roo.bootstrap.menu.Menu", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "icon", + "type" : "String", + "desc" : "Font awesome icon", + "memberOf" : "Roo.bootstrap.menu.Menu", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "weight", + "type" : "String", + "desc" : "", + "memberOf" : "Roo.bootstrap.menu.Menu", + "values" : [ + "(default", + "primary", + "success", + "info", + "warning", + "danger", + "inverse)" + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before this menu is hidden", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before this menu is displayed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after this menu is hidden", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after this menu is displayed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.menu.Separator.json b/docs2/symbols/Roo.bootstrap.menu.Separator.json new file mode 100644 index 0000000000..ff1c1086a8 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.menu.Separator.json @@ -0,0 +1,981 @@ +{ + "name" : "Roo.bootstrap.menu.Separator", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Bootstrap Separator class", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + "(el", + "parent)" + ] + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "memberOf" : "Roo.bootstrap.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "desc" : "Fetch the element to display the tooltip on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "desc" : "Hide a component - adds 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Show a component - removes 'hidden' class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setVisibilityEl", + "desc" : "Set the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getVisibilityEl", + "desc" : "Get the element that will be used to show or hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "initEvents", + "desc" : "Initialize Events for the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChildContainer", + "desc" : "Fetch the element to add children to", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "childrenrendered", + "desc" : "Fires when the children have been rendered..", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.menu.json b/docs2/symbols/Roo.bootstrap.menu.json new file mode 100644 index 0000000000..6963ba2a95 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.menu.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.bootstrap.menu", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.panel.Content.json b/docs2/symbols/Roo.bootstrap.panel.Content.json new file mode 100644 index 0000000000..83920b22c6 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.panel.Content.json @@ -0,0 +1,861 @@ +{ + "name" : "Roo.bootstrap.panel.Content", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "A basic ContentPanel element.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "badges", + "type" : "Boolean", + "desc" : "render the badges", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "fitToFrame", + "type" : "Boolean", + "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "background", + "type" : "Boolean", + "desc" : "True if the panel should not be activated when it is added (defaults to false)", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "toolbar", + "type" : "Toolbar", + "desc" : "A toolbar for this panel", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "region", + "type" : "String", + "desc" : "which region to put this panel on (when used with xtype constructors)", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + "(center", + "north", + "south", + "east", + "west)" + ] + }, + { + "name" : "content", + "type" : "String", + "desc" : "Raw content to fill content panel with (uses setContent on construction.)", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title for this panel", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "fitContainer", + "type" : "Boolean", + "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "True if the panel can be closed/removed", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "adjustments", + "type" : "Array", + "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "Calls {@link #setUrl} with this value", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "resizeEl", + "type" : "String/HTMLElement/Element", + "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "refresh", + "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getUpdateManager", + "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "getChildContainer", + "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cfg", + "type" : "Object", + "desc" : "Xtype definition of item to add.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getToolbar", + "desc" : "Returns the toolbar for this Panel if one was configured.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar", + "desc" : "" + } + ] + }, + { + "name" : "setTitle", + "desc" : "Set this panel's title", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setUrl", + "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "String/Function", + "desc" : "The URL to load the content from or a function to call to get the URL", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)", + "isOptional" : false + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns this panel's element - used by regiosn to add.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this panel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "load", + "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "Object/String/Function", + "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n
\npanel.load({\n    url: \"your-url.php\",\n    params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n    callback: yourFunction,\n    scope: yourObject, //(optional scope)\n    discardUrl: false,\n    nocache: false,\n    text: \"Loading...\",\n    timeout: 30,\n    scripts: false\n});\n
\nThe only required property is url. The optional properties nocache, text and scripts\nare shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this panel UpdateManager instance.", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)", + "isOptional" : false + }, + { + "name" : "discardUrl", + "type" : "Boolean", + "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "this" + } + ] + }, + { + "name" : "getTitle", + "desc" : "Returns this panel's title", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "isClosable", + "desc" : "Returns true is this panel was configured to be closable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns this panel's id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "setContent", + "desc" : "Updates this panel's element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "content", + "type" : "String", + "desc" : "The new content", + "isOptional" : false + }, + { + "name" : "loadScripts", + "type" : "Boolean", + "desc" : "(optional) true to look for and process scripts", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "activate", + "desc" : "Fires when this panel is activated.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires when this panel is resized if fitToFrame is true.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The width after any component adjustments", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The height after any component adjustments", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "deactivate", + "desc" : "Fires when this panel is activated.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires when this tab is created", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.panel.Grid.json b/docs2/symbols/Roo.bootstrap.panel.Grid.json new file mode 100644 index 0000000000..7db3b327e2 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.panel.Grid.json @@ -0,0 +1,891 @@ +{ + "name" : "Roo.bootstrap.panel.Grid", + "augments" : [ + "Roo.bootstrap.panel.Content", + "Roo.util.Observable" + ], + "desc" : "Create a new GridPanel.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "badges", + "type" : "Boolean", + "desc" : "render the badges", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "fitToFrame", + "type" : "Boolean", + "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "background", + "type" : "Boolean", + "desc" : "True if the panel should not be activated when it is added (defaults to false)", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "toolbar", + "type" : "Toolbar", + "desc" : "A toolbar for this panel", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "region", + "type" : "String", + "desc" : "which region to put this panel on (when used with xtype constructors)", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + "(center", + "north", + "south", + "east", + "west)" + ] + }, + { + "name" : "content", + "type" : "String", + "desc" : "Raw content to fill content panel with (uses setContent on construction.)", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title for this panel", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "fitContainer", + "type" : "Boolean", + "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "grid", + "type" : "Roo.bootstrap.Table", + "desc" : "The grid for this panel", + "memberOf" : "Roo.bootstrap.panel.Grid", + "values" : [ + ] + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "True if the panel can be closed/removed", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "adjustments", + "type" : "Array", + "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "Calls {@link #setUrl} with this value", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "resizeEl", + "type" : "String/HTMLElement/Element", + "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getGrid", + "desc" : "Returns the grid for this panel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.bootstrap.Table", + "desc" : "" + } + ] + }, + { + "name" : "refresh", + "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getUpdateManager", + "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "getChildContainer", + "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cfg", + "type" : "Object", + "desc" : "Xtype definition of item to add.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getToolbar", + "desc" : "Returns the toolbar for this Panel if one was configured.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar", + "desc" : "" + } + ] + }, + { + "name" : "setTitle", + "desc" : "Set this panel's title", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setUrl", + "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "String/Function", + "desc" : "The URL to load the content from or a function to call to get the URL", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)", + "isOptional" : false + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns this panel's element - used by regiosn to add.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this panel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "load", + "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "Object/String/Function", + "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n
\npanel.load({\n    url: \"your-url.php\",\n    params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n    callback: yourFunction,\n    scope: yourObject, //(optional scope)\n    discardUrl: false,\n    nocache: false,\n    text: \"Loading...\",\n    timeout: 30,\n    scripts: false\n});\n
\nThe only required property is url. The optional properties nocache, text and scripts\nare shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this panel UpdateManager instance.", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)", + "isOptional" : false + }, + { + "name" : "discardUrl", + "type" : "Boolean", + "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "this" + } + ] + }, + { + "name" : "getTitle", + "desc" : "Returns this panel's title", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "isClosable", + "desc" : "Returns true is this panel was configured to be closable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns this panel's id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "setContent", + "desc" : "Updates this panel's element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "content", + "type" : "String", + "desc" : "The new content", + "isOptional" : false + }, + { + "name" : "loadScripts", + "type" : "Boolean", + "desc" : "(optional) true to look for and process scripts", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "activate", + "desc" : "Fires when this panel is activated.", + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires when this panel is resized if fitToFrame is true.", + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The width after any component adjustments", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The height after any component adjustments", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "deactivate", + "desc" : "Fires when this panel is activated.", + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires when this tab is created", + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.panel.Nest.json b/docs2/symbols/Roo.bootstrap.panel.Nest.json new file mode 100644 index 0000000000..fa7e766f77 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.panel.Nest.json @@ -0,0 +1,905 @@ +{ + "name" : "Roo.bootstrap.panel.Nest", + "augments" : [ + "Roo.bootstrap.panel.Content", + "Roo.util.Observable" + ], + "desc" : "Create a new Panel, that can contain a layout.Border.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "badges", + "type" : "Boolean", + "desc" : "render the badges", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "autoScroll", + "type" : "Boolean", + "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "fitToFrame", + "type" : "Boolean", + "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "background", + "type" : "Boolean", + "desc" : "True if the panel should not be activated when it is added (defaults to false)", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "toolbar", + "type" : "Toolbar", + "desc" : "A toolbar for this panel", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "region", + "type" : "String", + "desc" : "which region to put this panel on (when used with xtype constructors)", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + "(center", + "north", + "south", + "east", + "west)" + ] + }, + { + "name" : "content", + "type" : "String", + "desc" : "Raw content to fill content panel with (uses setContent on construction.)", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "The title for this panel", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "fitContainer", + "type" : "Boolean", + "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "True if the panel can be closed/removed", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "adjustments", + "type" : "Array", + "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "Calls {@link #setUrl} with this value", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + }, + { + "name" : "resizeEl", + "type" : "String/HTMLElement/Element", + "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", + "memberOf" : "Roo.bootstrap.panel.Content", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getLayout", + "desc" : "Returns the nested BorderLayout for this panel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Nest", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BorderLayout", + "desc" : "" + } + ] + }, + { + "name" : "addxtype", + "desc" : "Adds a xtype elements to the layout of the nested panel\n
\n\npanel.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\npanel.addxtype({\n        xtype : 'NestedLayoutPanel',\n        region: 'west',\n        layout: {\n           center: { },\n           west: { }   \n        },\n        items : [ ... list of content panels or nested layout panels.. ]\n   }\n);\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Nest", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cfg", + "type" : "Object", + "desc" : "Xtype definition of item to add.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "refresh", + "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getUpdateManager", + "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "getChildContainer", + "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cfg", + "type" : "Object", + "desc" : "Xtype definition of item to add.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getToolbar", + "desc" : "Returns the toolbar for this Panel if one was configured.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar", + "desc" : "" + } + ] + }, + { + "name" : "setTitle", + "desc" : "Set this panel's title", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setUrl", + "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "String/Function", + "desc" : "The URL to load the content from or a function to call to get the URL", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)", + "isOptional" : false + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns this panel's element - used by regiosn to add.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this panel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "load", + "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "Object/String/Function", + "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n
\npanel.load({\n    url: \"your-url.php\",\n    params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n    callback: yourFunction,\n    scope: yourObject, //(optional scope)\n    discardUrl: false,\n    nocache: false,\n    text: \"Loading...\",\n    timeout: 30,\n    scripts: false\n});\n
\nThe only required property is url. The optional properties nocache, text and scripts\nare shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this panel UpdateManager instance.", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)", + "isOptional" : false + }, + { + "name" : "discardUrl", + "type" : "Boolean", + "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "this" + } + ] + }, + { + "name" : "getTitle", + "desc" : "Returns this panel's title", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "isClosable", + "desc" : "Returns true is this panel was configured to be closable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getId", + "desc" : "Returns this panel's id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "setContent", + "desc" : "Updates this panel's element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "content", + "type" : "String", + "desc" : "The new content", + "isOptional" : false + }, + { + "name" : "loadScripts", + "type" : "Boolean", + "desc" : "(optional) true to look for and process scripts", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "activate", + "desc" : "Fires when this panel is activated.", + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires when this panel is resized if fitToFrame is true.", + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The width after any component adjustments", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The height after any component adjustments", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "deactivate", + "desc" : "Fires when this panel is activated.", + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires when this tab is created", + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.panel.TabItem.json b/docs2/symbols/Roo.bootstrap.panel.TabItem.json new file mode 100644 index 0000000000..8ad957d2aa --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.panel.TabItem.json @@ -0,0 +1,733 @@ +{ + "name" : "Roo.bootstrap.panel.TabItem", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "Represents an individual item (tab plus body) in a TabPanel.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "hide", + "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.TabItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Shows this TabPanelItem -- this does not deactivate the currently active TabPanelItem.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.TabItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isHidden", + "desc" : "Returns true if this tab is \"hidden\"", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.TabItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "activate", + "desc" : "Activates this TabPanelItem -- this does deactivate the currently active TabPanelItem.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.TabItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isActive", + "desc" : "Returns true if this tab is the active tab.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.TabItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "disable", + "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.TabItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setUrl", + "desc" : "Set a URL to be used to load the content for this TabPanelItem.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.TabItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "url", + "type" : "String/Function", + "desc" : "The URL to load the content from, or a function to call to get the URL", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)", + "isOptional" : false + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this TabPanelItem is activated. (Defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "setContent", + "desc" : "Sets the content for this TabPanelItem.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.TabItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "content", + "type" : "String", + "desc" : "The content", + "isOptional" : false + }, + { + "name" : "loadScripts", + "type" : "Boolean", + "desc" : "true to look for and load scripts", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getUpdateManager", + "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.TabItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] + }, + { + "name" : "setTooltip", + "desc" : "Set the tooltip for the tab.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.TabItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tooltip", + "type" : "String", + "desc" : "The tab's tooltip", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getText", + "desc" : "Returns the text for this tab", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.TabItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "setText", + "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.TabItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The tab's text and tooltip", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setHidden", + "desc" : "Show or hide the tab", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.TabItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to hide or false to show.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "refresh", + "desc" : "Forces a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the setUrl method has not been called.\n This does not activate the panel, just updates its content.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.TabItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Enables this TabPanelItem if it was previously disabled.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.TabItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "close", + "desc" : "Fires when this tab is closed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.TabPanelItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Fires when this tab becomes the active tab.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tabPanel", + "type" : "Roo.TabPanel", + "desc" : "The parent TabPanel", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Roo.TabPanelItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeclose", + "desc" : "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.TabPanelItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "Set cancel to true on this object to cancel the close.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "deactivate", + "desc" : "Fires when this tab is no longer the active tab.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tabPanel", + "type" : "Roo.TabPanel", + "desc" : "The parent TabPanel", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Roo.TabPanelItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.panel.Tabs.json b/docs2/symbols/Roo.bootstrap.panel.Tabs.json new file mode 100644 index 0000000000..27cfa52cc6 --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.panel.Tabs.json @@ -0,0 +1,769 @@ +{ + "name" : "Roo.bootstrap.panel.Tabs", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "A lightweight tab container.\n

\nUsage:\n
\n// basic tabs 1, built from existing content\nvar tabs = new Roo.TabPanel(\"tabs1\");\ntabs.addTab(\"script\", \"View Script\");\ntabs.addTab(\"markup\", \"View Markup\");\ntabs.activate(\"script\");\n\n// more advanced tabs, built from javascript\nvar jtabs = new Roo.TabPanel(\"jtabs\");\njtabs.addTab(\"jtabs-1\", \"Normal Tab\", \"My content was added during construction.\");\n\n// set up the UpdateManager\nvar tab2 = jtabs.addTab(\"jtabs-2\", \"Ajax Tab 1\");\nvar updater = tab2.getUpdateManager();\nupdater.setDefaultUrl(\"ajax1.htm\");\ntab2.on('activate', updater.refresh, updater, true);\n\n// Use setUrl for Ajax loading\nvar tab3 = jtabs.addTab(\"jtabs-3\", \"Ajax Tab 2\");\ntab3.setUrl(\"ajax2.htm\", null, true);\n\n// Disabled tab\nvar tab4 = jtabs.addTab(\"tabs1-5\", \"Disabled Tab\", \"Can't see me cause I'm disabled\");\ntab4.disable();\n\njtabs.activate(\"jtabs-1\");\n
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "setTabWidth", + "desc" : "Resizes all the tabs to the passed width", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Tabs", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "The", + "type" : "Number", + "desc" : "new width", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "endUpdate", + "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Tabs", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "disableTab", + "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Tabs", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to disable.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getTab", + "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Tabs", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to fetch.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanelItem", + "desc" : "" + } + ] + }, + { + "name" : "unhideTab", + "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Tabs", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to unhide.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beginUpdate", + "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Tabs", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "enableTab", + "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Tabs", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to enable.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getCount", + "desc" : "Returns the number of tabs in this TabPanel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Tabs", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this TabPanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Tabs", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "removeEl", + "type" : "Boolean", + "desc" : "(optional) True to remove the element from the DOM as well (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncHeight", + "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Tabs", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "targetHeight", + "type" : "Number", + "desc" : "(optional) Override the starting height from the elements height", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Tabs", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to activate.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanelItem", + "desc" : "The TabPanelItem." + } + ] + }, + { + "name" : "autoSizeTabs", + "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Tabs", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "addTabItem", + "desc" : "Adds an existing {@link Roo.TabPanelItem}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Tabs", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.TabPanelItem", + "desc" : "The TabPanelItem to add", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addTab", + "desc" : "Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Tabs", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of the div to use or create", + "isOptional" : false + }, + { + "name" : "text", + "type" : "String", + "desc" : "The text for the tab", + "isOptional" : false + }, + { + "name" : "content", + "type" : "String", + "desc" : "(optional) Content to put in the TabPanelItem body", + "isOptional" : false + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "(optional) True to create a close icon on the tab", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanelItem", + "desc" : "The created TabPanelItem" + } + ] + }, + { + "name" : "removeTab", + "desc" : "Removes a {@link Roo.TabPanelItem}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Tabs", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to remove.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hideTab", + "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Tabs", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to hide.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getActiveTab", + "desc" : "Gets the active {@link Roo.TabPanelItem}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.bootstrap.panel.Tabs", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanelItem", + "desc" : "The active TabPanelItem or null if none are active." + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "tabchange", + "desc" : "Fires when the active tab changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.TabPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "activePanel", + "type" : "Roo.TabPanelItem", + "desc" : "The new active tab", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforetabchange", + "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.TabPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "Set cancel to true on this object to cancel the tab change", + "isOptional" : false + }, + { + "name" : "tab", + "type" : "Roo.TabPanelItem", + "desc" : "The tab being changed to", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.bootstrap.panel.json b/docs2/symbols/Roo.bootstrap.panel.json new file mode 100644 index 0000000000..47f661822d --- /dev/null +++ b/docs2/symbols/Roo.bootstrap.panel.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.bootstrap.panel", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.data.ArrayReader.json b/docs2/symbols/Roo.data.ArrayReader.json new file mode 100644 index 0000000000..b3c23d65cb --- /dev/null +++ b/docs2/symbols/Roo.data.ArrayReader.json @@ -0,0 +1,86 @@ +{ + "name" : "Roo.data.ArrayReader", + "augments" : [ + "Roo.data.DataReader" + ], + "desc" : "Data reader class to create an Array of Roo.data.Record objects from an Array.\nEach element of that Array represents a row of data fields. The\nfields are pulled into a Record object using as a subscript, the mapping property\nof the field definition if it exists, or the field's ordinal position in the definition.
\n

\nExample code:.\n

\nvar RecordDef = Roo.data.Record.create([\n    {name: 'name', mapping: 1},         // \"mapping\" only needed if an \"id\" field is present which\n    {name: 'occupation', mapping: 2}    // precludes using the ordinal position as the index.\n]);\nvar myReader = new Roo.data.ArrayReader({\n    id: 0                     // The subscript within row Array that provides an ID for the Record (optional)\n}, RecordDef);\n
\n

\nThis would consume an Array like this:\n

\n[ [1, 'Bill', 'Gardener'], [2, 'Ben', 'Horticulturalist'] ]\n  
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "fields", + "type" : "Array", + "desc" : "Array of field definition objects", + "memberOf" : "Roo.data.ArrayReader", + "values" : [ + ] + }, + { + "name" : "id", + "type" : "String", + "desc" : "(optional) The subscript within row Array that provides an ID for the Record", + "memberOf" : "Roo.data.ArrayReader", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "readRecords", + "desc" : "Create a data block containing Roo.data.Records from an XML document.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.ArrayReader", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "An Array of row objects which represents the dataset.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records." + } + ] + }, + { + "name" : "newRow", + "desc" : "Create an empty record", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.DataReader", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "(optional) - overlay some values", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "record created." + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.data.Connection.json b/docs2/symbols/Roo.data.Connection.json new file mode 100644 index 0000000000..0bb5fa91f9 --- /dev/null +++ b/docs2/symbols/Roo.data.Connection.json @@ -0,0 +1,545 @@ +{ + "name" : "Roo.data.Connection", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "The class encapsulates a connection to the page's originating domain, allowing requests to be made\neither to a configured URL, or to a URL specified at request time.

\n

\nRequests made by this class are asynchronous, and will return immediately. No data from\nthe server will be available to the statement immediately following the {@link #request} call.\nTo process returned data, use a callback in the request options object, or an event listener.


\n

\nNote: If you are doing a file upload, you will not get a normal response object sent back to\nyour callback or event handler. Since the upload is handled via in IFRAME, there is no XMLHttpRequest.\nThe response object is created using the innerHTML of the IFRAME's document as the responseText\nproperty and, if present, the IFRAME's XML document as the responseXML property.


\nThis means that a valid XML or HTML document must be returned. If JSON data is required, it is suggested\nthat it be placed either inside a <textarea> in an HTML document and retrieved from the responseText\nusing a regex, or inside a CDATA section in an XML document and retrieved from the responseXML using\nstandard DOM methods.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "method", + "type" : "String", + "desc" : "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)", + "memberOf" : "Roo.data.Connection", + "values" : [ + ] + }, + { + "name" : "timeout", + "type" : "Number", + "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)", + "memberOf" : "Roo.data.Connection", + "values" : [ + ] + }, + { + "name" : "autoAbort", + "type" : "Boolean", + "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)", + "memberOf" : "Roo.data.Connection", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)", + "memberOf" : "Roo.data.Connection", + "values" : [ + ] + }, + { + "name" : "extraParams", + "type" : "Object", + "desc" : "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)", + "memberOf" : "Roo.data.Connection", + "values" : [ + ] + }, + { + "name" : "disableCaching", + "type" : "Boolean", + "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)", + "memberOf" : "Roo.data.Connection", + "values" : [ + ] + }, + { + "name" : "defaultHeaders", + "type" : "Object", + "desc" : "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)", + "memberOf" : "Roo.data.Connection", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "isLoading", + "desc" : "Determine whether this object has a request outstanding.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Connection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "transactionId", + "type" : "Number", + "desc" : "(Optional) defaults to the last transaction", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if there is an outstanding request." + } + ] + }, + { + "name" : "request", + "desc" : "Sends an HTTP request to a remote server.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Connection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "An object which may contain the following properties:
    \n
  • url {String} (Optional) The URL to which to send the request. Defaults to configured URL
  • \n
  • params {Object/String/Function} (Optional) An object containing properties which are used as parameters to the\nrequest, a url encoded string or a function to call to get either.
  • \n
  • method {String} (Optional) The HTTP method to use for the request. Defaults to the configured method, or\nif no method was configured, \"GET\" if no parameters are being sent, and \"POST\" if parameters are being sent.
  • \n
  • callback {Function} (Optional) The function to be called upon receipt of the HTTP response.\nThe callback is called regardless of success or failure and is passed the following parameters:
      \n
    • options {Object} The parameter to the request call.
    • \n
    • success {Boolean} True if the request succeeded.
    • \n
    • response {Object} The XMLHttpRequest object containing the response data.
    • \n
  • \n
  • success {Function} (Optional) The function to be called upon success of the request.\nThe callback is passed the following parameters:
      \n
    • response {Object} The XMLHttpRequest object containing the response data.
    • \n
    • options {Object} The parameter to the request call.
    • \n
  • \n
  • failure {Function} (Optional) The function to be called upon failure of the request.\nThe callback is passed the following parameters:
      \n
    • response {Object} The XMLHttpRequest object containing the response data.
    • \n
    • options {Object} The parameter to the request call.
    • \n
  • \n
  • scope {Object} (Optional) The scope in which to execute the callbacks: The \"this\" object\nfor the callback function. Defaults to the browser window.
  • \n
  • form {Object/String} (Optional) A form object or id to pull parameters from.
  • \n
  • isUpload {Boolean} (Optional) True if the form object is a file upload (will usually be automatically detected).
  • \n
  • headers {Object} (Optional) Request headers to set for the request.
  • \n
  • xmlData {Object} (Optional) XML document to use for the post. Note: This will be used instead of\nparams for the post data. Any params will be appended to the URL.
  • \n
  • disableCaching {Boolean} (Optional) True to add a unique cache-buster param to GET requests.
  • \n
", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "transactionId" + } + ] + }, + { + "name" : "abort", + "desc" : "Aborts any outstanding request.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Connection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "transactionId", + "type" : "Number", + "desc" : "(Optional) defaults to the last transaction", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "requestcomplete", + "desc" : "Fires if the request was successfully completed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "conn", + "type" : "Connection", + "desc" : "This Connection object.", + "isOptional" : false + }, + { + "name" : "response", + "type" : "Object", + "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The options config object passed to the {@link #request} method.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerequest", + "desc" : "Fires before a network request is made to retrieve a data object.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "conn", + "type" : "Connection", + "desc" : "This Connection object.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The options config object passed to the {@link #request} method.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "requestexception", + "desc" : "Fires if an error HTTP status was returned from the server.\nSee {@link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html} for details of HTTP status codes.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "conn", + "type" : "Connection", + "desc" : "This Connection object.", + "isOptional" : false + }, + { + "name" : "response", + "type" : "Object", + "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The options config object passed to the {@link #request} method.", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.data.DataProxy.json b/docs2/symbols/Roo.data.DataProxy.json new file mode 100644 index 0000000000..ca8769ece9 --- /dev/null +++ b/docs2/symbols/Roo.data.DataProxy.json @@ -0,0 +1,108 @@ +{ + "name" : "Roo.data.DataProxy", + "augments" : [ + ], + "desc" : "This class is an abstract base class for implementations which provide retrieval of\nunformatted data objects.
\n

\nDataProxy implementations are usually used in conjunction with an implementation of Roo.data.DataReader\n(of the appropriate type which knows how to parse the data object) to provide a block of\n{@link Roo.data.Records} to an {@link Roo.data.Store}.
\n

\nCustom implementations must implement the load method as described in\n{@link Roo.data.HttpProxy#load}.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + { + "name" : "load", + "desc" : "Fires before the load method's callback is called.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "DataProxy object.", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object", + "desc" : "The data object.", + "isOptional" : false + }, + { + "name" : "arg", + "type" : "Object", + "desc" : "The callback argument object passed to the load function.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeload", + "desc" : "Fires before a network request is made to retrieve a data object.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "DataProxy object.", + "isOptional" : false + }, + { + "name" : "params", + "type" : "Object", + "desc" : "The params parameter to the load function.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "loadexception", + "desc" : "Fires if an Exception occurs during data retrieval.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "DataProxy object.", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object", + "desc" : "The data object.", + "isOptional" : false + }, + { + "name" : "arg", + "type" : "Object", + "desc" : "The callback argument object passed to the load function.", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The Exception.", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.data.DataReader.json b/docs2/symbols/Roo.data.DataReader.json new file mode 100644 index 0000000000..d0a2534dc8 --- /dev/null +++ b/docs2/symbols/Roo.data.DataReader.json @@ -0,0 +1,42 @@ +{ + "name" : "Roo.data.DataReader", + "augments" : [ + ], + "desc" : "Base class for reading structured data from a data source. This class is intended to be\nextended (see {Roo.data.ArrayReader}, {Roo.data.JsonReader} and {Roo.data.XmlReader}) and should not be created directly.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "newRow", + "desc" : "Create an empty record", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.DataReader", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "(optional) - overlay some values", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "record created." + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.data.HttpProxy.json b/docs2/symbols/Roo.data.HttpProxy.json new file mode 100644 index 0000000000..dd29fad0d1 --- /dev/null +++ b/docs2/symbols/Roo.data.HttpProxy.json @@ -0,0 +1,232 @@ +{ + "name" : "Roo.data.HttpProxy", + "augments" : [ + "Roo.data.DataProxy" + ], + "desc" : "An implementation of {@link Roo.data.DataProxy} that reads a data object from an {@link Roo.data.Connection} object\nconfigured to reference a certain URL.

\n

\nNote that this class cannot be used to retrieve data from a domain other than the domain\nfrom which the running page was served.

\n

\nFor cross-domain access to remote data, use an {@link Roo.data.ScriptTagProxy}.

\n

\nBe aware that to enable the browser to parse an XML document, the server must set\nthe Content-Type header in the HTTP response to \"text/xml\".", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "method", + "type" : "String", + "desc" : "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)", + "memberOf" : "Roo.data.HttpProxy", + "values" : [ + ] + }, + { + "name" : "timeout", + "type" : "Number", + "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)", + "memberOf" : "Roo.data.HttpProxy", + "values" : [ + ] + }, + { + "name" : "autoAbort", + "type" : "Boolean", + "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)", + "memberOf" : "Roo.data.HttpProxy", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)", + "memberOf" : "Roo.data.HttpProxy", + "values" : [ + ] + }, + { + "name" : "extraParams", + "type" : "Object", + "desc" : "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)", + "memberOf" : "Roo.data.HttpProxy", + "values" : [ + ] + }, + { + "name" : "disableCaching", + "type" : "Boolean", + "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)", + "memberOf" : "Roo.data.HttpProxy", + "values" : [ + ] + }, + { + "name" : "defaultHeaders", + "type" : "Object", + "desc" : "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)", + "memberOf" : "Roo.data.HttpProxy", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getConnection", + "desc" : "Return the {@link Roo.data.Connection} object being used by this Proxy.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.HttpProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Connection", + "desc" : "The Connection object. This object may be used to subscribe to events on\na finer-grained basis than the DataProxy events." + } + ] + }, + { + "name" : "load", + "desc" : "Load data from the configured {@link Roo.data.Connection}, read the data object into\na block of Roo.data.Records using the passed {@link Roo.data.DataReader} implementation, and\nprocess that block using the passed callback.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.HttpProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "params", + "type" : "Object", + "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.", + "isOptional" : false + }, + { + "name" : "reader", + "type" : "Roo.data.DataReader", + "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "The function into which to pass the block of Roo.data.Records.\nThe function must be passed

    \n
  • The Record block object
  • \n
  • The \"arg\" argument from the load function
  • \n
  • A boolean success indicator
  • \n
", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "The scope in which to call the callback", + "isOptional" : false + }, + { + "name" : "arg", + "type" : "Object", + "desc" : "An optional argument which is passed to the callback as its second parameter.", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "load", + "desc" : "Fires before the load method's callback is called.", + "memberOf" : "Roo.data.DataProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "DataProxy object.", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object", + "desc" : "The data object.", + "isOptional" : false + }, + { + "name" : "arg", + "type" : "Object", + "desc" : "The callback argument object passed to the load function.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeload", + "desc" : "Fires before a network request is made to retrieve a data object.", + "memberOf" : "Roo.data.DataProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "DataProxy object.", + "isOptional" : false + }, + { + "name" : "params", + "type" : "Object", + "desc" : "The params parameter to the load function.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "loadexception", + "desc" : "Fires if an Exception occurs during data retrieval.", + "memberOf" : "Roo.data.DataProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "DataProxy object.", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object", + "desc" : "The data object.", + "isOptional" : false + }, + { + "name" : "arg", + "type" : "Object", + "desc" : "The callback argument object passed to the load function.", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The Exception.", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.data.JsonReader.json b/docs2/symbols/Roo.data.JsonReader.json new file mode 100644 index 0000000000..444b274da6 --- /dev/null +++ b/docs2/symbols/Roo.data.JsonReader.json @@ -0,0 +1,137 @@ +{ + "name" : "Roo.data.JsonReader", + "augments" : [ + "Roo.data.DataReader" + ], + "desc" : "Data reader class to create an Array of Roo.data.Record objects from a JSON response\nbased on mappings in a provided Roo.data.Record constructor.\n\nThe default behaviour of a store is to send ?_requestMeta=1, unless the class has recieved 'metaData' property\nin the reply previously. \n\n

\nExample code:\n

\nvar RecordDef = Roo.data.Record.create([\n    {name: 'name', mapping: 'name'},     // \"mapping\" property not needed if it's the same as \"name\"\n    {name: 'occupation'}                 // This field will use \"occupation\" as the mapping.\n]);\nvar myReader = new Roo.data.JsonReader({\n    totalProperty: \"results\",    // The property which contains the total dataset size (optional)\n    root: \"rows\",                // The property which contains an Array of row objects\n    id: \"id\"                     // The property within each row object that provides an ID for the record (optional)\n}, RecordDef);\n
\n

\nThis would consume a JSON file like this:\n

\n{ 'results': 2, 'rows': [\n    { 'id': 1, 'name': 'Bill', occupation: 'Gardener' },\n    { 'id': 2, 'name': 'Ben', occupation: 'Horticulturalist' } ]\n}\n
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "id", + "type" : "String", + "desc" : "Name of the property within a row object that contains a record identifier value.", + "memberOf" : "Roo.data.JsonReader", + "values" : [ + ] + }, + { + "name" : "fields", + "type" : "Array", + "desc" : "Array of field definition objects", + "memberOf" : "Roo.data.JsonReader", + "values" : [ + ] + }, + { + "name" : "root", + "type" : "String", + "desc" : "name of the property which contains the Array of row objects.", + "memberOf" : "Roo.data.JsonReader", + "values" : [ + ] + }, + { + "name" : "successProperty", + "type" : "String", + "desc" : "Name of the property from which to retrieve the success attribute used by forms.", + "memberOf" : "Roo.data.JsonReader", + "values" : [ + ] + }, + { + "name" : "totalProperty", + "type" : "String", + "desc" : "Name of the property from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.", + "memberOf" : "Roo.data.JsonReader", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "readRecords", + "desc" : "Create a data block containing Roo.data.Records from an XML document.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.JsonReader", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "An object which contains an Array of row objects in the property specified\nin the config as 'root, and optionally a property, specified in the config as 'totalProperty'\nwhich contains the total size of the dataset.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records." + } + ] + }, + { + "name" : "read", + "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.JsonReader", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "response", + "type" : "Object", + "desc" : "The XHR object which contains the JSON data in its responseText.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records." + } + ] + }, + { + "name" : "newRow", + "desc" : "Create an empty record", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.DataReader", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "(optional) - overlay some values", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "record created." + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.data.JsonStore.json b/docs2/symbols/Roo.data.JsonStore.json new file mode 100644 index 0000000000..8d283733e8 --- /dev/null +++ b/docs2/symbols/Roo.data.JsonStore.json @@ -0,0 +1,1407 @@ +{ + "name" : "Roo.data.JsonStore", + "augments" : [ + "Roo.data.Store", + "Roo.util.Observable" + ], + "desc" : "/**", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "fields", + "type" : "Array", + "desc" : "An array of field definition objects, or field name strings.", + "memberOf" : "Roo.data.JsonStore", + "values" : [ + ] + }, + { + "name" : "proxy", + "type" : "Roo.data.DataProxy", + "desc" : "The Proxy object which provides access to a data object.", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "multiSort", + "type" : "Boolean", + "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "pruneModifiedRecords", + "type" : "boolean", + "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "remoteSort", + "type" : "boolean", + "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "data", + "type" : "Array", + "desc" : "Inline data to be loaded when the store is initialized.", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "sortInfo", + "type" : "Object", + "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "baseParams", + "type" : "Object", + "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "reader", + "type" : "Roo.data.Reader", + "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their id property.", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "isLocal", + "type" : "boolean", + "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "reload", + "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeAll", + "desc" : "Remove all Records from the Store and fires the clear event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "query", + "desc" : "Query the records by a specified property.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "field", + "type" : "String", + "desc" : "A field on your records", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String/RegExp", + "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field", + "isOptional" : false + }, + { + "name" : "anyMatch", + "type" : "Boolean", + "desc" : "True to match any part not just the beginning", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "MixedCollection", + "desc" : "Returns an Roo.util.MixedCollection of the matched records" + } + ] + }, + { + "name" : "sum", + "desc" : "Sums the value of property for each record between start and end and returns the result.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "property", + "type" : "String", + "desc" : "A field on your records", + "isOptional" : false + }, + { + "name" : "start", + "type" : "Number", + "desc" : "The record index to start at (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "The last record index to include (defaults to length - 1)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The sum" + } + ] + }, + { + "name" : "getById", + "desc" : "Get the Record with the specified id.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of the Record to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "The Record with the passed id. Returns undefined if not found." + } + ] + }, + { + "name" : "commitChanges", + "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getCount", + "desc" : "Gets the number of cached records.\n

\nIf using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "indexOf", + "desc" : "Get the index within the cache of the passed Record.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The Roo.data.Record object to to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the passed Record. Returns -1 if not found." + } + ] + }, + { + "name" : "add", + "desc" : "Add Records to the Store and fires the add event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "An Array of Roo.data.Record objects to add to the cache.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "indexOfId", + "desc" : "Get the index within the cache of the Record with the passed id.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of the Record to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the Record. Returns -1 if not found." + } + ] + }, + { + "name" : "filter", + "desc" : "Filter the records by a specified property.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "field", + "type" : "String", + "desc" : "A field on your records", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String/RegExp", + "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field", + "isOptional" : false + }, + { + "name" : "anyMatch", + "type" : "Boolean", + "desc" : "True to match any part not just the beginning", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "sort", + "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fieldName", + "type" : "String", + "desc" : "The name of the field to sort by.", + "isOptional" : false + }, + { + "name" : "dir", + "type" : "String", + "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRange", + "desc" : "Returns a range of Records between specified indices.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "startIndex", + "type" : "Number", + "desc" : "(optional) The starting index (defaults to 0)", + "isOptional" : false + }, + { + "name" : "endIndex", + "type" : "Number", + "desc" : "(optional) The ending index (defaults to the last Record in the Store)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record[]", + "desc" : "An array of Records" + } + ] + }, + { + "name" : "queryBy", + "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to be called, it will receive 2 args (record, id)", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to this)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "MixedCollection", + "desc" : "Returns an Roo.util.MixedCollection of the matched records" + } + ] + }, + { + "name" : "clearFilter", + "desc" : "Revert to a view of the Record cache with no filtering applied.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "suppressEvent", + "type" : "Boolean", + "desc" : "If true the filter is cleared silently without notifying listeners", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "each", + "desc" : "Calls the specified function for each of the Records in the cache.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call. The Record is passed as the first parameter.\nReturning false aborts and exits the iteration.", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to call the function (defaults to the Record).", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rejectChanges", + "desc" : "Cancel outstanding changes on all changed records.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getAt", + "desc" : "Get the Record at the specified index.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the Record to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "The Record at the passed index. Returns undefined if not found." + } + ] + }, + { + "name" : "getTotalCount", + "desc" : "Gets the total number of records in the dataset as returned by the server.\n

\nIf using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "filterBy", + "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to be called, it will receive 2 args (record, id)", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to this)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collect", + "desc" : "Collects unique values for a particular dataIndex from this store.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "dataIndex", + "type" : "String", + "desc" : "The property to collect", + "isOptional" : false + }, + { + "name" : "allowNull", + "type" : "Boolean", + "desc" : "(optional) Pass true to allow null, undefined or empty string values", + "isOptional" : false + }, + { + "name" : "bypassFilter", + "type" : "Boolean", + "desc" : "(optional) Pass true to collect from all records, even ones which are filtered", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "An array of the unique values" + } + ] + }, + { + "name" : "getModifiedRecords", + "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record[]", + "desc" : "An array of Records containing outstanding modifications." + } + ] + }, + { + "name" : "remove", + "desc" : "Remove a Record from the Store and fires the remove event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "record", + "type" : "Ext.data.Record", + "desc" : "The Roo.data.Record object to remove from the cache.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "loadData", + "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.", + "isOptional" : false + }, + { + "name" : "append", + "type" : "Boolean", + "desc" : "(Optional) True to append the new Records rather than replace the existing cache.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "load", + "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n

\nIf using remote paging, then the first load call must specify the start\nand limit properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n

\nIt is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.\n

", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "An object containing properties which control loading options:

    \n
  • params {Object} An object containing properties to pass as HTTP parameters to a remote data source.
  • \n
  • callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:
      \n
    • r : Roo.data.Record[]
    • \n
    • options: Options object from the load call
    • \n
    • success: Boolean success indicator
  • \n
  • scope {Object} Scope with which to call the callback (defaults to the Store object)
  • \n
  • add {Boolean} indicator to append loaded records rather than replace the current cache.
  • \n
", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDefaultSort", + "desc" : "Sets the default sort column and order to be used by the next load operation.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fieldName", + "type" : "String", + "desc" : "The name of the field to sort by.", + "isOptional" : false + }, + { + "name" : "dir", + "type" : "String", + "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "insert", + "desc" : "Inserts Records to the Store at the given index and fires the add event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The start index at which to insert the passed Records.", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "An Array of Roo.data.Record objects to add to the cache.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSortState", + "desc" : "Returns the sort state of the Store as an object with two properties:\n
\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforeloadadd", + "desc" : "Fires after a new set of Records has been loaded.", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "The Records that were loaded", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The loading options that were specified (see {@link #load} for details)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "loadexception", + "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "", + "type" : "Proxy", + "desc" : "", + "isOptional" : false + }, + { + "name" : "return", + "type" : "Object", + "desc" : "from JsonData.reader() - success, totalRecords, records", + "isOptional" : false + }, + { + "name" : "load", + "type" : "Object", + "desc" : "options", + "isOptional" : false + }, + { + "name" : "jsonData", + "type" : "Object", + "desc" : "from your request (normally this contains the Exception)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "load", + "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "The Records that were loaded", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The loading options that were specified (see {@link #load} for details)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "add", + "desc" : "Fires when Records have been added to the Store", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "The array of Records added", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index at which the record(s) were added", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "metachange", + "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "meta", + "type" : "Object", + "desc" : "The JSON metadata", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clear", + "desc" : "Fires when the data cache has been cleared.", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Fires when a Record has been removed from the Store", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The Record that was removed", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index at which the record was removed", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "update", + "desc" : "Fires when a Record has been updated", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The Record that was updated", + "isOptional" : false + }, + { + "name" : "operation", + "type" : "String", + "desc" : "The update operation being performed. Value may be one of:\n
\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n
", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeload", + "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The loading options that were specified (see {@link #load} for details)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "datachanged", + "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.data.MemoryProxy.json b/docs2/symbols/Roo.data.MemoryProxy.json new file mode 100644 index 0000000000..0b626b5a98 --- /dev/null +++ b/docs2/symbols/Roo.data.MemoryProxy.json @@ -0,0 +1,61 @@ +{ + "name" : "Roo.data.MemoryProxy", + "augments" : [ + ], + "desc" : "An implementation of Roo.data.DataProxy that simply passes the data specified in its constructor\nto the Reader when its load method is called.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "load", + "desc" : "Load data from the requested source (in this case an in-memory\ndata object passed to the constructor), read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.MemoryProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "params", + "type" : "Object", + "desc" : "This parameter is not used by the MemoryProxy class.", + "isOptional" : false + }, + { + "name" : "reader", + "type" : "Roo.data.DataReader", + "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "The function into which to pass the block of Roo.data.records.\nThe function must be passed
    \n
  • The Record block object
  • \n
  • The \"arg\" argument from the load function
  • \n
  • A boolean success indicator
  • \n
", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "The scope in which to call the callback", + "isOptional" : false + }, + { + "name" : "arg", + "type" : "Object", + "desc" : "An optional argument which is passed to the callback as its second parameter.", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.data.Node.json b/docs2/symbols/Roo.data.Node.json new file mode 100644 index 0000000000..b13c659127 --- /dev/null +++ b/docs2/symbols/Roo.data.Node.json @@ -0,0 +1,1188 @@ +{ + "name" : "Roo.data.Node", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id for this node. If one is not specified, one is generated.", + "memberOf" : "Roo.data.Node", + "values" : [ + ] + }, + { + "name" : "leaf", + "type" : "Boolean", + "desc" : "true if this node is a leaf and does not have children", + "memberOf" : "Roo.data.Node", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "sort", + "desc" : "Sorts this nodes children using the supplied sort function", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeChild", + "desc" : "Removes a child node from this node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node to remove", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The removed node" + } + ] + }, + { + "name" : "isAncestor", + "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "contains", + "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "cascade", + "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to current node)", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) The args to call the function with (default to passing the current node)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getDepth", + "desc" : "Returns depth of this node (the root node has a depth of 0)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "getPath", + "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "attr", + "type" : "String", + "desc" : "(optional) The attr to use for the path (defaults to the node's id)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The path" + } + ] + }, + { + "name" : "indexOf", + "desc" : "Returns the index of a child node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the node or -1 if it was not found" + } + ] + }, + { + "name" : "isFirst", + "desc" : "Returns true if this node is the first child of its parent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "isLast", + "desc" : "Returns true if this node is the last child of its parent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "isLeaf", + "desc" : "Returns true if this node is a leaf", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "insertBefore", + "desc" : "Inserts the first node before the second node in this nodes childNodes collection.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node to insert", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The node to insert before (if null the node is appended)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The inserted node" + } + ] + }, + { + "name" : "item", + "desc" : "Returns the child node at the specified index.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "" + } + ] + }, + { + "name" : "getOwnerTree", + "desc" : "Returns the tree this node is in.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Tree", + "desc" : "" + } + ] + }, + { + "name" : "appendChild", + "desc" : "Insert node(s) as the last child node of this node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node/Array", + "desc" : "The node or Array of nodes to append", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The appended node if single append, or null if an array was passed" + } + ] + }, + { + "name" : "findChildBy", + "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The found child or null if none was found" + } + ] + }, + { + "name" : "replaceChild", + "desc" : "Replaces one child node in this node with another.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "newChild", + "type" : "Node", + "desc" : "The replacement node", + "isOptional" : false + }, + { + "name" : "oldChild", + "type" : "Node", + "desc" : "The node to replace", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The replaced node" + } + ] + }, + { + "name" : "bubble", + "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to current node)", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) The args to call the function with (default to passing the current node)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "eachChild", + "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to current node)", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) The args to call the function with (default to passing the current node)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "findChild", + "desc" : "Finds the first child that has the attribute with the specified value.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "attribute", + "type" : "String", + "desc" : "The attribute name", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to search for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The found child or null if none was found" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforeappend", + "desc" : "Fires before a new child is appended, return false to cancel the append.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be appended", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires when this node is moved to a new location in the tree", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The old parent of this node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent of this node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it was moved to", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "append", + "desc" : "Fires when a new child node is appended", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The newly appended node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the newly appended node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeremove", + "desc" : "Fires before a child is removed, return false to cancel the remove.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be removed", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Fires when a child node is removed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The removed node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeinsert", + "desc" : "Fires before a new child is inserted, return false to cancel the insert.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node is being inserted before", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "insert", + "desc" : "Fires when a new child node is inserted.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node was inserted before", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforemove", + "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The parent of this node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent this node is moving to", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it is being moved to", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.data.Record.json b/docs2/symbols/Roo.data.Record.json new file mode 100644 index 0000000000..f95e09d5f5 --- /dev/null +++ b/docs2/symbols/Roo.data.Record.json @@ -0,0 +1,151 @@ +{ + "name" : "Roo.data.Record", + "augments" : [ + ], + "desc" : "Instances of this class encapsulate both record definition information, and record\nvalue information for use in {@link Roo.data.Store} objects, or any code which needs\nto access Records cached in an {@link Roo.data.Store} object.
\n

\nConstructors for this class are generated by passing an Array of field definition objects to {@link #create}.\nInstances are usually only created by {@link Roo.data.Reader} implementations when processing unformatted data\nobjects.
\n

\nRecord objects generated by this constructor inherit all the methods of Roo.data.Record listed below.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "copy", + "desc" : "Creates a copy of this record.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Record", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "(optional) A new record id if you don't want to use this record's id", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Record", + "desc" : "" + } + ] + }, + { + "name" : "commit", + "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nCommits all changes made to the Record since either creation, or the last commit operation.\n

\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof commit operations.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Record", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "get", + "desc" : "Get the value of the named field.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Record", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The name of the field to get the value of.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The value of the field." + } + ] + }, + { + "name" : "set", + "desc" : "Set the named field to the specified value.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Record", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The name of the field to set.", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Object", + "desc" : "The value to set the field to.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "reject", + "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nRejects all changes made to the Record since either creation, or the last commit operation.\nModified fields are reverted to their original values.\n

\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof reject operations.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Record", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "create", + "desc" : "Generate a constructor for a specific record layout.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Record", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Array", + "desc" : "An Array of field definition objects which specify field names, and optionally,\ndata types, and a mapping for an {@link Roo.data.Reader} to extract the field's value from a data object.\nEach field definition object may contain the following properties:

    \n
  • name : String

    The name by which the field is referenced within the Record. This is referenced by,\nfor example the dataIndex property in column definition objects passed to {@link Roo.grid.ColumnModel}

  • \n
  • mapping : String

    (Optional) A path specification for use by the {@link Roo.data.Reader} implementation\nthat is creating the Record to access the data value from the data object. If an {@link Roo.data.JsonReader}\nis being used, then this is a string containing the javascript expression to reference the data relative to \nthe record item's root. If an {@link Roo.data.XmlReader} is being used, this is an {@link Roo.DomQuery} path\nto the data item relative to the record element. If the mapping expression is the same as the field name,\nthis may be omitted.

  • \n
  • type : String

    (Optional) The data type for conversion to displayable value. Possible values are\n

    • auto (Default, implies no conversion)
    • \n
    • string
    • \n
    • int
    • \n
    • float
    • \n
    • boolean
    • \n
    • date

  • \n
  • sortType : Mixed

    (Optional) A member of {@link Roo.data.SortTypes}.

  • \n
  • sortDir : String

    (Optional) Initial direction to sort. \"ASC\" or \"DESC\"

  • \n
  • convert : Function

    (Optional) A function which converts the value provided\nby the Reader into an object that will be stored in the Record. It is passed the\nfollowing parameters:

      \n
    • v : Mixed

      The data value as read by the Reader.

    • \n

  • \n
  • dateFormat : String

    (Optional) A format String for the Date.parseDate function.

  • \n
\n
usage:
\nvar TopicRecord = Roo.data.Record.create(\n    {name: 'title', mapping: 'topic_title'},\n    {name: 'author', mapping: 'username'},\n    {name: 'totalPosts', mapping: 'topic_replies', type: 'int'},\n    {name: 'lastPost', mapping: 'post_time', type: 'date'},\n    {name: 'lastPoster', mapping: 'user2'},\n    {name: 'excerpt', mapping: 'post_text'}\n);\n\nvar myNewRecord = new TopicRecord({\n    title: 'Do my job please',\n    author: 'noobie',\n    totalPosts: 1,\n    lastPost: new Date(),\n    lastPoster: 'Animal',\n    excerpt: 'No way dude!'\n});\nmyStore.add(myNewRecord);\n
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.data.ScriptTagProxy.json b/docs2/symbols/Roo.data.ScriptTagProxy.json new file mode 100644 index 0000000000..4478cee5dd --- /dev/null +++ b/docs2/symbols/Roo.data.ScriptTagProxy.json @@ -0,0 +1,109 @@ +{ + "name" : "Roo.data.ScriptTagProxy", + "augments" : [ + ], + "desc" : "An implementation of Roo.data.DataProxy that reads a data object from a URL which may be in a domain\nother than the originating domain of the running page.

\n

\nNote that if you are retrieving data from a page that is in a domain that is NOT the same as the originating domain\nof the running page, you must use this class, rather than DataProxy.

\n

\nThe content passed back from a server resource requested by a ScriptTagProxy is executable JavaScript\nsource code that is used as the source inside a <script> tag.

\n

\nIn order for the browser to process the returned data, the server must wrap the data object\nwith a call to a callback function, the name of which is passed as a parameter by the ScriptTagProxy.\nBelow is a Java example for a servlet which returns data for either a ScriptTagProxy, or an HttpProxy\ndepending on whether the callback name was passed:\n

\n

\nboolean scriptTag = false;\nString cb = request.getParameter(\"callback\");\nif (cb != null) {\n    scriptTag = true;\n    response.setContentType(\"text/javascript\");\n} else {\n    response.setContentType(\"application/x-json\");\n}\nWriter out = response.getWriter();\nif (scriptTag) {\n    out.write(cb + \"(\");\n}\nout.print(dataBlock.toJsonString());\nif (scriptTag) {\n    out.write(\");\");\n}\n
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "timeout", + "type" : "Number", + "desc" : "(Optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.", + "memberOf" : "Roo.data.ScriptTagProxy", + "values" : [ + ] + }, + { + "name" : "nocache", + "type" : "Boolean", + "desc" : "(Optional) Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.", + "memberOf" : "Roo.data.ScriptTagProxy", + "values" : [ + ] + }, + { + "name" : "callbackParam", + "type" : "String", + "desc" : "(Optional) The name of the parameter to pass to the server which tells\nthe server the name of the callback function set up by the load call to process the returned data object.\nDefaults to \"callback\".

The server-side processing must read this parameter value, and generate\njavascript output which calls this named function passing the data object as its only parameter.", + "memberOf" : "Roo.data.ScriptTagProxy", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "The URL from which to request the data object.", + "memberOf" : "Roo.data.ScriptTagProxy", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "abort", + "desc" : "Abort the current server request.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.ScriptTagProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "load", + "desc" : "Load data from the configured URL, read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.ScriptTagProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "params", + "type" : "Object", + "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.", + "isOptional" : false + }, + { + "name" : "reader", + "type" : "Roo.data.DataReader", + "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "The function into which to pass the block of Roo.data.Records.\nThe function must be passed

    \n
  • The Record block object
  • \n
  • The \"arg\" argument from the load function
  • \n
  • A boolean success indicator
  • \n
", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "The scope in which to call the callback", + "isOptional" : false + }, + { + "name" : "arg", + "type" : "Object", + "desc" : "An optional argument which is passed to the callback as its second parameter.", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.data.SimpleStore.json b/docs2/symbols/Roo.data.SimpleStore.json new file mode 100644 index 0000000000..da8046f4ed --- /dev/null +++ b/docs2/symbols/Roo.data.SimpleStore.json @@ -0,0 +1,1415 @@ +{ + "name" : "Roo.data.SimpleStore", + "augments" : [ + "Roo.data.Store", + "Roo.util.Observable" + ], + "desc" : "Small helper class to make creating Stores from Array data easier.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "id", + "type" : "Number", + "desc" : "The array index of the record id. Leave blank to auto generate ids.", + "memberOf" : "Roo.data.SimpleStore", + "values" : [ + ] + }, + { + "name" : "fields", + "type" : "Array", + "desc" : "An array of field definition objects, or field name strings.", + "memberOf" : "Roo.data.SimpleStore", + "values" : [ + ] + }, + { + "name" : "proxy", + "type" : "Roo.data.DataProxy", + "desc" : "The Proxy object which provides access to a data object.", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "multiSort", + "type" : "Boolean", + "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "pruneModifiedRecords", + "type" : "boolean", + "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "remoteSort", + "type" : "boolean", + "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "data", + "type" : "Array", + "desc" : "The multi-dimensional array of data", + "memberOf" : "Roo.data.SimpleStore", + "values" : [ + ] + }, + { + "name" : "sortInfo", + "type" : "Object", + "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "baseParams", + "type" : "Object", + "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "reader", + "type" : "Roo.data.Reader", + "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their id property.", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "isLocal", + "type" : "boolean", + "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "reload", + "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeAll", + "desc" : "Remove all Records from the Store and fires the clear event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "query", + "desc" : "Query the records by a specified property.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "field", + "type" : "String", + "desc" : "A field on your records", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String/RegExp", + "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field", + "isOptional" : false + }, + { + "name" : "anyMatch", + "type" : "Boolean", + "desc" : "True to match any part not just the beginning", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "MixedCollection", + "desc" : "Returns an Roo.util.MixedCollection of the matched records" + } + ] + }, + { + "name" : "sum", + "desc" : "Sums the value of property for each record between start and end and returns the result.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "property", + "type" : "String", + "desc" : "A field on your records", + "isOptional" : false + }, + { + "name" : "start", + "type" : "Number", + "desc" : "The record index to start at (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "The last record index to include (defaults to length - 1)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The sum" + } + ] + }, + { + "name" : "getById", + "desc" : "Get the Record with the specified id.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of the Record to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "The Record with the passed id. Returns undefined if not found." + } + ] + }, + { + "name" : "commitChanges", + "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getCount", + "desc" : "Gets the number of cached records.\n

\nIf using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "indexOf", + "desc" : "Get the index within the cache of the passed Record.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The Roo.data.Record object to to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the passed Record. Returns -1 if not found." + } + ] + }, + { + "name" : "add", + "desc" : "Add Records to the Store and fires the add event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "An Array of Roo.data.Record objects to add to the cache.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "indexOfId", + "desc" : "Get the index within the cache of the Record with the passed id.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of the Record to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the Record. Returns -1 if not found." + } + ] + }, + { + "name" : "filter", + "desc" : "Filter the records by a specified property.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "field", + "type" : "String", + "desc" : "A field on your records", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String/RegExp", + "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field", + "isOptional" : false + }, + { + "name" : "anyMatch", + "type" : "Boolean", + "desc" : "True to match any part not just the beginning", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "sort", + "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fieldName", + "type" : "String", + "desc" : "The name of the field to sort by.", + "isOptional" : false + }, + { + "name" : "dir", + "type" : "String", + "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRange", + "desc" : "Returns a range of Records between specified indices.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "startIndex", + "type" : "Number", + "desc" : "(optional) The starting index (defaults to 0)", + "isOptional" : false + }, + { + "name" : "endIndex", + "type" : "Number", + "desc" : "(optional) The ending index (defaults to the last Record in the Store)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record[]", + "desc" : "An array of Records" + } + ] + }, + { + "name" : "queryBy", + "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to be called, it will receive 2 args (record, id)", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to this)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "MixedCollection", + "desc" : "Returns an Roo.util.MixedCollection of the matched records" + } + ] + }, + { + "name" : "clearFilter", + "desc" : "Revert to a view of the Record cache with no filtering applied.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "suppressEvent", + "type" : "Boolean", + "desc" : "If true the filter is cleared silently without notifying listeners", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "each", + "desc" : "Calls the specified function for each of the Records in the cache.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call. The Record is passed as the first parameter.\nReturning false aborts and exits the iteration.", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to call the function (defaults to the Record).", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rejectChanges", + "desc" : "Cancel outstanding changes on all changed records.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getAt", + "desc" : "Get the Record at the specified index.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the Record to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "The Record at the passed index. Returns undefined if not found." + } + ] + }, + { + "name" : "getTotalCount", + "desc" : "Gets the total number of records in the dataset as returned by the server.\n

\nIf using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "filterBy", + "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to be called, it will receive 2 args (record, id)", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to this)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collect", + "desc" : "Collects unique values for a particular dataIndex from this store.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "dataIndex", + "type" : "String", + "desc" : "The property to collect", + "isOptional" : false + }, + { + "name" : "allowNull", + "type" : "Boolean", + "desc" : "(optional) Pass true to allow null, undefined or empty string values", + "isOptional" : false + }, + { + "name" : "bypassFilter", + "type" : "Boolean", + "desc" : "(optional) Pass true to collect from all records, even ones which are filtered", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "An array of the unique values" + } + ] + }, + { + "name" : "getModifiedRecords", + "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record[]", + "desc" : "An array of Records containing outstanding modifications." + } + ] + }, + { + "name" : "remove", + "desc" : "Remove a Record from the Store and fires the remove event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "record", + "type" : "Ext.data.Record", + "desc" : "The Roo.data.Record object to remove from the cache.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "loadData", + "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.", + "isOptional" : false + }, + { + "name" : "append", + "type" : "Boolean", + "desc" : "(Optional) True to append the new Records rather than replace the existing cache.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "load", + "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n

\nIf using remote paging, then the first load call must specify the start\nand limit properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n

\nIt is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.\n

", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "An object containing properties which control loading options:

    \n
  • params {Object} An object containing properties to pass as HTTP parameters to a remote data source.
  • \n
  • callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:
      \n
    • r : Roo.data.Record[]
    • \n
    • options: Options object from the load call
    • \n
    • success: Boolean success indicator
  • \n
  • scope {Object} Scope with which to call the callback (defaults to the Store object)
  • \n
  • add {Boolean} indicator to append loaded records rather than replace the current cache.
  • \n
", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDefaultSort", + "desc" : "Sets the default sort column and order to be used by the next load operation.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fieldName", + "type" : "String", + "desc" : "The name of the field to sort by.", + "isOptional" : false + }, + { + "name" : "dir", + "type" : "String", + "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "insert", + "desc" : "Inserts Records to the Store at the given index and fires the add event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The start index at which to insert the passed Records.", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "An Array of Roo.data.Record objects to add to the cache.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSortState", + "desc" : "Returns the sort state of the Store as an object with two properties:\n
\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforeloadadd", + "desc" : "Fires after a new set of Records has been loaded.", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "The Records that were loaded", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The loading options that were specified (see {@link #load} for details)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "loadexception", + "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "", + "type" : "Proxy", + "desc" : "", + "isOptional" : false + }, + { + "name" : "return", + "type" : "Object", + "desc" : "from JsonData.reader() - success, totalRecords, records", + "isOptional" : false + }, + { + "name" : "load", + "type" : "Object", + "desc" : "options", + "isOptional" : false + }, + { + "name" : "jsonData", + "type" : "Object", + "desc" : "from your request (normally this contains the Exception)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "load", + "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "The Records that were loaded", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The loading options that were specified (see {@link #load} for details)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "add", + "desc" : "Fires when Records have been added to the Store", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "The array of Records added", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index at which the record(s) were added", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "metachange", + "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "meta", + "type" : "Object", + "desc" : "The JSON metadata", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clear", + "desc" : "Fires when the data cache has been cleared.", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Fires when a Record has been removed from the Store", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The Record that was removed", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index at which the record was removed", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "update", + "desc" : "Fires when a Record has been updated", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The Record that was updated", + "isOptional" : false + }, + { + "name" : "operation", + "type" : "String", + "desc" : "The update operation being performed. Value may be one of:\n
\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n
", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeload", + "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The loading options that were specified (see {@link #load} for details)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "datachanged", + "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.", + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.data.SortTypes.json b/docs2/symbols/Roo.data.SortTypes.json new file mode 100644 index 0000000000..37a9ca38d4 --- /dev/null +++ b/docs2/symbols/Roo.data.SortTypes.json @@ -0,0 +1,204 @@ +{ + "name" : "Roo.data.SortTypes", + "augments" : [ + ], + "desc" : "Defines the default sorting (casting?) comparison functions used when sorting data.", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "asFloat", + "desc" : "Float sorting", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.SortTypes", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "s", + "type" : "Mixed", + "desc" : "The value being converted", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Float", + "desc" : "The comparison value" + } + ] + }, + { + "name" : "asUCString", + "desc" : "Case insensitive string", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.SortTypes", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "s", + "type" : "Mixed", + "desc" : "The value being converted", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The comparison value" + } + ] + }, + { + "name" : "asDate", + "desc" : "Date sorting", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.SortTypes", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "s", + "type" : "Mixed", + "desc" : "The value being converted", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The comparison value" + } + ] + }, + { + "name" : "asUCText", + "desc" : "Strips all HTML tags to sort on text only - Case insensitive", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.SortTypes", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "s", + "type" : "Mixed", + "desc" : "The value being converted", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The comparison value" + } + ] + }, + { + "name" : "asInt", + "desc" : "Integer sorting", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.SortTypes", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "s", + "type" : "Mixed", + "desc" : "The value being converted", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The comparison value" + } + ] + }, + { + "name" : "asText", + "desc" : "Strips all HTML tags to sort on text only", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.SortTypes", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "s", + "type" : "Mixed", + "desc" : "The value being converted", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The comparison value" + } + ] + }, + { + "name" : "none", + "desc" : "Default sort that does nothing", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.SortTypes", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "s", + "type" : "Mixed", + "desc" : "The value being converted", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "The comparison value" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.data.Store.json b/docs2/symbols/Roo.data.Store.json new file mode 100644 index 0000000000..1c0a6da5d0 --- /dev/null +++ b/docs2/symbols/Roo.data.Store.json @@ -0,0 +1,1398 @@ +{ + "name" : "Roo.data.Store", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "The Store class encapsulates a client side cache of {@link Roo.data.Record} objects which provide input data\nfor widgets such as the Roo.grid.Grid, or the Roo.form.ComboBox.
\n

\nA Store object uses an implementation of {@link Roo.data.DataProxy} to access a data object unless you call loadData() directly and pass in your data. The Store object\nhas no knowledge of the format of the data returned by the Proxy.
\n

\nA Store object uses its configured implementation of {@link Roo.data.DataReader} to create {@link Roo.data.Record}\ninstances from the data object. These records are cached and made available through accessor functions.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n

\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "proxy", + "type" : "Roo.data.DataProxy", + "desc" : "The Proxy object which provides access to a data object.", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "multiSort", + "type" : "Boolean", + "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "pruneModifiedRecords", + "type" : "boolean", + "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "remoteSort", + "type" : "boolean", + "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "data", + "type" : "Array", + "desc" : "Inline data to be loaded when the store is initialized.", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "sortInfo", + "type" : "Object", + "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "baseParams", + "type" : "Object", + "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "reader", + "type" : "Roo.data.Reader", + "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their id property.", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + }, + { + "name" : "isLocal", + "type" : "boolean", + "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.", + "memberOf" : "Roo.data.Store", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "reload", + "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeAll", + "desc" : "Remove all Records from the Store and fires the clear event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "query", + "desc" : "Query the records by a specified property.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "field", + "type" : "String", + "desc" : "A field on your records", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String/RegExp", + "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field", + "isOptional" : false + }, + { + "name" : "anyMatch", + "type" : "Boolean", + "desc" : "True to match any part not just the beginning", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "MixedCollection", + "desc" : "Returns an Roo.util.MixedCollection of the matched records" + } + ] + }, + { + "name" : "sum", + "desc" : "Sums the value of property for each record between start and end and returns the result.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "property", + "type" : "String", + "desc" : "A field on your records", + "isOptional" : false + }, + { + "name" : "start", + "type" : "Number", + "desc" : "The record index to start at (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "The last record index to include (defaults to length - 1)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The sum" + } + ] + }, + { + "name" : "getById", + "desc" : "Get the Record with the specified id.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of the Record to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "The Record with the passed id. Returns undefined if not found." + } + ] + }, + { + "name" : "commitChanges", + "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getCount", + "desc" : "Gets the number of cached records.\n

\nIf using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "indexOf", + "desc" : "Get the index within the cache of the passed Record.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The Roo.data.Record object to to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the passed Record. Returns -1 if not found." + } + ] + }, + { + "name" : "add", + "desc" : "Add Records to the Store and fires the add event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "An Array of Roo.data.Record objects to add to the cache.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "indexOfId", + "desc" : "Get the index within the cache of the Record with the passed id.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of the Record to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the Record. Returns -1 if not found." + } + ] + }, + { + "name" : "filter", + "desc" : "Filter the records by a specified property.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "field", + "type" : "String", + "desc" : "A field on your records", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String/RegExp", + "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field", + "isOptional" : false + }, + { + "name" : "anyMatch", + "type" : "Boolean", + "desc" : "True to match any part not just the beginning", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "sort", + "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fieldName", + "type" : "String", + "desc" : "The name of the field to sort by.", + "isOptional" : false + }, + { + "name" : "dir", + "type" : "String", + "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRange", + "desc" : "Returns a range of Records between specified indices.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "startIndex", + "type" : "Number", + "desc" : "(optional) The starting index (defaults to 0)", + "isOptional" : false + }, + { + "name" : "endIndex", + "type" : "Number", + "desc" : "(optional) The ending index (defaults to the last Record in the Store)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record[]", + "desc" : "An array of Records" + } + ] + }, + { + "name" : "queryBy", + "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to be called, it will receive 2 args (record, id)", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to this)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "MixedCollection", + "desc" : "Returns an Roo.util.MixedCollection of the matched records" + } + ] + }, + { + "name" : "clearFilter", + "desc" : "Revert to a view of the Record cache with no filtering applied.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "suppressEvent", + "type" : "Boolean", + "desc" : "If true the filter is cleared silently without notifying listeners", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "each", + "desc" : "Calls the specified function for each of the Records in the cache.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call. The Record is passed as the first parameter.\nReturning false aborts and exits the iteration.", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to call the function (defaults to the Record).", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rejectChanges", + "desc" : "Cancel outstanding changes on all changed records.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getAt", + "desc" : "Get the Record at the specified index.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the Record to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "The Record at the passed index. Returns undefined if not found." + } + ] + }, + { + "name" : "getTotalCount", + "desc" : "Gets the total number of records in the dataset as returned by the server.\n

\nIf using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "filterBy", + "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to be called, it will receive 2 args (record, id)", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to this)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collect", + "desc" : "Collects unique values for a particular dataIndex from this store.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "dataIndex", + "type" : "String", + "desc" : "The property to collect", + "isOptional" : false + }, + { + "name" : "allowNull", + "type" : "Boolean", + "desc" : "(optional) Pass true to allow null, undefined or empty string values", + "isOptional" : false + }, + { + "name" : "bypassFilter", + "type" : "Boolean", + "desc" : "(optional) Pass true to collect from all records, even ones which are filtered", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "An array of the unique values" + } + ] + }, + { + "name" : "getModifiedRecords", + "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record[]", + "desc" : "An array of Records containing outstanding modifications." + } + ] + }, + { + "name" : "remove", + "desc" : "Remove a Record from the Store and fires the remove event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "record", + "type" : "Ext.data.Record", + "desc" : "The Roo.data.Record object to remove from the cache.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "loadData", + "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.", + "isOptional" : false + }, + { + "name" : "append", + "type" : "Boolean", + "desc" : "(Optional) True to append the new Records rather than replace the existing cache.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "load", + "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n

\nIf using remote paging, then the first load call must specify the start\nand limit properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n

\nIt is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.\n

", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "An object containing properties which control loading options:

    \n
  • params {Object} An object containing properties to pass as HTTP parameters to a remote data source.
  • \n
  • callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:
      \n
    • r : Roo.data.Record[]
    • \n
    • options: Options object from the load call
    • \n
    • success: Boolean success indicator
  • \n
  • scope {Object} Scope with which to call the callback (defaults to the Store object)
  • \n
  • add {Boolean} indicator to append loaded records rather than replace the current cache.
  • \n
", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDefaultSort", + "desc" : "Sets the default sort column and order to be used by the next load operation.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fieldName", + "type" : "String", + "desc" : "The name of the field to sort by.", + "isOptional" : false + }, + { + "name" : "dir", + "type" : "String", + "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "insert", + "desc" : "Inserts Records to the Store at the given index and fires the add event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The start index at which to insert the passed Records.", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "An Array of Roo.data.Record objects to add to the cache.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSortState", + "desc" : "Returns the sort state of the Store as an object with two properties:\n
\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforeloadadd", + "desc" : "Fires after a new set of Records has been loaded.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "The Records that were loaded", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The loading options that were specified (see {@link #load} for details)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "loadexception", + "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "", + "type" : "Proxy", + "desc" : "", + "isOptional" : false + }, + { + "name" : "return", + "type" : "Object", + "desc" : "from JsonData.reader() - success, totalRecords, records", + "isOptional" : false + }, + { + "name" : "load", + "type" : "Object", + "desc" : "options", + "isOptional" : false + }, + { + "name" : "jsonData", + "type" : "Object", + "desc" : "from your request (normally this contains the Exception)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "load", + "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "The Records that were loaded", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The loading options that were specified (see {@link #load} for details)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "add", + "desc" : "Fires when Records have been added to the Store", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "The array of Records added", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index at which the record(s) were added", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "metachange", + "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "meta", + "type" : "Object", + "desc" : "The JSON metadata", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clear", + "desc" : "Fires when the data cache has been cleared.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Fires when a Record has been removed from the Store", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The Record that was removed", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index at which the record was removed", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "update", + "desc" : "Fires when a Record has been updated", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The Record that was updated", + "isOptional" : false + }, + { + "name" : "operation", + "type" : "String", + "desc" : "The update operation being performed. Value may be one of:\n
\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n
", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeload", + "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The loading options that were specified (see {@link #load} for details)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "datachanged", + "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.data.Tree.json b/docs2/symbols/Roo.data.Tree.json new file mode 100644 index 0000000000..95c63c2a55 --- /dev/null +++ b/docs2/symbols/Roo.data.Tree.json @@ -0,0 +1,691 @@ +{ + "name" : "Roo.data.Tree", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "Represents a tree data structure and bubbles all the events for its nodes. The nodes\nin the tree have most standard DOM functionality.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "setRootNode", + "desc" : "Sets the root node for this tree.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "" + } + ] + }, + { + "name" : "getRootNode", + "desc" : "Returns the root node for this tree.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "" + } + ] + }, + { + "name" : "getNodeById", + "desc" : "Gets a node in this tree by its id.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "append", + "desc" : "Fires when a new child node is appended to a node in this tree.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The newly appended node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the newly appended node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforemove", + "desc" : "Fires before a node is moved to a new location in the tree. Return false to cancel the move.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The node being moved", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The parent of the node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent the node is moving to", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it is being moved to", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "insert", + "desc" : "Fires when a new child node is inserted in a node in this tree.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node was inserted before", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeappend", + "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be appended", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires when a node is moved to a new location in the tree", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The node moved", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The old parent of this node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent of this node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it was moved to", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeremove", + "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be removed", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Fires when a child node is removed from a node in this tree.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node removed", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeinsert", + "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node is being inserted before", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.data.XmlReader.json b/docs2/symbols/Roo.data.XmlReader.json new file mode 100644 index 0000000000..c26d3d4163 --- /dev/null +++ b/docs2/symbols/Roo.data.XmlReader.json @@ -0,0 +1,129 @@ +{ + "name" : "Roo.data.XmlReader", + "augments" : [ + "Roo.data.DataReader" + ], + "desc" : "Data reader class to create an Array of {@link Roo.data.Record} objects from an XML document\nbased on mappings in a provided Roo.data.Record constructor.

\n

\nNote that in order for the browser to parse a returned XML document, the Content-Type\nheader in the HTTP response must be set to \"text/xml\".\n

\nExample code:\n

\nvar RecordDef = Roo.data.Record.create([\n   {name: 'name', mapping: 'name'},     // \"mapping\" property not needed if it's the same as \"name\"\n   {name: 'occupation'}                 // This field will use \"occupation\" as the mapping.\n]);\nvar myReader = new Roo.data.XmlReader({\n   totalRecords: \"results\", // The element which contains the total dataset size (optional)\n   record: \"row\",           // The repeated element which contains row information\n   id: \"id\"                 // The element within the row that provides an ID for the record (optional)\n}, RecordDef);\n
\n

\nThis would consume an XML file like this:\n

\n<?xml?>\n<dataset>\n <results>2</results>\n <row>\n   <id>1</id>\n   <name>Bill</name>\n   <occupation>Gardener</occupation>\n </row>\n <row>\n   <id>2</id>\n   <name>Ben</name>\n   <occupation>Horticulturalist</occupation>\n </row>\n</dataset>\n
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The DomQuery path relative from the record element to the element that contains\na record identifier value.", + "memberOf" : "Roo.data.XmlReader", + "values" : [ + ] + }, + { + "name" : "success", + "type" : "String", + "desc" : "The DomQuery path to the success attribute used by forms.", + "memberOf" : "Roo.data.XmlReader", + "values" : [ + ] + }, + { + "name" : "record", + "type" : "String", + "desc" : "The DomQuery path to the repeated element which contains record information.", + "memberOf" : "Roo.data.XmlReader", + "values" : [ + ] + }, + { + "name" : "totalRecords", + "type" : "String", + "desc" : "The DomQuery path from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.", + "memberOf" : "Roo.data.XmlReader", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "read", + "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.XmlReader", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "response", + "type" : "Object", + "desc" : "The XHR object which contains the parsed XML document. The response is expected\nto contain a method called 'responseXML' that returns an XML document object.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records." + } + ] + }, + { + "name" : "readRecords", + "desc" : "Create a data block containing Roo.data.Records from an XML document.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.XmlReader", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "doc", + "type" : "Object", + "desc" : "A parsed XML document.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records." + } + ] + }, + { + "name" : "newRow", + "desc" : "Create an empty record", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.DataReader", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "(optional) - overlay some values", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "record created." + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.data.json b/docs2/symbols/Roo.data.json new file mode 100644 index 0000000000..e1101122c4 --- /dev/null +++ b/docs2/symbols/Roo.data.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.data", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.dd.DD.json b/docs2/symbols/Roo.dd.DD.json new file mode 100644 index 0000000000..4e2df73ca9 --- /dev/null +++ b/docs2/symbols/Roo.dd.DD.json @@ -0,0 +1,1446 @@ +{ + "name" : "Roo.dd.DD", + "augments" : [ + "Roo.dd.DragDrop", + "Roo.util.Observable" + ], + "desc" : "A DragDrop implementation where the linked element follows the\nmouse cursor during a drag.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "alignElWithMouse", + "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "HTMLElement", + "desc" : "the element to move", + "isOptional" : false + }, + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the mousedown or drag event", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the mousedown or drag event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDelta", + "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iDeltaX", + "type" : "int", + "desc" : "the distance from the left", + "isOptional" : false + }, + { + "name" : "iDeltaY", + "type" : "int", + "desc" : "the distance from the top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autoOffset", + "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the click", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the click", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDragElPos", + "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the mousedown or drag event", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the mousedown or drag event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "cachePosition", + "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "", + "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "", + "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setHandleElId", + "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to\ninitiate the drag.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "init", + "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleType", + "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to unexclude", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "unreg", + "desc" : "Remove all drag and drop hooks for this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleType", + "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to exclude", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragDrop", + "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleId", + "desc" : "Unsets an invalid handle id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the id of the element to re-enable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onAvailable", + "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setOuterHandleElId", + "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onMouseUp", + "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getDragEl", + "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] + }, + { + "name" : "setYConstraint", + "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iUp", + "type" : "int", + "desc" : "the number of pixels the element can move up", + "isOptional" : false + }, + { + "name" : "iDown", + "type" : "int", + "desc" : "the number of pixels the element can move down", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearConstraints", + "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onInvalidDrop", + "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleId", + "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the element id of the element you wish to ignore", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleClass", + "desc" : "Unsets an invalid css class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the element(s) you wish to\nre-enable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragOut", + "desc" : "Abstract method called when we are no longer hovering over an element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDragElId", + "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "endDrag", + "desc" : "Fired when we are done dragging the object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns a reference to the linked element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] + }, + { + "name" : "onDrag", + "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragEnter", + "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "lock", + "desc" : "Lock this instance", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onMouseDown", + "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousedown event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "applyConfig", + "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "unlock", + "desc" : "Unlock this instace", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isTarget", + "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setInitPosition", + "desc" : "Stores the initial placement of the linked element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "diffX", + "type" : "int", + "desc" : "the X offset, default 0", + "isOptional" : false + }, + { + "name" : "diffY", + "type" : "int", + "desc" : "the Y offset, default 0", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "initTarget", + "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addToGroup", + "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "", + "desc" : "{string} the name of the group", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragOver", + "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toString", + "desc" : "toString method", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "string representation of the dd obj" + } + ] + }, + { + "name" : "setPadding", + "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iTop", + "type" : "int", + "desc" : "Top pad", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "Right pad", + "isOptional" : false + }, + { + "name" : "iBot", + "type" : "int", + "desc" : "Bot pad", + "isOptional" : false + }, + { + "name" : "iLeft", + "type" : "int", + "desc" : "Left pad", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeFromGroup", + "desc" : "Remove's this instance from the supplied interaction group", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "string", + "desc" : "The group to drop", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleClass", + "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the elements you wish to ignore", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "startDrag", + "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "X", + "type" : "int", + "desc" : "click location", + "isOptional" : false + }, + { + "name" : "Y", + "type" : "int", + "desc" : "click location", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "padding", + "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "resetConstraints", + "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "maintainOffset", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearTicks", + "desc" : "Clears any tick interval defined for this instance", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isLocked", + "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this obj or all drag/drop is locked, else\nfalse" + } + ] + }, + { + "name" : "setXConstraint", + "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iLeft", + "type" : "int", + "desc" : "the number of pixels the element can move to the left", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "the number of pixels the element can move to the\nright", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isValidHandleChild", + "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "the HTMLElement to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this is a valid tag type, false if not" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.dd.DDProxy.json b/docs2/symbols/Roo.dd.DDProxy.json new file mode 100644 index 0000000000..b9d708cd4a --- /dev/null +++ b/docs2/symbols/Roo.dd.DDProxy.json @@ -0,0 +1,1479 @@ +{ + "name" : "Roo.dd.DDProxy", + "augments" : [ + "Roo.dd.DD", + "Roo.dd.DragDrop", + "Roo.util.Observable" + ], + "desc" : "A DragDrop implementation that inserts an empty, bordered div into\nthe document that follows the cursor during drag operations. At the time of\nthe click, the frame div is resized to the dimensions of the linked html\nelement, and moved to the exact location of the linked element.\n\nReferences to the \"frame\" element refer to the single proxy element that\nwas created to be dragged in place of all DDProxy elements on the\npage.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "initFrame", + "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DDProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "createFrame", + "desc" : "Creates the proxy element if it does not yet exist", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DDProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "alignElWithMouse", + "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "HTMLElement", + "desc" : "the element to move", + "isOptional" : false + }, + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the mousedown or drag event", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the mousedown or drag event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDelta", + "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iDeltaX", + "type" : "int", + "desc" : "the distance from the left", + "isOptional" : false + }, + { + "name" : "iDeltaY", + "type" : "int", + "desc" : "the distance from the top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autoOffset", + "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the click", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the click", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDragElPos", + "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the mousedown or drag event", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the mousedown or drag event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "cachePosition", + "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "", + "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "", + "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setHandleElId", + "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to\ninitiate the drag.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "init", + "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleType", + "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to unexclude", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "unreg", + "desc" : "Remove all drag and drop hooks for this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleType", + "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to exclude", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragDrop", + "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleId", + "desc" : "Unsets an invalid handle id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the id of the element to re-enable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onAvailable", + "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setOuterHandleElId", + "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onMouseUp", + "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getDragEl", + "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] + }, + { + "name" : "setYConstraint", + "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iUp", + "type" : "int", + "desc" : "the number of pixels the element can move up", + "isOptional" : false + }, + { + "name" : "iDown", + "type" : "int", + "desc" : "the number of pixels the element can move down", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearConstraints", + "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onInvalidDrop", + "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleId", + "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the element id of the element you wish to ignore", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleClass", + "desc" : "Unsets an invalid css class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the element(s) you wish to\nre-enable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragOut", + "desc" : "Abstract method called when we are no longer hovering over an element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDragElId", + "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "endDrag", + "desc" : "Fired when we are done dragging the object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns a reference to the linked element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] + }, + { + "name" : "onDrag", + "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragEnter", + "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "lock", + "desc" : "Lock this instance", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onMouseDown", + "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousedown event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "applyConfig", + "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "unlock", + "desc" : "Unlock this instace", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isTarget", + "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setInitPosition", + "desc" : "Stores the initial placement of the linked element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "diffX", + "type" : "int", + "desc" : "the X offset, default 0", + "isOptional" : false + }, + { + "name" : "diffY", + "type" : "int", + "desc" : "the Y offset, default 0", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "initTarget", + "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addToGroup", + "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "", + "desc" : "{string} the name of the group", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragOver", + "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toString", + "desc" : "toString method", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "string representation of the dd obj" + } + ] + }, + { + "name" : "setPadding", + "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iTop", + "type" : "int", + "desc" : "Top pad", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "Right pad", + "isOptional" : false + }, + { + "name" : "iBot", + "type" : "int", + "desc" : "Bot pad", + "isOptional" : false + }, + { + "name" : "iLeft", + "type" : "int", + "desc" : "Left pad", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeFromGroup", + "desc" : "Remove's this instance from the supplied interaction group", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "string", + "desc" : "The group to drop", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleClass", + "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the elements you wish to ignore", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "startDrag", + "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "X", + "type" : "int", + "desc" : "click location", + "isOptional" : false + }, + { + "name" : "Y", + "type" : "int", + "desc" : "click location", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "padding", + "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "resetConstraints", + "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "maintainOffset", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearTicks", + "desc" : "Clears any tick interval defined for this instance", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isLocked", + "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this obj or all drag/drop is locked, else\nfalse" + } + ] + }, + { + "name" : "setXConstraint", + "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iLeft", + "type" : "int", + "desc" : "the number of pixels the element can move to the left", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "the number of pixels the element can move to the\nright", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isValidHandleChild", + "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "the HTMLElement to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this is a valid tag type, false if not" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.dd.DDTarget.json b/docs2/symbols/Roo.dd.DDTarget.json new file mode 100644 index 0000000000..91b092ce95 --- /dev/null +++ b/docs2/symbols/Roo.dd.DDTarget.json @@ -0,0 +1,1300 @@ +{ + "name" : "Roo.dd.DDTarget", + "augments" : [ + "Roo.dd.DragDrop", + "Roo.util.Observable" + ], + "desc" : "A DragDrop implementation that does not move, but can be a drop\ntarget. You would get the same result by simply omitting implementation\nfor the event callbacks, but this way we reduce the processing cost of the\nevent listener and the callbacks.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "setHandleElId", + "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to\ninitiate the drag.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "init", + "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleType", + "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to unexclude", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "unreg", + "desc" : "Remove all drag and drop hooks for this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleType", + "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to exclude", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragDrop", + "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleId", + "desc" : "Unsets an invalid handle id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the id of the element to re-enable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onAvailable", + "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setOuterHandleElId", + "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onMouseUp", + "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getDragEl", + "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] + }, + { + "name" : "setYConstraint", + "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iUp", + "type" : "int", + "desc" : "the number of pixels the element can move up", + "isOptional" : false + }, + { + "name" : "iDown", + "type" : "int", + "desc" : "the number of pixels the element can move down", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearConstraints", + "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onInvalidDrop", + "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleId", + "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the element id of the element you wish to ignore", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleClass", + "desc" : "Unsets an invalid css class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the element(s) you wish to\nre-enable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragOut", + "desc" : "Abstract method called when we are no longer hovering over an element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDragElId", + "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "endDrag", + "desc" : "Fired when we are done dragging the object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns a reference to the linked element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] + }, + { + "name" : "onDrag", + "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragEnter", + "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "lock", + "desc" : "Lock this instance", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onMouseDown", + "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousedown event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "applyConfig", + "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "unlock", + "desc" : "Unlock this instace", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isTarget", + "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setInitPosition", + "desc" : "Stores the initial placement of the linked element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "diffX", + "type" : "int", + "desc" : "the X offset, default 0", + "isOptional" : false + }, + { + "name" : "diffY", + "type" : "int", + "desc" : "the Y offset, default 0", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "initTarget", + "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addToGroup", + "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "", + "desc" : "{string} the name of the group", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragOver", + "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toString", + "desc" : "toString method", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "string representation of the dd obj" + } + ] + }, + { + "name" : "setPadding", + "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iTop", + "type" : "int", + "desc" : "Top pad", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "Right pad", + "isOptional" : false + }, + { + "name" : "iBot", + "type" : "int", + "desc" : "Bot pad", + "isOptional" : false + }, + { + "name" : "iLeft", + "type" : "int", + "desc" : "Left pad", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeFromGroup", + "desc" : "Remove's this instance from the supplied interaction group", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "string", + "desc" : "The group to drop", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleClass", + "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the elements you wish to ignore", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "startDrag", + "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "X", + "type" : "int", + "desc" : "click location", + "isOptional" : false + }, + { + "name" : "Y", + "type" : "int", + "desc" : "click location", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "padding", + "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "resetConstraints", + "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "maintainOffset", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearTicks", + "desc" : "Clears any tick interval defined for this instance", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isLocked", + "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this obj or all drag/drop is locked, else\nfalse" + } + ] + }, + { + "name" : "setXConstraint", + "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iLeft", + "type" : "int", + "desc" : "the number of pixels the element can move to the left", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "the number of pixels the element can move to the\nright", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isValidHandleChild", + "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "the HTMLElement to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this is a valid tag type, false if not" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.dd.DragDrop.json b/docs2/symbols/Roo.dd.DragDrop.json new file mode 100644 index 0000000000..b04f11b0a5 --- /dev/null +++ b/docs2/symbols/Roo.dd.DragDrop.json @@ -0,0 +1,1299 @@ +{ + "name" : "Roo.dd.DragDrop", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "Defines the interface and base operation of items that that can be\ndragged or can be drop targets. It was designed to be extended, overriding\nthe event handlers for startDrag, onDrag, onDragOver and onDragOut.\nUp to three html elements can be associated with a DragDrop instance:\n
    \n
  • linked element: the element that is passed into the constructor.\nThis is the element which defines the boundaries for interaction with\nother DragDrop objects.
  • \n
  • handle element(s): The drag operation only occurs if the element that\nwas clicked matches a handle element. By default this is the linked\nelement, but there are times that you will want only a portion of the\nlinked element to initiate the drag operation, and the setHandleElId()\nmethod provides a way to define this.
  • \n
  • drag element: this represents the element that would be moved along\nwith the cursor during a drag operation. By default, this is the linked\nelement itself as in {@link Roo.dd.DD}. setDragElId() lets you define\na separate element that would be moved, as in {@link Roo.dd.DDProxy}.\n
  • \n
\nThis class should not be instantiated until the onload event to ensure that\nthe associated elements are available.\nThe following would define a DragDrop obj that would interact with any\nother DragDrop obj in the \"group1\" group:\n
\n dd = new Roo.dd.DragDrop(\"div1\", \"group1\");\n
\nSince none of the event handlers have been implemented, nothing would\nactually happen if you were to run the code above. Normally you would\noverride this class or one of the default implementations, but you can\nalso override the methods you want on an instance of the class...\n
\n dd.onDragDrop = function(e, id) {\n   alert(\"dd was dropped on \" + id);\n }\n
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "setHandleElId", + "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to\ninitiate the drag.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "init", + "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleType", + "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to unexclude", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "unreg", + "desc" : "Remove all drag and drop hooks for this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleType", + "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to exclude", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragDrop", + "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleId", + "desc" : "Unsets an invalid handle id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the id of the element to re-enable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onAvailable", + "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setOuterHandleElId", + "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onMouseUp", + "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getDragEl", + "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] + }, + { + "name" : "setYConstraint", + "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iUp", + "type" : "int", + "desc" : "the number of pixels the element can move up", + "isOptional" : false + }, + { + "name" : "iDown", + "type" : "int", + "desc" : "the number of pixels the element can move down", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearConstraints", + "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onInvalidDrop", + "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleId", + "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the element id of the element you wish to ignore", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleClass", + "desc" : "Unsets an invalid css class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the element(s) you wish to\nre-enable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragOut", + "desc" : "Abstract method called when we are no longer hovering over an element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDragElId", + "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "endDrag", + "desc" : "Fired when we are done dragging the object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns a reference to the linked element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] + }, + { + "name" : "onDrag", + "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragEnter", + "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "lock", + "desc" : "Lock this instance", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onMouseDown", + "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousedown event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "applyConfig", + "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "unlock", + "desc" : "Unlock this instace", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isTarget", + "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setInitPosition", + "desc" : "Stores the initial placement of the linked element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "diffX", + "type" : "int", + "desc" : "the X offset, default 0", + "isOptional" : false + }, + { + "name" : "diffY", + "type" : "int", + "desc" : "the Y offset, default 0", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "initTarget", + "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addToGroup", + "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "", + "desc" : "{string} the name of the group", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragOver", + "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toString", + "desc" : "toString method", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "string representation of the dd obj" + } + ] + }, + { + "name" : "setPadding", + "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iTop", + "type" : "int", + "desc" : "Top pad", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "Right pad", + "isOptional" : false + }, + { + "name" : "iBot", + "type" : "int", + "desc" : "Bot pad", + "isOptional" : false + }, + { + "name" : "iLeft", + "type" : "int", + "desc" : "Left pad", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeFromGroup", + "desc" : "Remove's this instance from the supplied interaction group", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "string", + "desc" : "The group to drop", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleClass", + "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the elements you wish to ignore", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "startDrag", + "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "X", + "type" : "int", + "desc" : "click location", + "isOptional" : false + }, + { + "name" : "Y", + "type" : "int", + "desc" : "click location", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "padding", + "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "resetConstraints", + "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "maintainOffset", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearTicks", + "desc" : "Clears any tick interval defined for this instance", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isLocked", + "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this obj or all drag/drop is locked, else\nfalse" + } + ] + }, + { + "name" : "setXConstraint", + "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iLeft", + "type" : "int", + "desc" : "the number of pixels the element can move to the left", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "the number of pixels the element can move to the\nright", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isValidHandleChild", + "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "the HTMLElement to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this is a valid tag type, false if not" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.dd.DragDropMgr.json b/docs2/symbols/Roo.dd.DragDropMgr.json new file mode 100644 index 0000000000..237a9fcfc1 --- /dev/null +++ b/docs2/symbols/Roo.dd.DragDropMgr.json @@ -0,0 +1,728 @@ +{ + "name" : "Roo.dd.DragDropMgr", + "augments" : [ + ], + "desc" : "DragDropMgr is a singleton that tracks the element interaction for\nall DragDrop items in the window. Generally, you will not call\nthis class directly, but it does have helper methods that could\nbe useful in your DragDrop implementations.", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "isDragDrop", + "desc" : "Utility function to determine if a given element has been\nregistered as a drag drop item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "the element id to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this element is a DragDrop item,\nfalse otherwise" + } + ] + }, + { + "name" : "getRelated", + "desc" : "Returns the drag and drop instances that are in all groups the\npassed in instance belongs to.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "p_oDD", + "type" : "DragDrop", + "desc" : "the obj to get related data for", + "isOptional" : false + }, + { + "name" : "bTargetsOnly", + "type" : "boolean", + "desc" : "if true, only return targetable objs", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "DragDrop[]", + "desc" : "the related instances" + } + ] + }, + { + "name" : "getScrollLeft", + "desc" : "Gets the scrollLeft", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "int", + "desc" : "the document's scrollTop" + } + ] + }, + { + "name" : "regDragDrop", + "desc" : "Each DragDrop instance must be registered with the DragDropMgr.\nThis is executed in DragDrop.init()", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "oDD", + "type" : "DragDrop", + "desc" : "the DragDrop object to register", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the name of the group this element belongs to", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "handleWasClicked", + "desc" : "Recursively searches the immediate parent and all child nodes for\nthe handle element in order to determine wheter or not it was\nclicked.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "", + "desc" : "the html element to inspect", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "refreshCache", + "desc" : "Refreshes the cache of the top-left and bottom-right points of the\ndrag and drop objects in the specified group(s). This is in the\nformat that is stored in the drag and drop instance, so typical\nusage is:\n\nRoo.dd.DragDropMgr.refreshCache(ddinstance.groups);\n\nAlternatively:\n\nRoo.dd.DragDropMgr.refreshCache({group1:true, group2:true});\n", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "groups", + "type" : "Object", + "desc" : "an associative array of groups to refresh", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getCss", + "desc" : "Returns the style property for the DOM element (i.e.,\ndocument.getElById(id).style)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "This has been deprecated: use Roo.getDom instead", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "the id of the elment to get", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The style property of the element" + } + ] + }, + { + "name" : "swapNode", + "desc" : "Swap two nodes. In IE, we use the native method, for others we\nemulate the IE behavior", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "n1", + "type" : "", + "desc" : "the first node to swap", + "isOptional" : false + }, + { + "name" : "n2", + "type" : "", + "desc" : "the other node to swap", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "stopEvent", + "desc" : "Utility to stop event propagation and event default, if these\nfeatures are turned on.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the event as returned by this.getEvent()", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "lock", + "desc" : "Lock all drag and drop functionality", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "moveToEl", + "desc" : "Sets the x/y position of an element to the location of the\ntarget element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "moveEl", + "type" : "HTMLElement", + "desc" : "The element to move", + "isOptional" : false + }, + { + "name" : "targetEl", + "type" : "HTMLElement", + "desc" : "The position reference element", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "unlock", + "desc" : "Unlock all drag and drop functionality", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getDDById", + "desc" : "Returns the DragDrop instance for a given id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "the id of the DragDrop object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "DragDrop", + "desc" : "the drag drop object, null if it is not found" + } + ] + }, + { + "name" : "isLegalTarget", + "desc" : "Returns true if the specified dd target is a legal target for\nthe specifice drag obj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "DragDrop", + "desc" : "drag obj", + "isOptional" : false + }, + { + "name" : "the", + "type" : "DragDrop", + "desc" : "target", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if the target is a legal target for the\ndd obj" + } + ] + }, + { + "name" : "isTypeOfDD", + "desc" : "My goal is to be able to transparently determine if an object is\ntypeof DragDrop, and the exact subclass of DragDrop. typeof\nreturns \"object\", oDD.constructor.toString() always returns\n\"DragDrop\" and not the name of the subclass. So for now it just\nevaluates a well-known variable in DragDrop.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "the", + "type" : "Object", + "desc" : "object to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if typeof oDD = DragDrop" + } + ] + }, + { + "name" : "startDrag", + "desc" : "Fired when either the drag pixel threshol or the mousedown hold\ntime threshold has been met.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "", + "desc" : "{int} the X position of the original mousedown", + "isOptional" : false + }, + { + "name" : "y", + "type" : "", + "desc" : "{int} the Y position of the original mousedown", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getStyle", + "desc" : "Returns the specified element style property", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "This has been deprecated: use Roo.lib.Dom.getStyle", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "HTMLElement", + "desc" : "the element", + "isOptional" : false + }, + { + "name" : "styleProp", + "type" : "string", + "desc" : "the style property", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "The value of the style property" + } + ] + }, + { + "name" : "getPosX", + "desc" : "Returns the X position of an html element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "This has been deprecated: use Roo.lib.Dom.getX instead", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "", + "desc" : "the element for which to get the position", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "int", + "desc" : "the X coordinate" + } + ] + }, + { + "name" : "getPosY", + "desc" : "Returns the Y position of an html element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "This has been deprecated: use Roo.lib.Dom.getY instead", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "", + "desc" : "the element for which to get the position", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "int", + "desc" : "the Y coordinate" + } + ] + }, + { + "name" : "isLocked", + "desc" : "Is drag and drop locked?", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "True if drag and drop is locked, false otherwise." + } + ] + }, + { + "name" : "getBestMatch", + "desc" : "Helper function for getting the best match from the list of drag\nand drop objects returned by the drag and drop events when we are\nin INTERSECT mode. It returns either the first object that the\ncursor is over, or the object that has the greatest overlap with\nthe dragged element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "dds", + "type" : "DragDrop[]", + "desc" : "The array of drag and drop objects\ntargeted", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "DragDrop", + "desc" : "The best single match" + } + ] + }, + { + "name" : "getLocation", + "desc" : "Returns a Region object containing the drag and drop element's position\nand size, including the padding configured for it", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "oDD", + "type" : "DragDrop", + "desc" : "the drag and drop object to get the\n location for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.lib.Region", + "desc" : "a Region object representing the total area\n the element occupies, including any padding\n the instance is configured for." + } + ] + }, + { + "name" : "isHandle", + "desc" : "Utility function to determine if a given element has been\nregistered as a drag drop handle for the given Drag Drop object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "the element id to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this element is a DragDrop handle, false\notherwise" + } + ] + }, + { + "name" : "getScrollTop", + "desc" : "Gets the scrollTop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "int", + "desc" : "the document's scrollTop" + } + ] + }, + { + "name" : "numericSort", + "desc" : "Numeric array sort function", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "regHandle", + "desc" : "Each DragDrop handle element must be registered. This is done\nautomatically when executing DragDrop.setHandleElId()", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sDDId", + "type" : "String", + "desc" : "the DragDrop id this element is a handle for", + "isOptional" : false + }, + { + "name" : "sHandleId", + "type" : "String", + "desc" : "the id of the element that is the drag\nhandle", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getElement", + "desc" : "Returns the actual DOM element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "This has been deprecated: use Roo.getDom instead", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "the id of the elment to get", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The element" + } + ] + }, + { + "name" : "verifyEl", + "desc" : "This checks to make sure an element exists and is in the DOM. The\nmain purpose is to handle cases where innerHTML is used to remove\ndrag and drop objects from the DOM. IE provides an 'unspecified\nerror' when trying to access the offsetParent of such an element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDropMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "HTMLElement", + "desc" : "the element to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if the element looks usable" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.dd.DragSource.json b/docs2/symbols/Roo.dd.DragSource.json new file mode 100644 index 0000000000..0b78cab053 --- /dev/null +++ b/docs2/symbols/Roo.dd.DragSource.json @@ -0,0 +1,1810 @@ +{ + "name" : "Roo.dd.DragSource", + "augments" : [ + "Roo.dd.DDProxy", + "Roo.dd.DD", + "Roo.dd.DragDrop", + "Roo.util.Observable" + ], + "desc" : "A simple class that provides the basic implementation needed to make any element draggable.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "dropNotAllowed", + "type" : "String", + "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").", + "memberOf" : "Roo.dd.DragSource", + "values" : [ + ] + }, + { + "name" : "dropAllowed", + "type" : "String", + "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").", + "memberOf" : "Roo.dd.DragSource", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "beforeDragEnter", + "desc" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag event is valid, else false to cancel" + } + ] + }, + { + "name" : "getDragData", + "desc" : "Returns the data object associated with this drag source", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "data An object containing arbitrary data" + } + ] + }, + { + "name" : "hideProxy", + "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "beforeDragOut", + "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag event is valid, else false to cancel" + } + ] + }, + { + "name" : "beforeInvalidDrop", + "desc" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the invalid drop should proceed, else false to cancel" + } + ] + }, + { + "name" : "beforeDragDrop", + "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag drop event is valid, else false to cancel" + } + ] + }, + { + "name" : "getProxy", + "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.dd.StatusProxy", + "desc" : "proxy The StatusProxy" + } + ] + }, + { + "name" : "onBeforeDrag", + "desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data to be shared with drop targets", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag event is valid, else false to cancel" + } + ] + }, + { + "name" : "onStartDrag", + "desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun. The drag cannot be canceled from this function.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The x position of the click on the dragged object", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The y position of the click on the dragged object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeDragOver", + "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag event is valid, else false to cancel" + } + ] + }, + { + "name" : "initFrame", + "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DDProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "createFrame", + "desc" : "Creates the proxy element if it does not yet exist", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DDProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "alignElWithMouse", + "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "HTMLElement", + "desc" : "the element to move", + "isOptional" : false + }, + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the mousedown or drag event", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the mousedown or drag event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDelta", + "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iDeltaX", + "type" : "int", + "desc" : "the distance from the left", + "isOptional" : false + }, + { + "name" : "iDeltaY", + "type" : "int", + "desc" : "the distance from the top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autoOffset", + "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the click", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the click", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDragElPos", + "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the mousedown or drag event", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the mousedown or drag event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "cachePosition", + "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "", + "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "", + "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setHandleElId", + "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to\ninitiate the drag.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "init", + "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleType", + "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to unexclude", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "unreg", + "desc" : "Remove all drag and drop hooks for this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleType", + "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to exclude", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragDrop", + "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleId", + "desc" : "Unsets an invalid handle id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the id of the element to re-enable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onAvailable", + "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setOuterHandleElId", + "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onMouseUp", + "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getDragEl", + "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] + }, + { + "name" : "setYConstraint", + "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iUp", + "type" : "int", + "desc" : "the number of pixels the element can move up", + "isOptional" : false + }, + { + "name" : "iDown", + "type" : "int", + "desc" : "the number of pixels the element can move down", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearConstraints", + "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onInvalidDrop", + "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleId", + "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the element id of the element you wish to ignore", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleClass", + "desc" : "Unsets an invalid css class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the element(s) you wish to\nre-enable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragOut", + "desc" : "Abstract method called when we are no longer hovering over an element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDragElId", + "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "endDrag", + "desc" : "Fired when we are done dragging the object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns a reference to the linked element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] + }, + { + "name" : "onDrag", + "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragEnter", + "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "lock", + "desc" : "Lock this instance", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onMouseDown", + "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousedown event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "applyConfig", + "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "unlock", + "desc" : "Unlock this instace", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isTarget", + "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setInitPosition", + "desc" : "Stores the initial placement of the linked element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "diffX", + "type" : "int", + "desc" : "the X offset, default 0", + "isOptional" : false + }, + { + "name" : "diffY", + "type" : "int", + "desc" : "the Y offset, default 0", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "initTarget", + "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addToGroup", + "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "", + "desc" : "{string} the name of the group", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragOver", + "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toString", + "desc" : "toString method", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "string representation of the dd obj" + } + ] + }, + { + "name" : "setPadding", + "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iTop", + "type" : "int", + "desc" : "Top pad", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "Right pad", + "isOptional" : false + }, + { + "name" : "iBot", + "type" : "int", + "desc" : "Bot pad", + "isOptional" : false + }, + { + "name" : "iLeft", + "type" : "int", + "desc" : "Left pad", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeFromGroup", + "desc" : "Remove's this instance from the supplied interaction group", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "string", + "desc" : "The group to drop", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleClass", + "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the elements you wish to ignore", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "startDrag", + "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "X", + "type" : "int", + "desc" : "click location", + "isOptional" : false + }, + { + "name" : "Y", + "type" : "int", + "desc" : "click location", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "padding", + "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "resetConstraints", + "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "maintainOffset", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearTicks", + "desc" : "Clears any tick interval defined for this instance", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isLocked", + "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this obj or all drag/drop is locked, else\nfalse" + } + ] + }, + { + "name" : "setXConstraint", + "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iLeft", + "type" : "int", + "desc" : "the number of pixels the element can move to the left", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "the number of pixels the element can move to the\nright", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isValidHandleChild", + "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "the HTMLElement to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this is a valid tag type, false if not" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.dd.DragZone.json b/docs2/symbols/Roo.dd.DragZone.json new file mode 100644 index 0000000000..40103dedc0 --- /dev/null +++ b/docs2/symbols/Roo.dd.DragZone.json @@ -0,0 +1,1909 @@ +{ + "name" : "Roo.dd.DragZone", + "augments" : [ + "Roo.dd.DragSource", + "Roo.dd.DDProxy", + "Roo.dd.DD", + "Roo.dd.DragDrop", + "Roo.util.Observable" + ], + "desc" : "This class provides a container DD instance that proxies for multiple child node sources.
\nBy default, this class requires that draggable child nodes are registered with {@link Roo.dd.Registry}.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "dropNotAllowed", + "type" : "String", + "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").", + "memberOf" : "Roo.dd.DragSource", + "values" : [ + ] + }, + { + "name" : "hlColor", + "type" : "String", + "desc" : "The color to use when visually highlighting the drag source in the afterRepair\nmethod after a failed drop (defaults to \"c3daf9\" - light blue)", + "memberOf" : "Roo.dd.DragZone", + "values" : [ + ] + }, + { + "name" : "dropAllowed", + "type" : "String", + "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").", + "memberOf" : "Roo.dd.DragSource", + "values" : [ + ] + }, + { + "name" : "containerScroll", + "type" : "Boolean", + "desc" : "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.", + "memberOf" : "Roo.dd.DragZone", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getRepairXY", + "desc" : "Called before a repair of an invalid drop to get the XY to animate to. By default returns\nthe XY of this.dragData.ddel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragZone", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "The mouse up event", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The xy location (e.g. [100, 200])" + } + ] + }, + { + "name" : "afterRepair", + "desc" : "Called after a repair of an invalid drop. By default, highlights this.dragData.ddel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragZone", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getDragData", + "desc" : "Called when a mousedown occurs in this container. Looks in {@link Roo.dd.Registry}\nfor a valid target to drag based on the mouse down. Override this method\nto provide your own lookup logic (e.g. finding a child by class name). Make sure your returned\nobject has a \"ddel\" attribute (with an HTML Element) for other functions to work.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragZone", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "The mouse down event", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The dragData" + } + ] + }, + { + "name" : "onInitDrag", + "desc" : "Called once drag threshold has been reached to initialize the proxy element. By default, it clones the\nthis.dragData.ddel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragZone", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The x position of the click on the dragged object", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The y position of the click on the dragged object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "true to continue the drag, false to cancel" + } + ] + }, + { + "name" : "beforeDragEnter", + "desc" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag event is valid, else false to cancel" + } + ] + }, + { + "name" : "hideProxy", + "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "beforeDragOut", + "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag event is valid, else false to cancel" + } + ] + }, + { + "name" : "beforeInvalidDrop", + "desc" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the invalid drop should proceed, else false to cancel" + } + ] + }, + { + "name" : "beforeDragDrop", + "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag drop event is valid, else false to cancel" + } + ] + }, + { + "name" : "getProxy", + "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.dd.StatusProxy", + "desc" : "proxy The StatusProxy" + } + ] + }, + { + "name" : "onBeforeDrag", + "desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data to be shared with drop targets", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag event is valid, else false to cancel" + } + ] + }, + { + "name" : "onStartDrag", + "desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun. The drag cannot be canceled from this function.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The x position of the click on the dragged object", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The y position of the click on the dragged object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeDragOver", + "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragSource", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag event is valid, else false to cancel" + } + ] + }, + { + "name" : "initFrame", + "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DDProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "createFrame", + "desc" : "Creates the proxy element if it does not yet exist", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DDProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "alignElWithMouse", + "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "HTMLElement", + "desc" : "the element to move", + "isOptional" : false + }, + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the mousedown or drag event", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the mousedown or drag event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDelta", + "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iDeltaX", + "type" : "int", + "desc" : "the distance from the left", + "isOptional" : false + }, + { + "name" : "iDeltaY", + "type" : "int", + "desc" : "the distance from the top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autoOffset", + "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the click", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the click", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDragElPos", + "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the mousedown or drag event", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the mousedown or drag event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "cachePosition", + "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DD", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "", + "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "", + "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setHandleElId", + "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to\ninitiate the drag.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "init", + "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleType", + "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to unexclude", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "unreg", + "desc" : "Remove all drag and drop hooks for this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleType", + "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to exclude", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragDrop", + "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleId", + "desc" : "Unsets an invalid handle id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the id of the element to re-enable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onAvailable", + "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setOuterHandleElId", + "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onMouseUp", + "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getDragEl", + "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] + }, + { + "name" : "setYConstraint", + "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iUp", + "type" : "int", + "desc" : "the number of pixels the element can move up", + "isOptional" : false + }, + { + "name" : "iDown", + "type" : "int", + "desc" : "the number of pixels the element can move down", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearConstraints", + "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onInvalidDrop", + "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleId", + "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the element id of the element you wish to ignore", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleClass", + "desc" : "Unsets an invalid css class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the element(s) you wish to\nre-enable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragOut", + "desc" : "Abstract method called when we are no longer hovering over an element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDragElId", + "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "endDrag", + "desc" : "Fired when we are done dragging the object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns a reference to the linked element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] + }, + { + "name" : "onDrag", + "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragEnter", + "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "lock", + "desc" : "Lock this instance", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onMouseDown", + "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousedown event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "applyConfig", + "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "unlock", + "desc" : "Unlock this instace", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isTarget", + "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setInitPosition", + "desc" : "Stores the initial placement of the linked element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "diffX", + "type" : "int", + "desc" : "the X offset, default 0", + "isOptional" : false + }, + { + "name" : "diffY", + "type" : "int", + "desc" : "the Y offset, default 0", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "initTarget", + "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addToGroup", + "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "", + "desc" : "{string} the name of the group", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragOver", + "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toString", + "desc" : "toString method", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "string representation of the dd obj" + } + ] + }, + { + "name" : "setPadding", + "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iTop", + "type" : "int", + "desc" : "Top pad", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "Right pad", + "isOptional" : false + }, + { + "name" : "iBot", + "type" : "int", + "desc" : "Bot pad", + "isOptional" : false + }, + { + "name" : "iLeft", + "type" : "int", + "desc" : "Left pad", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeFromGroup", + "desc" : "Remove's this instance from the supplied interaction group", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "string", + "desc" : "The group to drop", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleClass", + "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the elements you wish to ignore", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "startDrag", + "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "X", + "type" : "int", + "desc" : "click location", + "isOptional" : false + }, + { + "name" : "Y", + "type" : "int", + "desc" : "click location", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "padding", + "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "resetConstraints", + "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "maintainOffset", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearTicks", + "desc" : "Clears any tick interval defined for this instance", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isLocked", + "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this obj or all drag/drop is locked, else\nfalse" + } + ] + }, + { + "name" : "setXConstraint", + "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iLeft", + "type" : "int", + "desc" : "the number of pixels the element can move to the left", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "the number of pixels the element can move to the\nright", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isValidHandleChild", + "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "the HTMLElement to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this is a valid tag type, false if not" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.dd.DropTarget.json b/docs2/symbols/Roo.dd.DropTarget.json new file mode 100644 index 0000000000..e21357dd1c --- /dev/null +++ b/docs2/symbols/Roo.dd.DropTarget.json @@ -0,0 +1,1537 @@ +{ + "name" : "Roo.dd.DropTarget", + "augments" : [ + "Roo.dd.DDTarget", + "Roo.dd.DragDrop", + "Roo.util.Observable" + ], + "desc" : "A simple class that provides the basic implementation needed to make any element a drop target that can have\ndraggable items dropped onto it. The drop has no effect until an implementation of notifyDrop is provided.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "dropNotAllowed", + "type" : "String", + "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").", + "memberOf" : "Roo.dd.DropTarget", + "values" : [ + ] + }, + { + "name" : "valid", + "type" : "boolean|String", + "desc" : "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..", + "memberOf" : "Roo.dd.DropTarget", + "values" : [ + ] + }, + { + "name" : "success", + "type" : "boolean", + "desc" : "set this after drop listener..", + "memberOf" : "Roo.dd.DropTarget", + "values" : [ + ] + }, + { + "name" : "dropAllowed", + "type" : "String", + "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").", + "memberOf" : "Roo.dd.DropTarget", + "values" : [ + ] + }, + { + "name" : "overClass", + "type" : "String", + "desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").", + "memberOf" : "Roo.dd.DropTarget", + "values" : [ + ] + }, + { + "name" : "ddGroup", + "type" : "String", + "desc" : "The drag drop group to handle drop events for", + "memberOf" : "Roo.dd.DropTarget", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "notifyDrop", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DropTarget", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "notifyEnter", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DropTarget", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "notifyOut", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DropTarget", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "notifyOver", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DropTarget", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setHandleElId", + "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to\ninitiate the drag.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "init", + "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleType", + "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to unexclude", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "unreg", + "desc" : "Remove all drag and drop hooks for this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleType", + "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to exclude", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragDrop", + "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleId", + "desc" : "Unsets an invalid handle id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the id of the element to re-enable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onAvailable", + "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setOuterHandleElId", + "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onMouseUp", + "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getDragEl", + "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] + }, + { + "name" : "setYConstraint", + "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iUp", + "type" : "int", + "desc" : "the number of pixels the element can move up", + "isOptional" : false + }, + { + "name" : "iDown", + "type" : "int", + "desc" : "the number of pixels the element can move down", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearConstraints", + "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onInvalidDrop", + "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleId", + "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the element id of the element you wish to ignore", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleClass", + "desc" : "Unsets an invalid css class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the element(s) you wish to\nre-enable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragOut", + "desc" : "Abstract method called when we are no longer hovering over an element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDragElId", + "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "endDrag", + "desc" : "Fired when we are done dragging the object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns a reference to the linked element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] + }, + { + "name" : "onDrag", + "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragEnter", + "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "lock", + "desc" : "Lock this instance", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onMouseDown", + "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousedown event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "applyConfig", + "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "unlock", + "desc" : "Unlock this instace", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isTarget", + "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setInitPosition", + "desc" : "Stores the initial placement of the linked element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "diffX", + "type" : "int", + "desc" : "the X offset, default 0", + "isOptional" : false + }, + { + "name" : "diffY", + "type" : "int", + "desc" : "the Y offset, default 0", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "initTarget", + "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addToGroup", + "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "", + "desc" : "{string} the name of the group", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragOver", + "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toString", + "desc" : "toString method", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "string representation of the dd obj" + } + ] + }, + { + "name" : "setPadding", + "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iTop", + "type" : "int", + "desc" : "Top pad", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "Right pad", + "isOptional" : false + }, + { + "name" : "iBot", + "type" : "int", + "desc" : "Bot pad", + "isOptional" : false + }, + { + "name" : "iLeft", + "type" : "int", + "desc" : "Left pad", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeFromGroup", + "desc" : "Remove's this instance from the supplied interaction group", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "string", + "desc" : "The group to drop", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleClass", + "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the elements you wish to ignore", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "startDrag", + "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "X", + "type" : "int", + "desc" : "click location", + "isOptional" : false + }, + { + "name" : "Y", + "type" : "int", + "desc" : "click location", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "padding", + "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "resetConstraints", + "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "maintainOffset", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearTicks", + "desc" : "Clears any tick interval defined for this instance", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isLocked", + "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this obj or all drag/drop is locked, else\nfalse" + } + ] + }, + { + "name" : "setXConstraint", + "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iLeft", + "type" : "int", + "desc" : "the number of pixels the element can move to the left", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "the number of pixels the element can move to the\nright", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isValidHandleChild", + "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "the HTMLElement to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this is a valid tag type, false if not" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "out", + "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged\nout of the target without dropping. This default implementation simply removes the CSS class specified by\noverClass (if any) from the drop element.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "over", + "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.dropAllowed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enter", + "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.overClass and this.dropAllowed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "drop", + "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has\nbeen dropped on it. This method has no default implementation and returns false, so you must provide an\nimplementation that does something to process the drop event and returns true so that the drag source's\nrepair action does not run.\n\nIMPORTANT : it should set this.success", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.dd.DropZone.json b/docs2/symbols/Roo.dd.DropZone.json new file mode 100644 index 0000000000..05d4284bfe --- /dev/null +++ b/docs2/symbols/Roo.dd.DropZone.json @@ -0,0 +1,1900 @@ +{ + "name" : "Roo.dd.DropZone", + "augments" : [ + "Roo.dd.DropTarget", + "Roo.dd.DDTarget", + "Roo.dd.DragDrop", + "Roo.util.Observable" + ], + "desc" : "This class provides a container DD instance that proxies for multiple child node targets.
\nBy default, this class requires that child nodes accepting drop are registered with {@link Roo.dd.Registry}.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "dropNotAllowed", + "type" : "String", + "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").", + "memberOf" : "Roo.dd.DropTarget", + "values" : [ + ] + }, + { + "name" : "valid", + "type" : "boolean|String", + "desc" : "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..", + "memberOf" : "Roo.dd.DropTarget", + "values" : [ + ] + }, + { + "name" : "success", + "type" : "boolean", + "desc" : "set this after drop listener..", + "memberOf" : "Roo.dd.DropTarget", + "values" : [ + ] + }, + { + "name" : "dropAllowed", + "type" : "String", + "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").", + "memberOf" : "Roo.dd.DropTarget", + "values" : [ + ] + }, + { + "name" : "overClass", + "type" : "String", + "desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").", + "memberOf" : "Roo.dd.DropTarget", + "values" : [ + ] + }, + { + "name" : "ddGroup", + "type" : "String", + "desc" : "The drag drop group to handle drop events for", + "memberOf" : "Roo.dd.DropTarget", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "onNodeEnter", + "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has entered a drop node\nthat it has registered. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DropZone", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "nodeData", + "type" : "Object", + "desc" : "The custom data associated with the drop node (this is the same value returned from \n{@link #getTargetFromEvent} for this node)", + "isOptional" : false + }, + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop zone", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onContainerDrop", + "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped on it,\nbut not on any of its registered drop nodes. The default implementation returns false, so it should be\noverridden to provide the appropriate processing of the drop event if you need the drop zone itself to\nbe able to accept drops. It should return true when valid so that the drag source's repair action does not run.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DropZone", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop zone", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the drop was valid, else false" + } + ] + }, + { + "name" : "notifyOver", + "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the drop zone.\nThis method will be called on every mouse movement while the drag source is over the drop zone.\nIt will call {@link #onNodeOver} while the drag source is over a registered node, and will also automatically\ndelegate to the appropriate node-specific methods as necessary when the drag source enters and exits\nregistered nodes ({@link #onNodeEnter}, {@link #onNodeOut}). If the drag source is not currently over a\nregistered node, it will call {@link #onContainerOver}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DropZone", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop zone", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated" + } + ] + }, + { + "name" : "onNodeDrop", + "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped onto\nthe drop node. The default implementation returns false, so it should be overridden to provide the\nappropriate processing of the drop event and return true so that the drag source's repair action does not run.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DropZone", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "nodeData", + "type" : "Object", + "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)", + "isOptional" : false + }, + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop zone", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the drop was valid, else false" + } + ] + }, + { + "name" : "notifyOut", + "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source has been dragged\nout of the zone without dropping. If the drag source is currently over a registered node, the notification\nwill be delegated to {@link #onNodeOut} for node-specific handling, otherwise it will be ignored.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DropZone", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag zone", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "notifyEnter", + "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source is now over\nthe zone. The default implementation returns this.dropNotAllowed and expects that only registered drop\nnodes can process drag drop operations, so if you need the drop zone itself to be able to process drops\nyou should override this method and provide a custom implementation.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DropZone", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop zone", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated" + } + ] + }, + { + "name" : "notifyDrop", + "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the dragged item has\nbeen dropped on it. The drag zone will look up the target node based on the event passed in, and if there\nis a node registered for that event, it will delegate to {@link #onNodeDrop} for node-specific handling,\notherwise it will call {@link #onContainerDrop}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DropZone", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop zone", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the drop was valid, else false" + } + ] + }, + { + "name" : "onNodeOut", + "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dragged out of\nthe drop node without dropping. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DropZone", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "nodeData", + "type" : "Object", + "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)", + "isOptional" : false + }, + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop zone", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onContainerOver", + "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is being dragged over it,\nbut not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so\nit should be overridden to provide the proper feedback if necessary.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DropZone", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop zone", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated" + } + ] + }, + { + "name" : "getTargetFromEvent", + "desc" : "Returns a custom data object associated with the DOM node that is the target of the event. By default\nthis looks up the event target in the {@link Roo.dd.Registry}, although you can override this method to\nprovide your own custom lookup.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DropZone", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "data The custom data" + } + ] + }, + { + "name" : "onNodeOver", + "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is over a drop node\nthat it has registered. The default implementation returns this.dropNotAllowed, so it should be\noverridden to provide the proper feedback.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DropZone", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "nodeData", + "type" : "Object", + "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)", + "isOptional" : false + }, + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop zone", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated" + } + ] + }, + { + "name" : "setHandleElId", + "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to\ninitiate the drag.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "init", + "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleType", + "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to unexclude", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "unreg", + "desc" : "Remove all drag and drop hooks for this element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleType", + "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to exclude", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragDrop", + "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleId", + "desc" : "Unsets an invalid handle id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the id of the element to re-enable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onAvailable", + "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setOuterHandleElId", + "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onMouseUp", + "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getDragEl", + "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] + }, + { + "name" : "setYConstraint", + "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iUp", + "type" : "int", + "desc" : "the number of pixels the element can move up", + "isOptional" : false + }, + { + "name" : "iDown", + "type" : "int", + "desc" : "the number of pixels the element can move down", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearConstraints", + "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onInvalidDrop", + "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleId", + "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the element id of the element you wish to ignore", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeInvalidHandleClass", + "desc" : "Unsets an invalid css class", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the element(s) you wish to\nre-enable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragOut", + "desc" : "Abstract method called when we are no longer hovering over an element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDragElId", + "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "endDrag", + "desc" : "Fired when we are done dragging the object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns a reference to the linked element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] + }, + { + "name" : "onDrag", + "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragEnter", + "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "lock", + "desc" : "Lock this instance", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onMouseDown", + "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousedown event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "applyConfig", + "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "unlock", + "desc" : "Unlock this instace", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isTarget", + "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setInitPosition", + "desc" : "Stores the initial placement of the linked element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "diffX", + "type" : "int", + "desc" : "the X offset, default 0", + "isOptional" : false + }, + { + "name" : "diffY", + "type" : "int", + "desc" : "the Y offset, default 0", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "initTarget", + "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addToGroup", + "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "", + "desc" : "{string} the name of the group", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onDragOver", + "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toString", + "desc" : "toString method", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "string representation of the dd obj" + } + ] + }, + { + "name" : "setPadding", + "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iTop", + "type" : "int", + "desc" : "Top pad", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "Right pad", + "isOptional" : false + }, + { + "name" : "iBot", + "type" : "int", + "desc" : "Bot pad", + "isOptional" : false + }, + { + "name" : "iLeft", + "type" : "int", + "desc" : "Left pad", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeFromGroup", + "desc" : "Remove's this instance from the supplied interaction group", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "string", + "desc" : "The group to drop", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addInvalidHandleClass", + "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the elements you wish to ignore", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "startDrag", + "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "X", + "type" : "int", + "desc" : "click location", + "isOptional" : false + }, + { + "name" : "Y", + "type" : "int", + "desc" : "click location", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "padding", + "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "resetConstraints", + "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "maintainOffset", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearTicks", + "desc" : "Clears any tick interval defined for this instance", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isLocked", + "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this obj or all drag/drop is locked, else\nfalse" + } + ] + }, + { + "name" : "setXConstraint", + "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "iLeft", + "type" : "int", + "desc" : "the number of pixels the element can move to the left", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "the number of pixels the element can move to the\nright", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isValidHandleChild", + "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.DragDrop", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "the HTMLElement to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this is a valid tag type, false if not" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "out", + "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged\nout of the target without dropping. This default implementation simply removes the CSS class specified by\noverClass (if any) from the drop element.", + "memberOf" : "Roo.dd.DropTarget", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "over", + "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.dropAllowed", + "memberOf" : "Roo.dd.DropTarget", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enter", + "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.overClass and this.dropAllowed", + "memberOf" : "Roo.dd.DropTarget", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "drop", + "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has\nbeen dropped on it. This method has no default implementation and returns false, so you must provide an\nimplementation that does something to process the drop event and returns true so that the drag source's\nrepair action does not run.\n\nIMPORTANT : it should set this.success", + "memberOf" : "Roo.dd.DropTarget", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.dd.Registry.json b/docs2/symbols/Roo.dd.Registry.json new file mode 100644 index 0000000000..63cedfb923 --- /dev/null +++ b/docs2/symbols/Roo.dd.Registry.json @@ -0,0 +1,173 @@ +{ + "name" : "Roo.dd.Registry", + "augments" : [ + ], + "desc" : "Provides easy access to all drag drop components that are registered on a page. Items can be retrieved either\ndirectly by DOM node id, or by passing in the drag drop event that occurred and looking up the event target.", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "getHandleFromEvent", + "desc" : "Returns the handle that is registered for the DOM node that is the target of the event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.Registry", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "handle The custom handle data" + } + ] + }, + { + "name" : "getTargetFromEvent", + "desc" : "Returns a custom data object that is registered for the DOM node that is the target of the event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.Registry", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "data The custom data" + } + ] + }, + { + "name" : "register", + "desc" : "Register a drag drop element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.Registry", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String|HTMLElement", + "desc" : "The id or DOM node to register", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "(optional) A custom data object that will be passed between the elements that are involved\nin drag drop operations. You can populate this object with any arbitrary properties that your own code\nknows how to interpret, plus there are some specific properties known to the Registry that should be\npopulated in the data object (if applicable):\n
\nValue      Description
\n--------- ------------------------------------------
\nhandles Array of DOM nodes that trigger dragging
\n for the element being registered
\nisHandle True if the element passed in triggers
\n dragging itself, else false\n
", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "unregister", + "desc" : "Unregister a drag drop element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.Registry", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String|HTMLElement", + "desc" : "The id or DOM node to unregister", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getHandle", + "desc" : "Returns the handle registered for a DOM Node by id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.Registry", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String|HTMLElement", + "desc" : "The DOM node or id to look up", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "handle The custom handle data" + } + ] + }, + { + "name" : "getTarget", + "desc" : "Returns a custom data object that is registered for a DOM node by id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.Registry", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String|HTMLElement", + "desc" : "The DOM node or id to look up", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "data The custom data" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.dd.ScrollManager.json b/docs2/symbols/Roo.dd.ScrollManager.json new file mode 100644 index 0000000000..3a09657c31 --- /dev/null +++ b/docs2/symbols/Roo.dd.ScrollManager.json @@ -0,0 +1,75 @@ +{ + "name" : "Roo.dd.ScrollManager", + "augments" : [ + ], + "desc" : "Provides automatic scrolling of overflow regions in the page during drag operations.

\nNote: This class uses \"Point Mode\" and is untested in \"Intersect Mode\".", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "register", + "desc" : "Registers new overflow element(s) to auto scroll", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.ScrollManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element/Array", + "desc" : "The id of or the element to be scrolled or an array of either", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "unregister", + "desc" : "Unregisters overflow element(s) so they are no longer scrolled", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.ScrollManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element/Array", + "desc" : "The id of or the element to be removed or an array of either", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "refreshCache", + "desc" : "Manually trigger a cache refresh.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.ScrollManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.dd.StatusProxy.json b/docs2/symbols/Roo.dd.StatusProxy.json new file mode 100644 index 0000000000..2e54c4b755 --- /dev/null +++ b/docs2/symbols/Roo.dd.StatusProxy.json @@ -0,0 +1,243 @@ +{ + "name" : "Roo.dd.StatusProxy", + "augments" : [ + ], + "desc" : "A specialized drag proxy that supports a drop status icon, {@link Roo.Layer} styles and auto-repair. This is the\ndefault drag proxy used by all Roo.dd components.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "dropNotAllowed", + "type" : "String", + "desc" : "The CSS class to apply to the status element when drop is not allowed (defaults to \"x-dd-drop-nodrop\").", + "memberOf" : "Roo.dd.StatusProxy", + "values" : [ + ] + }, + { + "name" : "dropAllowed", + "type" : "String", + "desc" : "The CSS class to apply to the status element when drop is allowed (defaults to \"x-dd-drop-ok\").", + "memberOf" : "Roo.dd.StatusProxy", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "reset", + "desc" : "Resets the status indicator to the default dropNotAllowed value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.StatusProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "clearGhost", + "type" : "Boolean", + "desc" : "True to also remove all content from the ghost, false to preserve it", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getGhost", + "desc" : "Returns the ghost element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.StatusProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "el" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying proxy {@link Roo.Layer}", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.StatusProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Layer", + "desc" : "el" + } + ] + }, + { + "name" : "sync", + "desc" : "Force the Layer to sync its shadow and shim positions to the element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.StatusProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hides the proxy", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.StatusProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "clear", + "type" : "Boolean", + "desc" : "True to reset the status and clear the ghost contents, false to preserve them", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Displays this proxy", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.StatusProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "stop", + "desc" : "Stops the repair animation if it's currently running", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.StatusProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setStatus", + "desc" : "Updates the proxy's visual element to indicate the status of whether or not drop is allowed\nover the current target element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.StatusProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "String", + "desc" : "The css class for the new drop status indicator image", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "update", + "desc" : "Updates the contents of the ghost element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.StatusProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "html", + "type" : "String", + "desc" : "The html that will replace the current innerHTML of the ghost element", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "repair", + "desc" : "Causes the proxy to return to its position of origin via an animation. Should be called after an\ninvalid drop operation by the item being dragged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.dd.StatusProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "xy", + "type" : "Array", + "desc" : "The XY position of the element ([x, y])", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "The function to call after the repair is complete", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "The scope in which to execute the callback", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.dd.json b/docs2/symbols/Roo.dd.json new file mode 100644 index 0000000000..4bcbfe02a2 --- /dev/null +++ b/docs2/symbols/Roo.dd.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.dd", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.Action.json b/docs2/symbols/Roo.form.Action.json new file mode 100644 index 0000000000..e69a254e3e --- /dev/null +++ b/docs2/symbols/Roo.form.Action.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.form.Action", + "augments" : [ + ], + "desc" : "Internal Class used to handle form actions", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.BasicForm.json b/docs2/symbols/Roo.form.BasicForm.json new file mode 100644 index 0000000000..77cc95b045 --- /dev/null +++ b/docs2/symbols/Roo.form.BasicForm.json @@ -0,0 +1,1024 @@ +{ + "name" : "Roo.form.BasicForm", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "Supplies the functionality to do \"actions\" on forms and initialize Roo.form.Field types on existing markup.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "fileUpload", + "type" : "Boolean", + "desc" : "Set to true if this form is a file upload.", + "memberOf" : "Roo.form.BasicForm", + "values" : [ + ] + }, + { + "name" : "method", + "type" : "String", + "desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.", + "memberOf" : "Roo.form.BasicForm", + "values" : [ + ] + }, + { + "name" : "timeout", + "type" : "Number", + "desc" : "Timeout for form actions in seconds (default is 30 seconds).", + "memberOf" : "Roo.form.BasicForm", + "values" : [ + ] + }, + { + "name" : "baseParams", + "type" : "Object", + "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.", + "memberOf" : "Roo.form.BasicForm", + "values" : [ + ] + }, + { + "name" : "trackResetOnLoad", + "type" : "Boolean", + "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.", + "memberOf" : "Roo.form.BasicForm", + "values" : [ + ] + }, + { + "name" : "reader", + "type" : "DataReader", + "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.", + "memberOf" : "Roo.form.BasicForm", + "values" : [ + ] + }, + { + "name" : "errorReader", + "type" : "DataReader", + "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.", + "memberOf" : "Roo.form.BasicForm", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "The URL to use for form actions if one isn't supplied in the action options.", + "memberOf" : "Roo.form.BasicForm", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "remove", + "desc" : "Removes a field from the items collection (does NOT remove its markup).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "field", + "type" : "Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "loadRecord", + "desc" : "Loads an Roo.data.Record into this form.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "record", + "type" : "Record", + "desc" : "The record to load", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "load", + "desc" : "Shortcut to do a load action.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "The options to pass to the action (see {@link #doAction} for details)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "doAction", + "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "actionName", + "type" : "String", + "desc" : "The name of the action type", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n
\nProperty          Type             Description\n----------------  ---------------  ----------------------------------------------------------------------------------\nurl               String           The url for the action (defaults to the form's url)\nmethod            String           The form method to use (defaults to the form's method, or POST if not defined)\nparams            String/Object    The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation  Boolean          Applies to submit only.  Pass true to call form.isValid() prior to posting to\n                                   validate the form on the client (defaults to false)\n
", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "getValues", + "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "asString", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clears all invalid messages in this form.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "isDirty", + "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] + }, + { + "name" : "updateRecord", + "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "record", + "type" : "Record", + "desc" : "The record to edit", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "hasChanged", + "desc" : "Returns true if any fields in this form have changed since their original load. (New version)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] + }, + { + "name" : "applyToFields", + "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "values", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "getFieldValues", + "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] + }, + { + "name" : "submit", + "desc" : "Shortcut to do a submit action.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "The options to pass to the action (see {@link #doAction} for details)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark fields in this form invalid in bulk.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "errors", + "type" : "Array/Object", + "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "setValues", + "desc" : "Set values for fields in this form in bulk.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "values", + "type" : "Array/Object", + "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "isValid", + "desc" : "Returns true if client-side validation on the form is successful.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] + }, + { + "name" : "render", + "desc" : "Looks at the fields in this form, checks them for an id attribute,\nand calls applyTo on the existing dom element with that id.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "add", + "desc" : "Add Roo.form components to this form.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "field1", + "type" : "Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "field2", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + }, + { + "name" : "etc", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "applyIfToFields", + "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "values", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "findField", + "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The value to search for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Field" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets this form.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "addForm", + "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "form", + "type" : "Roo.form.Form", + "desc" : "to add.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforeaction", + "desc" : "Fires before any action is performed. Return false to cancel the action.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "action", + "type" : "Action", + "desc" : "The action to be performed", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "actioncomplete", + "desc" : "Fires when an action is completed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "action", + "type" : "Action", + "desc" : "The action that completed", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "actionfailed", + "desc" : "Fires when an action fails.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "action", + "type" : "Action", + "desc" : "The action that failed", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.Checkbox.json b/docs2/symbols/Roo.form.Checkbox.json new file mode 100644 index 0000000000..780c2bf968 --- /dev/null +++ b/docs2/symbols/Roo.form.Checkbox.json @@ -0,0 +1,1826 @@ +{ + "name" : "Roo.form.Checkbox", + "augments" : [ + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Single checkbox field. Can be used as a direct replacement for traditional checkbox fields.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "inputValue", + "type" : "String", + "desc" : "The value that should go into the generated input element's value attribute", + "memberOf" : "Roo.form.Checkbox", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.Checkbox", + "values" : [ + ] + }, + { + "name" : "valueOff", + "type" : "String", + "desc" : "The value that should go into the generated input element's value when unchecked.", + "memberOf" : "Roo.form.Checkbox", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "boxLabel", + "type" : "String", + "desc" : "The text that appears beside the checkbox", + "memberOf" : "Roo.form.Checkbox", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Checkbox", + "values" : [ + ] + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "True if the the checkbox should render already checked (defaults to false)", + "memberOf" : "Roo.form.Checkbox", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)", + "memberOf" : "Roo.form.Checkbox", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "setValue", + "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Checkbox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean/String", + "desc" : "- the value to set", + "isOptional" : false + }, + { + "name" : "suppressEvent", + "type" : "Boolean/String", + "desc" : "- whether to suppress the checkchange event.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Returns the checked state of the checkbox.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Checkbox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if checked, else false" + } + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "check", + "desc" : "Fires when the checkbox is checked or unchecked.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Checkbox", + "desc" : "This checkbox", + "isOptional" : false + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "The new checked value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.Column.json b/docs2/symbols/Roo.form.Column.json new file mode 100644 index 0000000000..3ac264ae4c --- /dev/null +++ b/docs2/symbols/Roo.form.Column.json @@ -0,0 +1,894 @@ +{ + "name" : "Roo.form.Column", + "augments" : [ + "Roo.form.Layout", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Creates a column container for layout and rendering of fields in an {@link Roo.form.Form}.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "labelAlign", + "type" : "String", + "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "hideLabels", + "type" : "Boolean", + "desc" : "True to suppress the display of field labels in this layout (defaults to false)", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String/Object/Function", + "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "Fixed width in pixels of all field labels (defaults to undefined)", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "labelSeparator", + "type" : "String", + "desc" : "The separator to use after field labels (defaults to ':')", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec used to autocreate the column (defaults to {tag: 'div', cls: 'x-form-ct x-form-column'})", + "memberOf" : "Roo.form.Column", + "values" : [ + ] + }, + { + "name" : "clear", + "type" : "Boolean", + "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number/String", + "desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")", + "memberOf" : "Roo.form.Column", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "addxtype", + "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Layout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.ComboBox.json b/docs2/symbols/Roo.form.ComboBox.json new file mode 100644 index 0000000000..90cc547feb --- /dev/null +++ b/docs2/symbols/Roo.form.ComboBox.json @@ -0,0 +1,2683 @@ +{ + "name" : "Roo.form.ComboBox", + "augments" : [ + "Roo.form.TriggerField", + "Roo.form.TextField", + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "A combobox control with support for autocomplete, remote-loading, paging and many other features.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be appended if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "pageSize", + "type" : "Number", + "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "queryParam", + "type" : "String", + "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "resizable", + "type" : "Boolean", + "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "editable", + "type" : "Boolean", + "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "listWidth", + "type" : "Number", + "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tpl", + "type" : "String/Roo.Template", + "desc" : "The template to use to render the output", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "typeAheadDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "disableClear", + "type" : "Boolean", + "desc" : "Disable showing of clear button.", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "The data store to which this combo is bound (defaults to undefined)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "allQuery", + "type" : "String", + "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "minListWidth", + "type" : "Number", + "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "alwaysQuery", + "type" : "Boolean", + "desc" : "Disable caching of results, and always send query", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "valueNotFoundText", + "type" : "String", + "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "hiddenName", + "type" : "String", + "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "selectedClass", + "type" : "String", + "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "displayField", + "type" : "String", + "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "Roo.form.TriggerField", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "listAlign", + "type" : "String", + "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "typeAhead", + "type" : "Boolean", + "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "forceSelection", + "type" : "Boolean", + "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "triggerAction", + "type" : "String", + "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "minChars", + "type" : "Number", + "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "blockFocus", + "type" : "Boolean", + "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "transform", + "type" : "String/HTMLElement/Element", + "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "listClass", + "type" : "String", + "desc" : "CSS class to apply to the dropdown list element (defaults to '')", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "handleHeight", + "type" : "Number", + "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "queryDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "mode", + "type" : "String", + "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maxHeight", + "type" : "Number", + "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "valueField", + "type" : "String", + "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "loadingText", + "type" : "String", + "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "lazyRender", + "type" : "Boolean", + "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getValue", + "desc" : "Returns the currently selected field value or empty string if no value is set.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "value The selected value" + } + ] + }, + { + "name" : "expand", + "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setValue", + "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value to match", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "select", + "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The zero-based index of the list item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isExpanded", + "desc" : "Returns true if the dropdown list is expanded, else false.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "doQuery", + "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "query", + "type" : "String", + "desc" : "The SQL query to execute", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setFromData", + "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Object", + "desc" : "the value to set as. or false on reset?", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "selectByValue", + "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The data value of the item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value matched an item in the list, else false" + } + ] + }, + { + "name" : "setEditable", + "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean", + "desc" : "True to allow the user to directly edit the field text", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collapse", + "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "clearValue", + "desc" : "Clears any text/value currently set in the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onTriggerClick", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autoSize", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "selectText", + "desc" : "Selects text in this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "add", + "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "expand", + "desc" : "Fires when the dropdown list is expanded", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collapse", + "desc" : "Fires when the dropdown list is collapsed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "select", + "desc" : "Fires when a list item is selected", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The data record returned from the underlying store (or false on clear)", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the selected item in the dropdown list", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "edit", + "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record|false", + "desc" : "The data record returned from the underlying store (or false on nothing selected)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforequery", + "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "query", + "type" : "String", + "desc" : "The query", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "true to force \"all\" query", + "isOptional" : false + }, + { + "name" : "cancel", + "type" : "Boolean", + "desc" : "true to cancel the query", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The query event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeselect", + "desc" : "Fires before a list item is selected. Return false to cancel the selection.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The data record returned from the underlying store", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the selected item in the dropdown list", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autosize", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.ComboBoxArray.Item.json b/docs2/symbols/Roo.form.ComboBoxArray.Item.json new file mode 100644 index 0000000000..c4f384652b --- /dev/null +++ b/docs2/symbols/Roo.form.ComboBoxArray.Item.json @@ -0,0 +1,1163 @@ +{ + "name" : "Roo.form.ComboBoxArray.Item", + "augments" : [ + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "A selected item in the list\n Fred [x] Brian [x] [Pick another |v]", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.ComboBoxArray.json b/docs2/symbols/Roo.form.ComboBoxArray.json new file mode 100644 index 0000000000..68d0369a6f --- /dev/null +++ b/docs2/symbols/Roo.form.ComboBoxArray.json @@ -0,0 +1,2062 @@ +{ + "name" : "Roo.form.ComboBoxArray", + "augments" : [ + "Roo.form.TextField", + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "A facebook style adder... for lists of email / people / countries etc...\npick multiple items from a combo box, and shows each one.\n\n Fred [x] Brian [x] [Pick another |v]\n\n\n For this to work: it needs various extra information\n - normal combo problay has\n name, hiddenName\n + displayField, valueField\n\n For our purpose...\n\n\n If we change from 'extends' to wrapping...", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The name of the visable items on this form (eg. titles not ids)", + "memberOf" : "Roo.form.ComboBoxArray", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The width of the box that displays the selected element", + "memberOf" : "Roo.form.ComboBoxArray", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "combo", + "type" : "Roo.form.Combo", + "desc" : "The combo box that is wrapped", + "memberOf" : "Roo.form.ComboBoxArray", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "hiddenName", + "type" : "String", + "desc" : "The hidden name of the field, often contains an comma seperated list of names", + "memberOf" : "Roo.form.ComboBoxArray", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "The minimum width to allow when grow = true (defaults to 30)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "The maximum width to allow when grow = true (defaults to 800)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "True if this field should automatically grow and shrink to its content", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "validate", + "desc" : "Validates the combox array value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBoxArray", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "selectText", + "desc" : "Selects text in this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "autoSize", + "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforeremove", + "desc" : "Fires before remove the value from the list", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "_self", + "type" : "Roo.form.ComboBoxArray", + "desc" : "This combo box array", + "isOptional" : false + }, + { + "name" : "item", + "type" : "Roo.form.ComboBoxArray.Item", + "desc" : "removed item", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Fires when remove the value from the list", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "_self", + "type" : "Roo.form.ComboBoxArray", + "desc" : "This combo box array", + "isOptional" : false + }, + { + "name" : "item", + "type" : "Roo.form.ComboBoxArray.Item", + "desc" : "removed item", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autosize", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.ComboCheck.json b/docs2/symbols/Roo.form.ComboCheck.json new file mode 100644 index 0000000000..e39fe04086 --- /dev/null +++ b/docs2/symbols/Roo.form.ComboCheck.json @@ -0,0 +1,2684 @@ +{ + "name" : "Roo.form.ComboCheck", + "augments" : [ + "Roo.form.ComboBox", + "Roo.form.TriggerField", + "Roo.form.TextField", + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "A combobox for multiple select items.\n\nFIXME - could do with a reset button..", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be appended if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "pageSize", + "type" : "Number", + "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "queryParam", + "type" : "String", + "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "resizable", + "type" : "Boolean", + "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "editable", + "type" : "Boolean", + "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "listWidth", + "type" : "Number", + "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "tpl", + "type" : "String/Roo.Template", + "desc" : "The template to use to render the output", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "typeAheadDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "disableClear", + "type" : "Boolean", + "desc" : "Disable showing of clear button.", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "The data store to which this combo is bound (defaults to undefined)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "allQuery", + "type" : "String", + "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "minListWidth", + "type" : "Number", + "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "alwaysQuery", + "type" : "Boolean", + "desc" : "Disable caching of results, and always send query", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "valueNotFoundText", + "type" : "String", + "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "hiddenName", + "type" : "String", + "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "selectedClass", + "type" : "String", + "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "displayField", + "type" : "String", + "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "Roo.form.TriggerField", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "listAlign", + "type" : "String", + "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "typeAhead", + "type" : "Boolean", + "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "forceSelection", + "type" : "Boolean", + "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "triggerAction", + "type" : "String", + "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "minChars", + "type" : "Number", + "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "blockFocus", + "type" : "Boolean", + "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "transform", + "type" : "String/HTMLElement/Element", + "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "listClass", + "type" : "String", + "desc" : "CSS class to apply to the dropdown list element (defaults to '')", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "handleHeight", + "type" : "Number", + "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "queryDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "mode", + "type" : "String", + "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maxHeight", + "type" : "Number", + "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "valueField", + "type" : "String", + "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "loadingText", + "type" : "String", + "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "lazyRender", + "type" : "Boolean", + "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)", + "memberOf" : "Roo.form.ComboBox", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getValue", + "desc" : "Returns the currently selected field value or empty string if no value is set.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "value The selected value" + } + ] + }, + { + "name" : "expand", + "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setValue", + "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value to match", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "select", + "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The zero-based index of the list item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isExpanded", + "desc" : "Returns true if the dropdown list is expanded, else false.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "doQuery", + "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "query", + "type" : "String", + "desc" : "The SQL query to execute", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setFromData", + "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Object", + "desc" : "the value to set as. or false on reset?", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "selectByValue", + "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The data value of the item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value matched an item in the list, else false" + } + ] + }, + { + "name" : "setEditable", + "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean", + "desc" : "True to allow the user to directly edit the field text", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collapse", + "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "clearValue", + "desc" : "Clears any text/value currently set in the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onTriggerClick", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autoSize", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "selectText", + "desc" : "Selects text in this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "add", + "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)", + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "expand", + "desc" : "Fires when the dropdown list is expanded", + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collapse", + "desc" : "Fires when the dropdown list is collapsed", + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "select", + "desc" : "Fires when a list item is selected", + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The data record returned from the underlying store (or false on clear)", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the selected item in the dropdown list", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "edit", + "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record|false", + "desc" : "The data record returned from the underlying store (or false on nothing selected)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforequery", + "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:", + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "query", + "type" : "String", + "desc" : "The query", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "true to force \"all\" query", + "isOptional" : false + }, + { + "name" : "cancel", + "type" : "Boolean", + "desc" : "true to cancel the query", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The query event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeselect", + "desc" : "Fires before a list item is selected. Return false to cancel the selection.", + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The data record returned from the underlying store", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the selected item in the dropdown list", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autosize", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.DateField.json b/docs2/symbols/Roo.form.DateField.json new file mode 100644 index 0000000000..0742eb23c4 --- /dev/null +++ b/docs2/symbols/Roo.form.DateField.json @@ -0,0 +1,2124 @@ +{ + "name" : "Roo.form.DateField", + "augments" : [ + "Roo.form.TriggerField", + "Roo.form.TextField", + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Provides a date input field with a {@link Roo.DatePicker} dropdown and automatic date validation.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be appended if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).", + "memberOf" : "Roo.form.DateField", + "values" : [ + ] + }, + { + "name" : "useIso", + "type" : "Boolean", + "desc" : "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (false)", + "memberOf" : "Roo.form.DateField", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disabledDates", + "type" : "Array", + "desc" : "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n
    \n
  • [\"03/08/2003\", \"09/16/2003\"] would disable those exact dates
  • \n
  • [\"03/08\", \"09/16\"] would disable those days for every year
  • \n
  • [\"^03/08\"] would only match the beginning (useful if you are using short years)
  • \n
  • [\"03/../2006\"] would disable every day in March 2006
  • \n
  • [\"^03\"] would disable every day in every March
  • \n
\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].", + "memberOf" : "Roo.form.DateField", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "altFormats", + "type" : "String", + "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').", + "memberOf" : "Roo.form.DateField", + "values" : [ + ] + }, + { + "name" : "maxValue", + "type" : "Date/String", + "desc" : "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).", + "memberOf" : "Roo.form.DateField", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "minValue", + "type" : "Date/String", + "desc" : "The minimum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).", + "memberOf" : "Roo.form.DateField", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "disabledDaysText", + "type" : "String", + "desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')", + "memberOf" : "Roo.form.DateField", + "values" : [ + ] + }, + { + "name" : "minText", + "type" : "String", + "desc" : "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').", + "memberOf" : "Roo.form.DateField", + "values" : [ + ] + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "disabledDatesText", + "type" : "String", + "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')", + "memberOf" : "Roo.form.DateField", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "disabledDays", + "type" : "Array", + "desc" : "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).", + "memberOf" : "Roo.form.DateField", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "Roo.form.TriggerField", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.DateField", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "format", + "type" : "String", + "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').", + "memberOf" : "Roo.form.DateField", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "maxText", + "type" : "String", + "desc" : "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').", + "memberOf" : "Roo.form.DateField", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display when the date in the field is invalid (defaults to\n'{value} is not a valid date - it must be in the format {format}').", + "memberOf" : "Roo.form.DateField", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getValue", + "desc" : "Returns the current date value of the date field.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.DateField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Date", + "desc" : "The date value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using DateField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n
Usage:\n
\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\ndateField.setValue(dt);\n\n//Pass a date string (default format):\ndateField.setValue('5/4/06');\n\n//Pass a date string (custom format):\ndateField.format = 'Y-m-d';\ndateField.setValue('2006-5-4');\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.DateField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "date", + "type" : "String/Date", + "desc" : "The date or valid date string", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onTriggerClick", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autoSize", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "selectText", + "desc" : "Selects text in this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "select", + "desc" : "Fires when a date is selected", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.DateField", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Date", + "desc" : "The date selected", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autosize", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.DayPicker.json b/docs2/symbols/Roo.form.DayPicker.json new file mode 100644 index 0000000000..c25cee720e --- /dev/null +++ b/docs2/symbols/Roo.form.DayPicker.json @@ -0,0 +1,1769 @@ +{ + "name" : "Roo.form.DayPicker", + "augments" : [ + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "A Day picker show [M] [T] [W] ....", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.DayPicker", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.DayPicker", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)", + "memberOf" : "Roo.form.DayPicker", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getValue", + "desc" : "Returns the checked state of the checkbox.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.DayPicker", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if checked, else false" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.DayPicker", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean/String", + "desc" : "- the value to set", + "isOptional" : false + }, + { + "name" : "suppressEvent", + "type" : "Boolean/String", + "desc" : "- whether to suppress the checkchange event.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.DisplayField.json b/docs2/symbols/Roo.form.DisplayField.json new file mode 100644 index 0000000000..27ab555743 --- /dev/null +++ b/docs2/symbols/Roo.form.DisplayField.json @@ -0,0 +1,1800 @@ +{ + "name" : "Roo.form.DisplayField", + "augments" : [ + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "A generic Field to display non-editable data.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "valueRenderer", + "type" : "Function", + "desc" : "The renderer for the field (so you can reformat output). should return raw HTML", + "memberOf" : "Roo.form.DisplayField", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.DisplayField", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "default false", + "memberOf" : "Roo.form.DisplayField", + "values" : [ + "(true", + "false)" + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.DisplayField", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)", + "memberOf" : "Roo.form.DisplayField", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "setValue", + "desc" : "Sets the checked state of the checkbox.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.DisplayField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "checked", + "type" : "Boolean/String", + "desc" : "True, 'true', '1', or 'on' to check the checkbox, any other value will uncheck it.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "close", + "desc" : "Fires after the click the close btn", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.DisplayField", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.FCKeditor.json b/docs2/symbols/Roo.form.FCKeditor.json new file mode 100644 index 0000000000..796055cab9 --- /dev/null +++ b/docs2/symbols/Roo.form.FCKeditor.json @@ -0,0 +1,2038 @@ +{ + "name" : "Roo.form.FCKeditor", + "augments" : [ + "Roo.form.TextArea", + "Roo.form.TextField", + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Wrapper around the FCKEditor http://www.fckeditor.net", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "preventScrollbars", + "type" : "Boolean", + "desc" : "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)", + "memberOf" : "Roo.form.TextArea", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fck", + "type" : "Object", + "desc" : "BasePath", + "memberOf" : "Roo.form.FCKeditor", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.TextArea", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "The minimum height to allow when grow = true (defaults to 60)", + "memberOf" : "Roo.form.TextArea", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "The maximum height to allow when grow = true (defaults to 1000)", + "memberOf" : "Roo.form.TextArea", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "True if this field should automatically grow and shrink to its content", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.FCKeditor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.FCKeditor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.FCKeditor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autoSize", + "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextArea", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "selectText", + "desc" : "Selects text in this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "editorinit", + "desc" : "Fired when the editor is initialized - you can add extra handlers here..", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "FCKeditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "the", + "type" : "Object", + "desc" : "FCK object.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autosize", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.Field.json b/docs2/symbols/Roo.form.Field.json new file mode 100644 index 0000000000..4a3f792128 --- /dev/null +++ b/docs2/symbols/Roo.form.Field.json @@ -0,0 +1,1762 @@ +{ + "name" : "Roo.form.Field", + "augments" : [ + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Base class for form fields that provides default event handling, sizing, value handling and other functionality.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.FieldSet.json b/docs2/symbols/Roo.form.FieldSet.json new file mode 100644 index 0000000000..21b9c16723 --- /dev/null +++ b/docs2/symbols/Roo.form.FieldSet.json @@ -0,0 +1,894 @@ +{ + "name" : "Roo.form.FieldSet", + "augments" : [ + "Roo.form.Layout", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Creates a fieldset container for layout and rendering of fields in an {@link Roo.form.Form}.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "labelAlign", + "type" : "String", + "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "hideLabels", + "type" : "Boolean", + "desc" : "True to suppress the display of field labels in this layout (defaults to false)", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "legend", + "type" : "String", + "desc" : "The text to display as the legend for the FieldSet (defaults to '')", + "memberOf" : "Roo.form.FieldSet", + "values" : [ + ] + }, + { + "name" : "style", + "type" : "String/Object/Function", + "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "Fixed width in pixels of all field labels (defaults to undefined)", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "labelSeparator", + "type" : "String", + "desc" : "The separator to use after field labels (defaults to ':')", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec used to autocreate the fieldset (defaults to {tag: 'fieldset', cn: {tag:'legend'}})", + "memberOf" : "Roo.form.FieldSet", + "values" : [ + ] + }, + { + "name" : "clear", + "type" : "Boolean", + "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "addxtype", + "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Layout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.Form.json b/docs2/symbols/Roo.form.Form.json new file mode 100644 index 0000000000..b80963d813 --- /dev/null +++ b/docs2/symbols/Roo.form.Form.json @@ -0,0 +1,1444 @@ +{ + "name" : "Roo.form.Form", + "augments" : [ + "Roo.form.BasicForm", + "Roo.util.Observable" + ], + "desc" : "Adds the ability to dynamically render forms with JavaScript to {@link Roo.form.BasicForm}.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "labelAlign", + "type" : "String", + "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\").\nThis property cascades to child containers if not set.", + "memberOf" : "Roo.form.Form", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "formData", + "type" : "boolean|FormData", + "desc" : "- true to use new 'FormData' post, or set to a new FormData({dom form}) Object, if\nsending a formdata with extra parameters - eg uploaded elements.", + "memberOf" : "Roo.form.Form", + "values" : [ + ] + }, + { + "name" : "monitorValid", + "type" : "Boolean", + "desc" : "If true the form monitors its valid state client-side and\nfires a looping event with that state. This is required to bind buttons to the valid\nstate using the config value formBind:true on the button.", + "memberOf" : "Roo.form.Form", + "values" : [ + ] + }, + { + "name" : "fileUpload", + "type" : "Boolean", + "desc" : "Set to true if this form is a file upload.", + "memberOf" : "Roo.form.BasicForm", + "values" : [ + ] + }, + { + "name" : "progressUrl", + "type" : "String", + "desc" : "- Url to return progress data", + "memberOf" : "Roo.form.Form", + "values" : [ + ] + }, + { + "name" : "minButtonWidth", + "type" : "Number", + "desc" : "Minimum width of all buttons in pixels (defaults to 75)", + "memberOf" : "Roo.form.Form", + "values" : [ + ] + }, + { + "name" : "buttonAlign", + "type" : "String", + "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center\")", + "memberOf" : "Roo.form.Form", + "values" : [ + ] + }, + { + "name" : "method", + "type" : "String", + "desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.", + "memberOf" : "Roo.form.BasicForm", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "The width of labels. This property cascades to child containers.", + "memberOf" : "Roo.form.Form", + "values" : [ + ] + }, + { + "name" : "itemCls", + "type" : "String", + "desc" : "A css class to apply to the x-form-item of fields. This property cascades to child containers.", + "memberOf" : "Roo.form.Form", + "values" : [ + ] + }, + { + "name" : "timeout", + "type" : "Number", + "desc" : "Timeout for form actions in seconds (default is 30 seconds).", + "memberOf" : "Roo.form.BasicForm", + "values" : [ + ] + }, + { + "name" : "monitorPoll", + "type" : "Number", + "desc" : "The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)", + "memberOf" : "Roo.form.Form", + "values" : [ + ] + }, + { + "name" : "baseParams", + "type" : "Object", + "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.", + "memberOf" : "Roo.form.BasicForm", + "values" : [ + ] + }, + { + "name" : "trackResetOnLoad", + "type" : "Boolean", + "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.", + "memberOf" : "Roo.form.BasicForm", + "values" : [ + ] + }, + { + "name" : "reader", + "type" : "DataReader", + "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.", + "memberOf" : "Roo.form.BasicForm", + "values" : [ + ] + }, + { + "name" : "errorReader", + "type" : "DataReader", + "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.", + "memberOf" : "Roo.form.BasicForm", + "values" : [ + ] + }, + { + "name" : "url", + "type" : "String", + "desc" : "The URL to use for form actions if one isn't supplied in the action options.", + "memberOf" : "Roo.form.BasicForm", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "addxtype", + "desc" : "Adds a series of form elements (using the xtype property as the factory method.\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column, (and 'end' to close a block)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fieldset", + "desc" : "Opens a new {@link Roo.form.FieldSet} container in the layout stack. If fields are passed after the config, the\nfields are added and the fieldset is closed. If no fields are passed the fieldset remains open\nuntil end() is called.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "The config to pass to the fieldset", + "isOptional" : false + }, + { + "name" : "field1", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + }, + { + "name" : "field2", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + }, + { + "name" : "etc", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "FieldSet The fieldset container object" + } + ] + }, + { + "name" : "start", + "desc" : "Opens the passed container in the layout stack. The container can be any {@link Roo.form.Layout} or subclass.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "Object", + "desc" : "A Roo.form.Layout or subclass of Layout", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Form", + "desc" : "this" + } + ] + }, + { + "name" : "container", + "desc" : "Opens a new {@link Roo.form.Layout} container in the layout stack. If fields are passed after the config, the\nfields are added and the container is closed. If no fields are passed the container remains open\nuntil end() is called.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "The config to pass to the Layout", + "isOptional" : false + }, + { + "name" : "field1", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + }, + { + "name" : "field2", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + }, + { + "name" : "etc", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Layout The container object" + } + ] + }, + { + "name" : "render", + "desc" : "Render this form into the passed container. This should only be called once!", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "The element this component should be rendered into", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Form", + "desc" : "this" + } + ] + }, + { + "name" : "startMonitoring", + "desc" : "Starts monitoring of the valid state of this form. Usually this is done by passing the config\noption \"monitorValid\"", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "addButton", + "desc" : "Adds a button to the footer of the form - this must be called before the form is rendered.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "String/Object", + "desc" : "A string becomes the button text, an object can either be a Button config\nobject or a valid Roo.DomHelper element config", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The function called when the button is clicked", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the handler function", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Button", + "desc" : "" + } + ] + }, + { + "name" : "stopMonitoring", + "desc" : "Stops monitoring of the valid state of this form", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "add", + "desc" : "Add Roo.form components to the current open container (e.g. column, fieldset, etc.). Fields added via this method\ncan also be passed with an additional property of fieldLabel, which if supplied, will provide the text to display\nas the label of the field.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "field1", + "type" : "Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "field2", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Form", + "desc" : "this" + } + ] + }, + { + "name" : "findbyId", + "desc" : "Find any element that has been added to a form, using it's ID or name\nThis can include framesets, columns etc. along with regular fields..", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "- id or name to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "e - or false if nothing found." + } + ] + }, + { + "name" : "column", + "desc" : "Opens a new {@link Roo.form.Column} container in the layout stack. If fields are passed after the config, the\nfields are added and the column is closed. If no fields are passed the column remains open\nuntil end() is called.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "The config to pass to the column", + "isOptional" : false + }, + { + "name" : "field1", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + }, + { + "name" : "field2", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + }, + { + "name" : "etc", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Column The column container object" + } + ] + }, + { + "name" : "end", + "desc" : "Closes the current open container", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Form", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Form", + "desc" : "this" + } + ] + }, + { + "name" : "remove", + "desc" : "Removes a field from the items collection (does NOT remove its markup).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "field", + "type" : "Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "loadRecord", + "desc" : "Loads an Roo.data.Record into this form.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "record", + "type" : "Record", + "desc" : "The record to load", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "load", + "desc" : "Shortcut to do a load action.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "The options to pass to the action (see {@link #doAction} for details)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "doAction", + "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "actionName", + "type" : "String", + "desc" : "The name of the action type", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n
\nProperty          Type             Description\n----------------  ---------------  ----------------------------------------------------------------------------------\nurl               String           The url for the action (defaults to the form's url)\nmethod            String           The form method to use (defaults to the form's method, or POST if not defined)\nparams            String/Object    The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation  Boolean          Applies to submit only.  Pass true to call form.isValid() prior to posting to\n                                   validate the form on the client (defaults to false)\n
", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "getValues", + "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "asString", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clears all invalid messages in this form.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "isDirty", + "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] + }, + { + "name" : "updateRecord", + "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "record", + "type" : "Record", + "desc" : "The record to edit", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "hasChanged", + "desc" : "Returns true if any fields in this form have changed since their original load. (New version)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] + }, + { + "name" : "applyToFields", + "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "values", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "getFieldValues", + "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] + }, + { + "name" : "submit", + "desc" : "Shortcut to do a submit action.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "The options to pass to the action (see {@link #doAction} for details)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark fields in this form invalid in bulk.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "errors", + "type" : "Array/Object", + "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "setValues", + "desc" : "Set values for fields in this form in bulk.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "values", + "type" : "Array/Object", + "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "isValid", + "desc" : "Returns true if client-side validation on the form is successful.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] + }, + { + "name" : "applyIfToFields", + "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "values", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "findField", + "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The value to search for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Field" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets this form.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] + }, + { + "name" : "addForm", + "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "form", + "type" : "Roo.form.Form", + "desc" : "to add.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "rendered", + "desc" : "Fires when the form is rendered", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "form", + "type" : "Roo.form.Form", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clientvalidation", + "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "valid", + "type" : "Boolean", + "desc" : "true if the form has passed client-side validation", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeaction", + "desc" : "Fires before any action is performed. Return false to cancel the action.", + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "action", + "type" : "Action", + "desc" : "The action to be performed", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "actioncomplete", + "desc" : "Fires when an action is completed.", + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "action", + "type" : "Action", + "desc" : "The action that completed", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "actionfailed", + "desc" : "Fires when an action fails.", + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "action", + "type" : "Action", + "desc" : "The action that failed", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.GridField.json b/docs2/symbols/Roo.form.GridField.json new file mode 100644 index 0000000000..d260e3cefe --- /dev/null +++ b/docs2/symbols/Roo.form.GridField.json @@ -0,0 +1,1779 @@ +{ + "name" : "Roo.form.GridField", + "augments" : [ + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Embed a grid (or editable grid into a form)\nSTATUS ALPHA\n\nThis embeds a grid in a form, the value of the field should be the json encoded array of rows\nit needs \nxgrid.store = Roo.data.Store\nxgrid.store.proxy = Roo.data.MemoryProxy (data = [] )\nxgrid.store.reader = Roo.data.JsonReader", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "xgrid", + "type" : "Object", + "desc" : "(xtype'd description of grid) { xtype : 'Grid', dataSource: .... }\n\n}", + "memberOf" : "Roo.form.GridField", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.GridField", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "- used to restrict width of grid..", + "memberOf" : "Roo.form.GridField", + "values" : [ + ] + }, + { + "name" : "addTitle", + "type" : "String", + "desc" : "Text to include for adding a title.", + "memberOf" : "Roo.form.GridField", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "- used to restrict height of grid..", + "memberOf" : "Roo.form.GridField", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "setValue", + "desc" : "Sets the value of the item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.GridField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "either", + "type" : "String", + "desc" : "an object or a string..", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.Hidden.json b/docs2/symbols/Roo.form.Hidden.json new file mode 100644 index 0000000000..0ec68251e4 --- /dev/null +++ b/docs2/symbols/Roo.form.Hidden.json @@ -0,0 +1,1996 @@ +{ + "name" : "Roo.form.Hidden", + "augments" : [ + "Roo.form.TextField", + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Simple Hidden element used on forms \n\nusage: form.add(new Roo.form.HiddenField({ 'name' : 'test1' }));", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "The minimum width to allow when grow = true (defaults to 30)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "The maximum width to allow when grow = true (defaults to 800)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "True if this field should automatically grow and shrink to its content", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "selectText", + "desc" : "Selects text in this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "autoSize", + "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "autosize", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.HtmlEditor.ToolbarContext.json b/docs2/symbols/Roo.form.HtmlEditor.ToolbarContext.json new file mode 100644 index 0000000000..9c3993db4f --- /dev/null +++ b/docs2/symbols/Roo.form.HtmlEditor.ToolbarContext.json @@ -0,0 +1,47 @@ +{ + "name" : "Roo.form.HtmlEditor.ToolbarContext", + "augments" : [ + ], + "desc" : "Context Toolbar\n\nUsage:\n\n new Roo.form.HtmlEditor({\n ....\n toolbars : [\n { xtype: 'ToolbarStandard', styles : {} }\n { xtype: 'ToolbarContext', disable : {} }\n ]\n})", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "disable", + "type" : "Object", + "desc" : "List of toolbar elements to disable", + "memberOf" : "Roo.form.HtmlEditor.ToolbarContext", + "values" : [ + ] + }, + { + "name" : "styles", + "type" : "Object", + "desc" : "List of styles \n eg. { '*' : [ 'headline' ] , 'TD' : [ 'underline', 'double-underline' ] } \n\nThese must be defined in the page, so they get rendered correctly..\n.headline { }\nTD.underline { }", + "memberOf" : "Roo.form.HtmlEditor.ToolbarContext", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "updateToolbar", + "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.\n\nNote you can force an update by calling on('editorevent', scope, false)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.HtmlEditor.ToolbarContext", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.HtmlEditor.ToolbarStandard.json b/docs2/symbols/Roo.form.HtmlEditor.ToolbarStandard.json new file mode 100644 index 0000000000..e3f8ec553c --- /dev/null +++ b/docs2/symbols/Roo.form.HtmlEditor.ToolbarStandard.json @@ -0,0 +1,79 @@ +{ + "name" : "Roo.form.HtmlEditor.ToolbarStandard", + "augments" : [ + ], + "desc" : "Basic Toolbar\n\nUsage:\n\n new Roo.form.HtmlEditor({\n ....\n toolbars : [\n new Roo.form.HtmlEditorToolbar1({\n disable : { fonts: 1 , format: 1, ..., ... , ...],\n btns : [ .... ]\n })\n }", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "createLinkText", + "type" : "String", + "desc" : "The default text for the create link prompt", + "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard", + "values" : [ + ] + }, + { + "name" : "btns", + "type" : "Array", + "desc" : "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }", + "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard", + "values" : [ + ] + }, + { + "name" : "defaultFont", + "type" : "String", + "desc" : "default font to use.", + "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard", + "values" : [ + ] + }, + { + "name" : "defaultLinkValue", + "type" : "String", + "desc" : "The default value for the create link prompt (defaults to http:/ /)", + "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard", + "values" : [ + ] + }, + { + "name" : "fontFamilies", + "type" : "Array", + "desc" : "An array of available font families", + "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard", + "values" : [ + ] + }, + { + "name" : "disable", + "type" : "Object", + "desc" : "List of elements to disable..", + "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "updateToolbar", + "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.HtmlEditor.json b/docs2/symbols/Roo.form.HtmlEditor.json new file mode 100644 index 0000000000..fd8253c143 --- /dev/null +++ b/docs2/symbols/Roo.form.HtmlEditor.json @@ -0,0 +1,2001 @@ +{ + "name" : "Roo.form.HtmlEditor", + "augments" : [ + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Provides a lightweight HTML Editor component.\n\nThis has been tested on Fireforx / Chrome.. IE may not be so great..\n\n

Note: The focus/blur and validation marking functionality inherited from Ext.form.Field is NOT\nsupported by this editor.

\nAn Editor is a sensitive component that can't be used in all spots standard fields can be used. Putting an Editor within\nany element that has display set to 'none' can cause problems in Safari and Firefox.

", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "whitelist", + "type" : "Array", + "desc" : "of html tags - in addition to statndard whitelist", + "memberOf" : "Roo.form.HtmlEditor", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "toolbars", + "type" : "Array", + "desc" : "Array of toolbars. - defaults to just the Standard one", + "memberOf" : "Roo.form.HtmlEditor", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "(in pixels)", + "memberOf" : "Roo.form.HtmlEditor", + "values" : [ + ] + }, + { + "name" : "resizable", + "type" : "String", + "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.", + "memberOf" : "Roo.form.HtmlEditor", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "(in pixels)", + "memberOf" : "Roo.form.HtmlEditor", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "stylesheets", + "type" : "Array", + "desc" : "url of stylesheets. set to [] to disable stylesheets.", + "memberOf" : "Roo.form.HtmlEditor", + "values" : [ + ] + }, + { + "name" : "blacklist", + "type" : "Array", + "desc" : "of html tags - in addition to standard blacklist.", + "memberOf" : "Roo.form.HtmlEditor", + "values" : [ + ] + }, + { + "name" : "clearUp", + "type" : "Boolean", + "desc" : "", + "memberOf" : "Roo.form.HtmlEditor", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "createToolbar", + "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.HtmlEditor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "editor", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "markInvalid", + "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.HtmlEditor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "toggleSourceEdit", + "desc" : "Toggles the editor between standard and source edit mode.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.HtmlEditor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "sourceEdit", + "type" : "Boolean", + "desc" : "(optional) True for source edit, false for standard", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.HtmlEditor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "blur", + "desc" : "", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "editmodechange", + "desc" : "Fires when the editor switches edit modes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "sourceEdit", + "type" : "Boolean", + "desc" : "True if source edit, false if standard editing.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "firstfocus", + "desc" : "Fires when on first focus - needed by toolbars..", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "initialize", + "desc" : "Fires when the editor is fully initialized (including the iframe)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "autosave", + "desc" : "Auto save the htmlEditor value as a file into Events", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "push", + "desc" : "Fires when the iframe editor is updated with content from the textarea.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "editorevent", + "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforepush", + "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "sync", + "desc" : "Fires when the textarea is updated with content from the editor iframe.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "savedpreview", + "desc" : "preview the saved version of htmlEditor", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "stylesheetsclick", + "desc" : "Fires when press the Sytlesheets button", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.HtmlEditorCore", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforesync", + "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.Layout.json b/docs2/symbols/Roo.form.Layout.json new file mode 100644 index 0000000000..95003a7566 --- /dev/null +++ b/docs2/symbols/Roo.form.Layout.json @@ -0,0 +1,885 @@ +{ + "name" : "Roo.form.Layout", + "augments" : [ + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Creates a container for layout and rendering of fields in an {@link Roo.form.Form}.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "labelAlign", + "type" : "String", + "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "hideLabels", + "type" : "Boolean", + "desc" : "True to suppress the display of field labels in this layout (defaults to false)", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String/Object/Function", + "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "Fixed width in pixels of all field labels (defaults to undefined)", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "labelSeparator", + "type" : "String", + "desc" : "The separator to use after field labels (defaults to ':')", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "clear", + "type" : "Boolean", + "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "addxtype", + "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Layout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.MonthField.json b/docs2/symbols/Roo.form.MonthField.json new file mode 100644 index 0000000000..a6c0887d8e --- /dev/null +++ b/docs2/symbols/Roo.form.MonthField.json @@ -0,0 +1,2124 @@ +{ + "name" : "Roo.form.MonthField", + "augments" : [ + "Roo.form.TriggerField", + "Roo.form.TextField", + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Provides a date input field with a {@link Roo.DatePicker} dropdown and automatic date validation.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be appended if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).", + "memberOf" : "Roo.form.MonthField", + "values" : [ + ] + }, + { + "name" : "useIso", + "type" : "Boolean", + "desc" : "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (true)", + "memberOf" : "Roo.form.MonthField", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disabledDates", + "type" : "Array", + "desc" : "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n
    \n
  • [\"03/08/2003\", \"09/16/2003\"] would disable those exact dates
  • \n
  • [\"03/08\", \"09/16\"] would disable those days for every year
  • \n
  • [\"^03/08\"] would only match the beginning (useful if you are using short years)
  • \n
  • [\"03/../2006\"] would disable every day in March 2006
  • \n
  • [\"^03\"] would disable every day in every March
  • \n
\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].", + "memberOf" : "Roo.form.MonthField", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "maxValue", + "type" : "Date/String", + "desc" : "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).", + "memberOf" : "Roo.form.MonthField", + "values" : [ + ] + }, + { + "name" : "altFormats", + "type" : "String", + "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').", + "memberOf" : "Roo.form.MonthField", + "values" : [ + ] + }, + { + "name" : "minValue", + "type" : "Date/String", + "desc" : "The minimum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).", + "memberOf" : "Roo.form.MonthField", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "disabledDaysText", + "type" : "String", + "desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')", + "memberOf" : "Roo.form.MonthField", + "values" : [ + ] + }, + { + "name" : "minText", + "type" : "String", + "desc" : "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').", + "memberOf" : "Roo.form.MonthField", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "disabledDatesText", + "type" : "String", + "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')", + "memberOf" : "Roo.form.MonthField", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "disabledDays", + "type" : "Array", + "desc" : "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).", + "memberOf" : "Roo.form.MonthField", + "values" : [ + ] + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "Roo.form.TriggerField", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.MonthField", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "format", + "type" : "String", + "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').", + "memberOf" : "Roo.form.MonthField", + "values" : [ + ] + }, + { + "name" : "maxTextf", + "type" : "String", + "desc" : "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').", + "memberOf" : "Roo.form.MonthField", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to display when the date in the field is invalid (defaults to\n'{value} is not a valid date - it must be in the format {format}').", + "memberOf" : "Roo.form.MonthField", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getValue", + "desc" : "Returns the current date value of the date field.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.MonthField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Date", + "desc" : "The date value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using MonthField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n
Usage:\n
\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\nmonthField.setValue(dt);\n\n//Pass a date string (default format):\nmonthField.setValue('5/4/06');\n\n//Pass a date string (custom format):\nmonthField.format = 'Y-m-d';\nmonthField.setValue('2006-5-4');\n
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.MonthField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "date", + "type" : "String/Date", + "desc" : "The date or valid date string", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "onTriggerClick", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autoSize", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "selectText", + "desc" : "Selects text in this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "select", + "desc" : "Fires when a date is selected", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.MonthFieeld", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Date", + "desc" : "The date selected", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autosize", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.NumberField.json b/docs2/symbols/Roo.form.NumberField.json new file mode 100644 index 0000000000..d23d257350 --- /dev/null +++ b/docs2/symbols/Roo.form.NumberField.json @@ -0,0 +1,2068 @@ +{ + "name" : "Roo.form.NumberField", + "augments" : [ + "Roo.form.TextField", + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Numeric text field that provides automatic keystroke filtering and numeric validation.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "nanText", + "type" : "String", + "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")", + "memberOf" : "Roo.form.NumberField", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "maxValue", + "type" : "Number", + "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.NumberField", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "minValue", + "type" : "Number", + "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)", + "memberOf" : "Roo.form.NumberField", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "decimalPrecision", + "type" : "Number", + "desc" : "The maximum precision to display after the decimal separator (defaults to 2)", + "memberOf" : "Roo.form.NumberField", + "values" : [ + ] + }, + { + "name" : "minText", + "type" : "String", + "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")", + "memberOf" : "Roo.form.NumberField", + "values" : [ + ] + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "allowDecimals", + "type" : "Boolean", + "desc" : "False to disallow decimal values (defaults to true)", + "memberOf" : "Roo.form.NumberField", + "values" : [ + ] + }, + { + "name" : "allowNegative", + "type" : "Boolean", + "desc" : "False to prevent entering a negative sign (defaults to true)", + "memberOf" : "Roo.form.NumberField", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field x-form-num-field\")", + "memberOf" : "Roo.form.NumberField", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "The minimum width to allow when grow = true (defaults to 30)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "decimalSeparator", + "type" : "String", + "desc" : "Character(s) to allow as the decimal separator (defaults to '.')", + "memberOf" : "Roo.form.NumberField", + "values" : [ + ] + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "The maximum width to allow when grow = true (defaults to 800)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "True if this field should automatically grow and shrink to its content", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "maxText", + "type" : "String", + "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")", + "memberOf" : "Roo.form.NumberField", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "selectText", + "desc" : "Selects text in this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "autoSize", + "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "autosize", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.Radio.json b/docs2/symbols/Roo.form.Radio.json new file mode 100644 index 0000000000..461068ea4a --- /dev/null +++ b/docs2/symbols/Roo.form.Radio.json @@ -0,0 +1,1848 @@ +{ + "name" : "Roo.form.Radio", + "augments" : [ + "Roo.form.Checkbox", + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Single radio field. Same as Checkbox, but provided as a convenience for automatically setting the input type.\nRadio grouping is handled automatically by the browser if you give each radio in a group the same name.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "inputValue", + "type" : "String", + "desc" : "The value that should go into the generated input element's value attribute", + "memberOf" : "Roo.form.Checkbox", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.Checkbox", + "values" : [ + ] + }, + { + "name" : "valueOff", + "type" : "String", + "desc" : "The value that should go into the generated input element's value when unchecked.", + "memberOf" : "Roo.form.Checkbox", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "boxLabel", + "type" : "String", + "desc" : "The text that appears beside the checkbox", + "memberOf" : "Roo.form.Checkbox", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Checkbox", + "values" : [ + ] + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "True if the the checkbox should render already checked (defaults to false)", + "memberOf" : "Roo.form.Checkbox", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)", + "memberOf" : "Roo.form.Checkbox", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getGroupValue", + "desc" : "If this radio is part of a group, it will return the selected value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Radio", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Checkbox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean/String", + "desc" : "- the value to set", + "isOptional" : false + }, + { + "name" : "suppressEvent", + "type" : "Boolean/String", + "desc" : "- whether to suppress the checkchange event.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Returns the checked state of the checkbox.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Checkbox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if checked, else false" + } + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "check", + "desc" : "Fires when the checkbox is checked or unchecked.", + "memberOf" : "Roo.form.Checkbox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Checkbox", + "desc" : "This checkbox", + "isOptional" : false + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "The new checked value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.Row.json b/docs2/symbols/Roo.form.Row.json new file mode 100644 index 0000000000..f7933c52a8 --- /dev/null +++ b/docs2/symbols/Roo.form.Row.json @@ -0,0 +1,902 @@ +{ + "name" : "Roo.form.Row", + "augments" : [ + "Roo.form.Layout", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Creates a row container for layout and rendering of fields in an {@link Roo.form.Form}.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "labelAlign", + "type" : "String", + "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "hideLabels", + "type" : "Boolean", + "desc" : "True to suppress the display of field labels in this layout (defaults to false)", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "style", + "type" : "String/Object/Function", + "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "Fixed width in pixels of all field labels (defaults to undefined)", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "labelSeparator", + "type" : "String", + "desc" : "The separator to use after field labels (defaults to ':')", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "clear", + "type" : "Boolean", + "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)", + "memberOf" : "Roo.form.Layout", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number/String", + "desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")", + "memberOf" : "Roo.form.Row", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number/String", + "desc" : "The fixed height of the column in pixels or CSS value (defaults to \"auto\")", + "memberOf" : "Roo.form.Row", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "addxtype", + "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Layout", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.Select.json b/docs2/symbols/Roo.form.Select.json new file mode 100644 index 0000000000..4bca175390 --- /dev/null +++ b/docs2/symbols/Roo.form.Select.json @@ -0,0 +1,2520 @@ +{ + "name" : "Roo.form.Select", + "augments" : [ + "Roo.form.TriggerField", + "Roo.form.TextField", + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "A combobox control with support for autocomplete, remote-loading, paging and many other features.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be appended if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "pageSize", + "type" : "Number", + "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "title", + "type" : "String", + "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "queryParam", + "type" : "String", + "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "resizable", + "type" : "Boolean", + "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "editable", + "type" : "Boolean", + "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "listWidth", + "type" : "Number", + "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tpl", + "type" : "String/Roo.Template", + "desc" : "The template to use to render the output", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "typeAheadDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "disableClear", + "type" : "Boolean", + "desc" : "Disable showing of clear button.", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "The data store to which this combo is bound (defaults to undefined)", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "defaultValue", + "type" : "String", + "desc" : "The value displayed after loading the store.", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "allQuery", + "type" : "String", + "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "minListWidth", + "type" : "Number", + "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "alwaysQuery", + "type" : "Boolean", + "desc" : "Disable caching of results, and always send query", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "valueNotFoundText", + "type" : "String", + "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "displayField", + "type" : "String", + "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "hiddenName", + "type" : "String", + "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "selectedClass", + "type" : "String", + "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "Roo.form.TriggerField", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "listAlign", + "type" : "String", + "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "forceSelection", + "type" : "Boolean", + "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "typeAhead", + "type" : "Boolean", + "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "triggerAction", + "type" : "String", + "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "Boolean/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "minChars", + "type" : "Number", + "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "blockFocus", + "type" : "Boolean", + "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "transform", + "type" : "String/HTMLElement/Element", + "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "listClass", + "type" : "String", + "desc" : "CSS class to apply to the dropdown list element (defaults to '')", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "handleHeight", + "type" : "Number", + "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "queryDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "mode", + "type" : "String", + "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maxHeight", + "type" : "Number", + "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "valueField", + "type" : "String", + "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "loadingText", + "type" : "String", + "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "lazyRender", + "type" : "Boolean", + "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)", + "memberOf" : "Roo.form.Select", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "select", + "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Select", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The zero-based index of the list item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collapse", + "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Select", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "clearValue", + "desc" : "Clears any text/value currently set in the field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Select", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "selectByValue", + "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Select", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The data value of the item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value matched an item in the list, else false" + } + ] + }, + { + "name" : "isExpanded", + "desc" : "Returns true if the dropdown list is expanded, else false.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Select", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Returns the currently selected field value or empty string if no value is set.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Select", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "value The selected value" + } + ] + }, + { + "name" : "setFromData", + "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Select", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Object", + "desc" : "the value to set as. or false on reset?", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setValue", + "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Select", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value to match", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setWidth", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Select", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setEditable", + "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Select", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean", + "desc" : "True to allow the user to directly edit the field text", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "doQuery", + "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Select", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "query", + "type" : "String", + "desc" : "The SQL query to execute", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "expand", + "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Select", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "onTriggerClick", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autoSize", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "selectText", + "desc" : "Selects text in this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "autosize", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.Signature.json b/docs2/symbols/Roo.form.Signature.json new file mode 100644 index 0000000000..86eccd1415 --- /dev/null +++ b/docs2/symbols/Roo.form.Signature.json @@ -0,0 +1,1929 @@ +{ + "name" : "Roo.form.Signature", + "augments" : [ + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Signature field.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to false)", + "memberOf" : "Roo.form.Signature", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The signature panel width (defaults to 300)", + "memberOf" : "Roo.form.Signature", + "values" : [ + ] + }, + { + "name" : "labels", + "type" : "Object", + "desc" : "Label to use when rendering a form.\ndefaults to \nlabels : { \n clear : \"Clear\",\n confirm : \"Confirm\"\n }", + "memberOf" : "Roo.form.Signature", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The signature panel height (defaults to 100)", + "memberOf" : "Roo.form.Signature", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getImageDataURI", + "desc" : "when user is clicked confirm then show this image.....", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Signature", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "Image Data URI" + } + ] + }, + { + "name" : "getConfirmed", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Signature", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "this.isConfirmed" + } + ] + }, + { + "name" : "getHeight", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Signature", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "this.height" + } + ] + }, + { + "name" : "createToolbar", + "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Signature", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "editor", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getWidth", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Signature", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "this.width" + } + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "confirm", + "desc" : "Fires when the 'confirm' icon is pressed (add a listener to enable add button)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.Signature", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "reset", + "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record|false", + "desc" : "The data record returned from the underlying store (or false on nothing selected)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.TextArea.json b/docs2/symbols/Roo.form.TextArea.json new file mode 100644 index 0000000000..747c907fed --- /dev/null +++ b/docs2/symbols/Roo.form.TextArea.json @@ -0,0 +1,2004 @@ +{ + "name" : "Roo.form.TextArea", + "augments" : [ + "Roo.form.TextField", + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Multiline text field. Can be used as a direct replacement for traditional textarea fields, plus adds\nsupport for auto-sizing.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "preventScrollbars", + "type" : "Boolean", + "desc" : "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)", + "memberOf" : "Roo.form.TextArea", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.TextArea", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "The minimum height to allow when grow = true (defaults to 60)", + "memberOf" : "Roo.form.TextArea", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "The maximum height to allow when grow = true (defaults to 1000)", + "memberOf" : "Roo.form.TextArea", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "True if this field should automatically grow and shrink to its content", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "autoSize", + "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextArea", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "selectText", + "desc" : "Selects text in this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "autosize", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.TextField.json b/docs2/symbols/Roo.form.TextField.json new file mode 100644 index 0000000000..067440c44d --- /dev/null +++ b/docs2/symbols/Roo.form.TextField.json @@ -0,0 +1,1995 @@ +{ + "name" : "Roo.form.TextField", + "augments" : [ + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Basic text field. Can be used as a direct replacement for traditional text inputs, or as the base\nclass for more sophisticated input controls (like {@link Roo.form.TextArea} and {@link Roo.form.ComboBox}).", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "growMin", + "type" : "Number", + "desc" : "The minimum width to allow when grow = true (defaults to 30)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "growMax", + "type" : "Number", + "desc" : "The maximum width to allow when grow = true (defaults to 800)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "grow", + "type" : "Boolean", + "desc" : "True if this field should automatically grow and shrink to its content", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "selectText", + "desc" : "Selects text in this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "autoSize", + "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "autosize", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.TriggerField.json b/docs2/symbols/Roo.form.TriggerField.json new file mode 100644 index 0000000000..fc622bb93f --- /dev/null +++ b/docs2/symbols/Roo.form.TriggerField.json @@ -0,0 +1,2010 @@ +{ + "name" : "Roo.form.TriggerField", + "augments" : [ + "Roo.form.TextField", + "Roo.form.Field", + "Roo.BoxComponent", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Provides a convenient wrapper for TextFields that adds a clickable trigger button (looks like a combobox by default).\nThe trigger has no default action, so you must assign a function to implement the trigger click handler by\noverriding {@link #onTriggerClick}. You can create a TriggerField directly, as it renders exactly like a combobox\nfor which you can provide a custom implementation. For example:\n
\nvar trigger = new Roo.form.TriggerField();\ntrigger.onTriggerClick = myTriggerFn;\ntrigger.applyTo('my-field');\n
\n\nHowever, in general you will most likely want to use TriggerField as the base class for a reusable component.\n{@link Roo.form.DateField} and {@link Roo.form.ComboBox} are perfect examples of this.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "triggerClass", + "type" : "String", + "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be appended if specified.", + "memberOf" : "Roo.form.TriggerField", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "disableKeyFilter", + "type" : "Boolean", + "desc" : "True to disable input keystroke filtering (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "True to disable the field (defaults to false).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validator", + "type" : "Function", + "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "name", + "type" : "String", + "desc" : "The field's HTML name attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "width (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "regexText", + "type" : "String", + "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "height", + "type" : "Number", + "desc" : "height (optional) size of component", + "memberOf" : "Roo.BoxComponent", + "values" : [ + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "A value to initialize this field with.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "emptyText", + "type" : "String", + "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "msgFx", + "type" : "String", + "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "msgTarget", + "type" : "String", + "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maxLengthText", + "type" : "String", + "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "minLengthText", + "type" : "String", + "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "readOnly", + "type" : "Boolean", + "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "focusClass", + "type" : "String", + "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "validateOnBlur", + "type" : "Boolean", + "desc" : "Whether the field should validate when it loses focus (defaults to true).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "hideTrigger", + "type" : "Boolean", + "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", + "memberOf" : "Roo.form.TriggerField", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A CSS class to apply to the field's underlying element.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "inputType", + "type" : "String", + "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldClass", + "type" : "String", + "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "autoCreate", + "type" : "String/Object", + "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"16\", autocomplete: \"off\"})", + "memberOf" : "Roo.form.TriggerField", + "values" : [ + ] + }, + { + "name" : "invalidClass", + "type" : "String", + "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maskRe", + "type" : "String", + "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "vtype", + "type" : "String", + "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "validationEvent", + "type" : "String/Boolean", + "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "fieldLabel", + "type" : "String", + "desc" : "Label to use when rendering a form.", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "blankText", + "type" : "String", + "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "validationDelay", + "type" : "Number", + "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "selectOnFocus", + "type" : "Boolean", + "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "tabIndex", + "type" : "Number", + "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "regex", + "type" : "RegExp", + "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "minLength", + "type" : "Number", + "desc" : "Minimum input field length required (defaults to 0)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "False to validate that the value length > 0 (defaults to true)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "Mouse over tip", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + }, + { + "name" : "maxLength", + "type" : "Number", + "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", + "memberOf" : "Roo.form.TextField", + "values" : [ + ] + }, + { + "name" : "invalidText", + "type" : "String", + "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", + "memberOf" : "Roo.form.Field", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "onTriggerClick", + "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autoSize", + "desc" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TriggerField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "selectText", + "desc" : "Selects text in this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validateValue", + "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "reset", + "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "validate", + "desc" : "Validates the field value", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "getValue", + "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "setValue", + "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getName", + "desc" : "Returns the name attribute of the field if available", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] + }, + { + "name" : "markInvalid", + "desc" : "Mark this field as invalid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getRawValue", + "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] + }, + { + "name" : "applyTo", + "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] + }, + { + "name" : "resetHasChanged", + "desc" : "stores the current value in loadedValue", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isDirty", + "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRawValue", + "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearInvalid", + "desc" : "Clear any invalid styles/messages for this field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isValid", + "desc" : "Returns whether or not the field value is currently valid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] + }, + { + "name" : "hasChanged", + "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "updateBox", + "desc" : "Sets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPagePosition", + "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "syncSize", + "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] + }, + { + "name" : "getPosition", + "desc" : "Gets the current XY position of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] + }, + { + "name" : "onResize", + "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getBox", + "desc" : "Gets the current box measurements of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSize", + "desc" : "Gets the current size of the component's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] + }, + { + "name" : "onPosition", + "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setPosition", + "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "autosize", + "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "blur", + "desc" : "Fires when this field loses input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "valid", + "desc" : "Fires after the field has been validated with no errors.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focus", + "desc" : "Fires when this field receives input focus.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keyup", + "desc" : "Fires after the key up", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "invalid", + "desc" : "Fires after the field has been marked as invalid.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "change", + "desc" : "Fires just before the field blurs if the field value has changed.", + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires after the component is moved.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "resize", + "desc" : "Fires after the component is resized.", + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.VTypes.json b/docs2/symbols/Roo.form.VTypes.json new file mode 100644 index 0000000000..a0f6470eda --- /dev/null +++ b/docs2/symbols/Roo.form.VTypes.json @@ -0,0 +1,103 @@ +{ + "name" : "Roo.form.VTypes", + "augments" : [ + ], + "desc" : "Overridable validation definitions. The validations provided are basic and intended to be easily customizable and extended.", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "email'", + "desc" : "The function used to validate email addresses", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.VTypes", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The email address", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "url'", + "desc" : "The function used to validate URLs", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.VTypes", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The URL", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "alpha'", + "desc" : "The function used to validate alpha values", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.VTypes", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "alphanum'", + "desc" : "The function used to validate alphanumeric values", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.form.VTypes", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.form.json b/docs2/symbols/Roo.form.json new file mode 100644 index 0000000000..dcec9316b4 --- /dev/null +++ b/docs2/symbols/Roo.form.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.form", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.grid.AbstractGridView.json b/docs2/symbols/Roo.grid.AbstractGridView.json new file mode 100644 index 0000000000..60d55903ea --- /dev/null +++ b/docs2/symbols/Roo.grid.AbstractGridView.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.grid.AbstractGridView", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.grid.AbstractSelectionModel.json b/docs2/symbols/Roo.grid.AbstractSelectionModel.json new file mode 100644 index 0000000000..1b7b0adc07 --- /dev/null +++ b/docs2/symbols/Roo.grid.AbstractSelectionModel.json @@ -0,0 +1,379 @@ +{ + "name" : "Roo.grid.AbstractSelectionModel", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "Abstract base class for grid SelectionModels. It provides the interface that should be\nimplemented by descendant classes. This class should not be directly instantiated.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "lock", + "desc" : "Locks the selections.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isLocked", + "desc" : "Returns true if the selections are locked.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "unlock", + "desc" : "Unlocks the selections.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.grid.Calendar.json b/docs2/symbols/Roo.grid.Calendar.json new file mode 100644 index 0000000000..32d3c39182 --- /dev/null +++ b/docs2/symbols/Roo.grid.Calendar.json @@ -0,0 +1,991 @@ +{ + "name" : "Roo.grid.Calendar", + "augments" : [ + ], + "desc" : "This class extends the Grid to provide a calendar widget\n

Usage:
\n var grid = new Roo.grid.Calendar(\"my-container-id\", {\n     ds: myDataStore,\n     cm: myColModel,\n     selModel: mySelectionModel,\n     autoSizeColumns: true,\n     monitorWindowResize: false,\n     trackMouseOver: true\n     eventstore : real data store..\n });\n // set any options\n grid.render();",
+  "isSingleton" : false,
+  "isStatic" : true,
+  "isBuiltin" : false,
+  "config" : [
+    {
+      "name" : "eventStore",
+      "type" : "Store",
+      "desc" : "The store that loads events.",
+      "memberOf" : "Roo.grid.Calendar",
+      "values" : [
+      ]
+    }
+  ],
+  "methods" : [
+    {
+      "name" : "getSelectionModel",
+      "desc" : "Returns the grid's SelectionModel.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.grid.Calendar",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "SelectionModel",
+          "desc" : ""
+        }
+      ]
+    }
+  ],
+  "events" : [
+    {
+      "name" : "eventclick",
+      "desc" : "Fires when the mouse click an",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Calendar",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "",
+          "type" : "event",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "select",
+      "desc" : "Fires when a date is selected",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "DatePicker",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "date",
+          "type" : "Date",
+          "desc" : "The selected date",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "mouseout",
+      "desc" : "The raw mouseout event for the entire grid.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "monthchange",
+      "desc" : "Fires when the displayed month changes",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "DatePicker",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "date",
+          "type" : "Date",
+          "desc" : "The selected month",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "dragdrop",
+      "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "dd",
+          "type" : "Roo.GridDD",
+          "desc" : "The drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "targetId",
+          "type" : "String",
+          "desc" : "The target drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "event",
+          "desc" : "The raw browser event",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "rowclick",
+      "desc" : "Fires when a row is clicked",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "rowIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "headerclick",
+      "desc" : "Fires when a header is clicked",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "columnIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "startdrag",
+      "desc" : "Fires when row(s) start being dragged",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "dd",
+          "type" : "Roo.GridDD",
+          "desc" : "The drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "event",
+          "desc" : "The raw browser event",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "enddrag",
+      "desc" : "Fires when a drag operation is complete",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "dd",
+          "type" : "Roo.GridDD",
+          "desc" : "The drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "event",
+          "desc" : "The raw browser event",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "headerdblclick",
+      "desc" : "Fires when a header cell is double clicked",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "columnIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "dragenter",
+      "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "dd",
+          "type" : "Roo.GridDD",
+          "desc" : "The drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "targetId",
+          "type" : "String",
+          "desc" : "The target drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "event",
+          "desc" : "The raw browser event",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "keydown",
+      "desc" : "The raw keydown event for the entire grid.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "dblclick",
+      "desc" : "The raw dblclick event for the entire grid.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "dragout",
+      "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "dd",
+          "type" : "Roo.GridDD",
+          "desc" : "The drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "targetId",
+          "type" : "String",
+          "desc" : "The target drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "event",
+          "desc" : "The raw browser event",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "columnmove",
+      "desc" : "Fires when the user moves a column",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "oldIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "newIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "mouseup",
+      "desc" : "The raw mouseup event for the entire grid.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "eventrender",
+      "desc" : "Fires before each cell is rendered, so you can modify the contents, like cls / title / qtip",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Calendar",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "data",
+          "type" : "data",
+          "desc" : "to be modified",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "bodyscroll",
+      "desc" : "Fires when the body element is scrolled",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "scrollLeft",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "scrollTop",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "rowdblclick",
+      "desc" : "Fires when a row is double clicked",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "rowIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "cellclick",
+      "desc" : "Fires when a cell is clicked",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "rowIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "columnIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "evententer",
+      "desc" : "Fires when mouse over an event",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Calendar",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "Event",
+          "type" : "event",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "mousedown",
+      "desc" : "The raw mousedown event for the entire grid.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "click",
+      "desc" : "The raw click event for the entire grid.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "contextmenu",
+      "desc" : "The raw contextmenu event for the entire grid.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "eventleave",
+      "desc" : "Fires when the mouse leaves an",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Calendar",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "",
+          "type" : "event",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "dragover",
+      "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "dd",
+          "type" : "Roo.GridDD",
+          "desc" : "The drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "targetId",
+          "type" : "String",
+          "desc" : "The target drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "event",
+          "desc" : "The raw browser event",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "rowcontextmenu",
+      "desc" : "Fires when a row is right clicked",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "rowIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "celldblclick",
+      "desc" : "Fires when a cell is double clicked",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "rowIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "columnIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "headercontextmenu",
+      "desc" : "Fires when a header is right clicked",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "columnIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "rowclass",
+      "desc" : "Fires when a row is rendered, so you can change add a style to it.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "gridview",
+          "type" : "GridView",
+          "desc" : "The grid view",
+          "isOptional" : false
+        },
+        {
+          "name" : "rowcfg",
+          "type" : "Object",
+          "desc" : "contains record  rowIndex and rowClass - set rowClass to add a style.",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "mouseover",
+      "desc" : "The raw mouseover event for the entire grid.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "keypress",
+      "desc" : "The raw keypress event for the entire grid.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "render",
+      "desc" : "Fires when the grid is rendered",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "grid",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "columnresize",
+      "desc" : "Fires when the user resizes a column",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "columnIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "newSize",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "cellcontextmenu",
+      "desc" : "Fires when a cell is right clicked",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "rowIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "cellIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    }
+  ]
+}
\ No newline at end of file
diff --git a/docs2/symbols/Roo.grid.CellSelectionModel.json b/docs2/symbols/Roo.grid.CellSelectionModel.json
new file mode 100644
index 0000000000..a16673408d
--- /dev/null
+++ b/docs2/symbols/Roo.grid.CellSelectionModel.json
@@ -0,0 +1,633 @@
+{
+  "name" : "Roo.grid.CellSelectionModel",
+  "augments" : [
+    "Roo.grid.AbstractSelectionModel",
+    "Roo.util.Observable"
+  ],
+  "desc" : "This class provides the basic implementation for cell selection in a grid.",
+  "isSingleton" : false,
+  "isStatic" : true,
+  "isBuiltin" : false,
+  "config" : [
+    {
+      "name" : "listeners",
+      "type" : "Object",
+      "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "enter_is_tab", + "type" : "Boolean", + "desc" : "Enter behaves the same as tab. (eg. goes to next cell) default: false", + "memberOf" : "Roo.grid.CellSelectionModel", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "hasSelection", + "desc" : "Returns true if there is a selection.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.CellSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "onEditorKey", + "desc" : "Selects a cell.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.CellSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "field", + "type" : "Number", + "desc" : "(not used) - as it's normally used as a listener", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Number", + "desc" : "- event - fake it by using\n\nvar e = Roo.EventObjectImpl.prototype;\ne.keyCode = e.TAB", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "select", + "desc" : "Selects a cell.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.CellSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "collIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSelectedCell", + "desc" : "Returns the currently selected cell,.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.CellSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The selected cell (row, column) or null if none selected." + } + ] + }, + { + "name" : "clearSelections", + "desc" : "Clears all selections.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.CellSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "true", + "type" : "Boolean", + "desc" : "to prevent the gridview from being notified about the change.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "lock", + "desc" : "Locks the selections.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isLocked", + "desc" : "Returns true if the selections are locked.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "unlock", + "desc" : "Unlocks the selections.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforeeditnext", + "desc" : "Fires before the next editable sell is made active\nYou can use this to skip to another cell or fire the tabend\n if you set cell to false", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventdata", + "type" : "Object", + "desc" : "object : { cell : [ row, col ] }", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "cellselect", + "desc" : "Fires when a cell is selected.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "The selected row index", + "isOptional" : false + }, + { + "name" : "colIndex", + "type" : "Number", + "desc" : "The selected cell index", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "tabend", + "desc" : "Fires when the tab (or enter) was pressed on the last editable cell\nYou can use this to trigger add new row.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "selectionchange", + "desc" : "Fires when the active selection changes.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "selection", + "type" : "Object", + "desc" : "null for no selection or an object (o) with two properties\n\t
    \n\t
  • o.record: the record object for the row the selection is in
  • \n\t
  • o.cell: An array of [rowIndex, columnIndex]
  • \n\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerowselect", + "desc" : "Fires before a cell is selected.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "The selected row index", + "isOptional" : false + }, + { + "name" : "colIndex", + "type" : "Number", + "desc" : "The selected cell index", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.grid.ColumnModel.json b/docs2/symbols/Roo.grid.ColumnModel.json new file mode 100644 index 0000000000..a9ef2bdc47 --- /dev/null +++ b/docs2/symbols/Roo.grid.ColumnModel.json @@ -0,0 +1,1357 @@ +{ + "name" : "Roo.grid.ColumnModel", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "This is the default implementation of a ColumnModel used by the Grid. It defines\nthe columns in the grid.\n
Usage:
\n
\n var colModel = new Roo.grid.ColumnModel([\n\t{header: \"Ticker\", width: 60, sortable: true, locked: true},\n\t{header: \"Company Name\", width: 150, sortable: true},\n\t{header: \"Market Cap.\", width: 100, sortable: true},\n\t{header: \"$ Sales\", width: 100, sortable: true, renderer: money},\n\t{header: \"Employees\", width: 100, sortable: true, resizable: false}\n ]);\n 
\n

\nThe config options listed for this class are options which may appear in each\nindividual column definition.\n
RooJS Fix - column id's are not sequential but use Roo.id() - fixes bugs with layouts.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "editor", + "type" : "Roo.grid.GridEditor", + "desc" : "(Optional) For grid editors - returns the grid editor", + "memberOf" : "Roo.grid.ColumnModel", + "values" : [ + ] + }, + { + "name" : "cursor", + "type" : "String", + "desc" : "(Optional)", + "memberOf" : "Roo.grid.ColumnModel", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n

\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "tooltip", + "type" : "String", + "desc" : "(Optional)", + "memberOf" : "Roo.grid.ColumnModel", + "values" : [ + ] + }, + { + "name" : "md", + "type" : "Number", + "desc" : "(Optional)", + "memberOf" : "Roo.grid.ColumnModel", + "values" : [ + ] + }, + { + "name" : "align", + "type" : "String", + "desc" : "(Optional) Set the CSS text-align property of the column. Defaults to undefined.", + "memberOf" : "Roo.grid.ColumnModel", + "values" : [ + ] + }, + { + "name" : "fixed", + "type" : "Boolean", + "desc" : "(Optional) True if the column width cannot be changed. Defaults to false.", + "memberOf" : "Roo.grid.ColumnModel", + "values" : [ + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "(Optional) True to hide the column. Defaults to false.", + "memberOf" : "Roo.grid.ColumnModel", + "values" : [ + ] + }, + { + "name" : "valign", + "type" : "String", + "desc" : "(Optional) Set the CSS vertical-align property of the column (eg. middle, top, bottom etc). Defaults to undefined.", + "memberOf" : "Roo.grid.ColumnModel", + "values" : [ + ] + }, + { + "name" : "locked", + "type" : "Boolean", + "desc" : "(Optional) True to lock the column in place while scrolling the Grid. Defaults to false.", + "memberOf" : "Roo.grid.ColumnModel", + "values" : [ + ] + }, + { + "name" : "lg", + "type" : "Number", + "desc" : "(Optional)", + "memberOf" : "Roo.grid.ColumnModel", + "values" : [ + ] + }, + { + "name" : "renderer", + "type" : "Function", + "desc" : "(Optional) A function used to generate HTML markup for a cell\ngiven the cell's data value. See {@link #setRenderer}. If not specified, the\ndefault renderer returns the escaped data value. If an object is returned (bootstrap only)\nthen it is treated as a Roo Component object instance, and it is rendered after the initial row is rendered", + "memberOf" : "Roo.grid.ColumnModel", + "values" : [ + ] + }, + { + "name" : "xs", + "type" : "Number", + "desc" : "(Optional)", + "memberOf" : "Roo.grid.ColumnModel", + "values" : [ + ] + }, + { + "name" : "sortable", + "type" : "Boolean", + "desc" : "(Optional) True if sorting is to be allowed on this column.\nDefaults to the value of the {@link #defaultSortable} property.\nWhether local/remote sorting is used is specified in {@link Roo.data.Store#remoteSort}.", + "memberOf" : "Roo.grid.ColumnModel", + "values" : [ + ] + }, + { + "name" : "width", + "type" : "Number", + "desc" : "(Optional) The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.", + "memberOf" : "Roo.grid.ColumnModel", + "values" : [ + ] + }, + { + "name" : "header", + "type" : "String", + "desc" : "The header text to display in the Grid view.", + "memberOf" : "Roo.grid.ColumnModel", + "values" : [ + ] + }, + { + "name" : "resizable", + "type" : "Boolean", + "desc" : "(Optional) False to disable column resizing. Defaults to true.", + "memberOf" : "Roo.grid.ColumnModel", + "values" : [ + ] + }, + { + "name" : "dataIndex", + "type" : "String", + "desc" : "(Optional) The name of the field in the grid's {@link Roo.data.Store}'s\n{@link Roo.data.Record} definition from which to draw the column's value. If not\nspecified, the column's index is used as an index into the Record's data Array.", + "memberOf" : "Roo.grid.ColumnModel", + "values" : [ + ] + }, + { + "name" : "sm", + "type" : "Number", + "desc" : "(Optional)", + "memberOf" : "Roo.grid.ColumnModel", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "setRenderer", + "desc" : "Sets the rendering (formatting) function for a column.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to use to process the cell's raw data\nto return HTML markup for the grid view. The render function is called with\nthe following parameters:
    \n
  • Data value.
  • \n
  • Cell metadata. An object in which you may set the following attributes:
      \n
    • css A CSS style string to apply to the table cell.
    • \n
    • attr An HTML attribute definition string to apply to the data container element within the table cell.
    \n
  • The {@link Roo.data.Record} from which the data was extracted.
  • \n
  • Row index
  • \n
  • Column index
  • \n
  • The {@link Roo.data.Store} object from which the Record was extracted
", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isHidden", + "desc" : "Returns true if the column is hidden.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "colIndex", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "setColumnHeader", + "desc" : "Sets the header for a column.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "header", + "type" : "String", + "desc" : "The new header", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getColumnCount", + "desc" : "Returns the number of columns.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "getColumnHeader", + "desc" : "Returns the header for the specified column.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "getRenderer", + "desc" : "Returns the rendering (formatting) function defined for the column.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Function", + "desc" : "The function used to render the cell. See {@link #setRenderer}." + } + ] + }, + { + "name" : "getColumnTooltip", + "desc" : "Returns the tooltip for the specified column.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "setColumnWidth", + "desc" : "Sets the width for a column.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setDataIndex", + "desc" : "Sets the dataIndex for a column.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "dataIndex", + "type" : "Number", + "desc" : "The new dataIndex", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "isCellEditable", + "desc" : "Returns true if the cell is editable.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "colIndex", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "The row index - this is nto actually used..?", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getColumnsBy", + "desc" : "Returns the column configs that return true by the passed function that is called with (columnConfig, index)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "result" + } + ] + }, + { + "name" : "getColumnWidth", + "desc" : "Returns the width for the specified column.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "isFixed", + "desc" : "Returns true if the column width cannot be changed", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getCellEditor", + "desc" : "Returns the editor defined for the cell/column.\nreturn false or null to disable editing.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "colIndex", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "The row index", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] + }, + { + "name" : "getColumnId", + "desc" : "Returns the id of the column at the specified index.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "the id" + } + ] + }, + { + "name" : "getDataIndex", + "desc" : "Returns the dataIndex for the specified column.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "isResizable", + "desc" : "Returns true if the column can be resized", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "setColumnTooltip", + "desc" : "Sets the tooltip for a column.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "tooltip", + "type" : "String", + "desc" : "The new tooltip", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setHidden", + "desc" : "Sets if a column is hidden.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "colIndex", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True if the column is hidden", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setEditable", + "desc" : "Sets if a column is editable.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "editable", + "type" : "Boolean", + "desc" : "True if the column is editable", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getColumnById", + "desc" : "Returns the column for a specified id.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The column id", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "the column" + } + ] + }, + { + "name" : "getColumnByDataIndex", + "desc" : "Returns the column for a specified dataIndex.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "dataIndex", + "type" : "String", + "desc" : "The column dataIndex", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object|Boolean", + "desc" : "the column or false if not found" + } + ] + }, + { + "name" : "setEditor", + "desc" : "Sets the editor for a column.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "editor", + "type" : "Object", + "desc" : "The editor object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "findColumnIndex", + "desc" : "Returns the index for a specified column dataIndex.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "dataIndex", + "type" : "String", + "desc" : "The column dataIndex", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "the index, or -1 if not found" + } + ] + }, + { + "name" : "isSortable", + "desc" : "Returns true if the specified column is sortable.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getIndexById", + "desc" : "Returns the index for a specified column id.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The column id", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "the index, or -1 if not found" + } + ] + }, + { + "name" : "getTotalWidth", + "desc" : "Returns the total width of all columns.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.ColumnModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "includeHidden", + "type" : "Boolean", + "desc" : "True to include hidden column widths", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "hiddenchange", + "desc" : "Fires when a column is hidden or \"unhidden\".", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "ColumnModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "true if hidden, false otherwise", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "headerchange", + "desc" : "Fires when the text of a header changes.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "ColumnModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "newText", + "type" : "Number", + "desc" : "The new header text", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "columlockchange", + "desc" : "Fires when a column's locked state is changed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "ColumnModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "colIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "locked", + "type" : "Boolean", + "desc" : "true if locked", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "columnmoved", + "desc" : "Fires when a column is moved.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "ColumnModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "oldIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "widthchange", + "desc" : "Fires when the width of a column changes.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "ColumnModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "newWidth", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.grid.EditorGrid.json b/docs2/symbols/Roo.grid.EditorGrid.json new file mode 100644 index 0000000000..d707d109eb --- /dev/null +++ b/docs2/symbols/Roo.grid.EditorGrid.json @@ -0,0 +1,1622 @@ +{ + "name" : "Roo.grid.EditorGrid", + "augments" : [ + "Roo.grid.Grid", + "Roo.util.Observable" + ], + "desc" : "Class for creating and editable grid.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "autoSizeColumns", + "type" : "Boolean", + "desc" : "True to automatically resize the columns to fit their content\non initial render. It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "maxRowsToMeasure", + "type" : "Boolean", + "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "minColumnWidth", + "type" : "Number", + "desc" : "The minimum width a column can be resized to. Default is 25.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "autoExpandColumn", + "type" : "String", + "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "autoExpandMax", + "type" : "Number", + "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "enableRowHeightSync", + "type" : "Boolean", + "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "monitorWindowResize", + "type" : "Boolean", + "desc" : "True to autoSize the grid when the window resizes. Default is true.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "autoExpandMin", + "type" : "Number", + "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "view", + "type" : "Object", + "desc" : "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "autoWidth", + "type" : "Boolean", + "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "ddGroup", + "type" : "String", + "desc" : "- drag drop group.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "enableDrag", + "type" : "Boolean", + "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "maxHeight", + "type" : "Number", + "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "trackMouseOver", + "type" : "Boolean", + "desc" : "True to highlight rows when the mouse is over. Default is true.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "loadMask", + "type" : "Object", + "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "stripeRows", + "type" : "Boolean", + "desc" : "True to stripe the rows. Default is true.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "enableColumnMove", + "type" : "Boolean", + "desc" : "True to enable drag and drop reorder of columns. Default is true.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "enableColumnHide", + "type" : "Boolean", + "desc" : "True to enable hiding of columns with the header context menu. Default is true.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "clicksToEdit", + "type" : "Number", + "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)", + "memberOf" : "Roo.grid.EditorGrid", + "values" : [ + ] + }, + { + "name" : "autoSizeHeaders", + "type" : "Boolean", + "desc" : "True to measure headers with column data when auto sizing columns. Default is true.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "enableDragDrop", + "type" : "Boolean", + "desc" : "True to enable drag and drop of rows. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "dropTarget", + "type" : "Roo.dd.DropTarget", + "desc" : "An {@link Roo.dd.DropTarget} config", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "autoHeight", + "type" : "Boolean", + "desc" : "True to fit the height of the grid container to the height of the data. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "stopEditing", + "desc" : "Stops any active editing", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.EditorGrid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getDragDropText", + "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.EditorGrid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "startEditing", + "desc" : "Starts editing the specified for the specified row/column", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.EditorGrid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "colIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSelectionModel", + "desc" : "Returns the grid's SelectionModel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "SelectionModel", + "desc" : "" + } + ] + }, + { + "name" : "destroy", + "desc" : "Destroy this grid.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "removeEl", + "type" : "Boolean", + "desc" : "True to remove the element", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getColumnModel", + "desc" : "Returns the grid's ColumnModel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "ColumnModel", + "desc" : "" + } + ] + }, + { + "name" : "getGridEl", + "desc" : "Returns the grid's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The element" + } + ] + }, + { + "name" : "getDataSource", + "desc" : "Returns the grid's DataSource.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "DataSource", + "desc" : "" + } + ] + }, + { + "name" : "autoSize", + "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getView", + "desc" : "Returns the grid's GridView object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "GridView", + "desc" : "" + } + ] + }, + { + "name" : "reconfigure", + "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "dataSource", + "type" : "Roo.data.Store", + "desc" : "The new {@link Roo.data.Store} object", + "isOptional" : false + }, + { + "name" : "The", + "type" : "Roo.grid.ColumnModel", + "desc" : "new {@link Roo.grid.ColumnModel} object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.grid.Grid", + "desc" : "this" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "validateedit", + "desc" : "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties
\n
    \n
  • editor - This editor
  • \n
  • grid - This grid
  • \n
  • record - The record being edited
  • \n
  • field - The field name being edited
  • \n
  • value - The value being set
  • \n
  • originalValue - The original value for the field, before the edit.
  • \n
  • row - The grid row index
  • \n
  • column - The grid column index
  • \n
  • cancel - Set this to true to cancel the edit or return false from your handler.
  • \n
", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Object", + "desc" : "An edit event (see above for description)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeedit", + "desc" : "Fires before cell editing is triggered. The edit event object has the following properties
\n
    \n
  • grid - This grid
  • \n
  • record - The record being edited
  • \n
  • field - The field name being edited
  • \n
  • value - The value for the field being edited.
  • \n
  • row - The grid row index
  • \n
  • column - The grid column index
  • \n
  • cancel - Set this to true to cancel the edit or return false from your handler.
  • \n
", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Object", + "desc" : "An edit event (see above for description)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "afteredit", + "desc" : "Fires after a cell is edited.
\n
    \n
  • grid - This grid
  • \n
  • record - The record being edited
  • \n
  • field - The field name being edited
  • \n
  • value - The value being set
  • \n
  • originalValue - The original value for the field, before the edit.
  • \n
  • row - The grid row index
  • \n
  • column - The grid column index
  • \n
", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Object", + "desc" : "An edit event (see above for description)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowcontextmenu", + "desc" : "Fires when a row is right clicked", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "columnmove", + "desc" : "Fires when the user moves a column", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "oldIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "headercontextmenu", + "desc" : "Fires when a header is right clicked", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires when the grid is rendered", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "grid", + "type" : "Grid", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "bodyscroll", + "desc" : "Fires when the body element is scrolled", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "scrollLeft", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scrollTop", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "columnresize", + "desc" : "Fires when the user resizes a column", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enddrag", + "desc" : "Fires when a drag operation is complete", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseout", + "desc" : "The raw mouseout event for the entire grid.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "cellclick", + "desc" : "Fires when a cell is clicked", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dragover", + "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowclass", + "desc" : "Fires when a row is rendered, so you can change add a style to it.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "gridview", + "type" : "GridView", + "desc" : "The grid view", + "isOptional" : false + }, + { + "name" : "rowcfg", + "type" : "Object", + "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keydown", + "desc" : "The raw keydown event for the entire grid.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mousedown", + "desc" : "The raw mousedown event for the entire grid.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dragenter", + "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dragout", + "desc" : "Fires when the dragged row(s) leave another DD target while being dragged", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseup", + "desc" : "The raw mouseup event for the entire grid.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keypress", + "desc" : "The raw keypress event for the entire grid.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "headerclick", + "desc" : "Fires when a header is clicked", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseover", + "desc" : "The raw mouseover event for the entire grid.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "headerdblclick", + "desc" : "Fires when a header cell is double clicked", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dragdrop", + "desc" : "Fires when dragged row(s) are dropped on a valid DD target", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowclick", + "desc" : "Fires when a row is clicked", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "The raw click event for the entire grid.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowdblclick", + "desc" : "Fires when a row is double clicked", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "startdrag", + "desc" : "Fires when row(s) start being dragged", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dblclick", + "desc" : "The raw dblclick event for the entire grid.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "cellcontextmenu", + "desc" : "Fires when a cell is right clicked", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "cellIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "contextmenu", + "desc" : "The raw contextmenu event for the entire grid.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "celldblclick", + "desc" : "Fires when a cell is double clicked", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.grid.Grid.json b/docs2/symbols/Roo.grid.Grid.json new file mode 100644 index 0000000000..9fd9ad6778 --- /dev/null +++ b/docs2/symbols/Roo.grid.Grid.json @@ -0,0 +1,1512 @@ +{ + "name" : "Roo.grid.Grid", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "This class represents the primary interface of a component based grid control.\n

Usage:
\n var grid = new Roo.grid.Grid(\"my-container-id\", {\n     ds: myDataStore,\n     cm: myColModel,\n     selModel: mySelectionModel,\n     autoSizeColumns: true,\n     monitorWindowResize: false,\n     trackMouseOver: true\n });\n // set any options\n grid.render();\n
\nCommon Problems:
\n- Grid does not resize properly when going smaller: Setting overflow hidden on the container\nelement will correct this
\n- If you get el.style[camel]= NaNpx or -2px or something related, be certain you have given your container element\ndimensions. The grid adapts to your container's size, if your container has no size defined then the results\nare unpredictable.
\n- Do not render the grid into an element with display:none. Try using visibility:hidden. Otherwise there is no way for the\ngrid to calculate dimensions/offsets.
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "autoSizeColumns", + "type" : "Boolean", + "desc" : "True to automatically resize the columns to fit their content\non initial render. It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "maxRowsToMeasure", + "type" : "Boolean", + "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "minColumnWidth", + "type" : "Number", + "desc" : "The minimum width a column can be resized to. Default is 25.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "autoExpandColumn", + "type" : "String", + "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "autoExpandMax", + "type" : "Number", + "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "enableRowHeightSync", + "type" : "Boolean", + "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "monitorWindowResize", + "type" : "Boolean", + "desc" : "True to autoSize the grid when the window resizes. Default is true.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "autoExpandMin", + "type" : "Number", + "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "view", + "type" : "Object", + "desc" : "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "autoWidth", + "type" : "Boolean", + "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "ddGroup", + "type" : "String", + "desc" : "- drag drop group.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "enableDrag", + "type" : "Boolean", + "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "maxHeight", + "type" : "Number", + "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "trackMouseOver", + "type" : "Boolean", + "desc" : "True to highlight rows when the mouse is over. Default is true.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "loadMask", + "type" : "Object", + "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "stripeRows", + "type" : "Boolean", + "desc" : "True to stripe the rows. Default is true.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "enableColumnMove", + "type" : "Boolean", + "desc" : "True to enable drag and drop reorder of columns. Default is true.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "enableColumnHide", + "type" : "Boolean", + "desc" : "True to enable hiding of columns with the header context menu. Default is true.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "autoSizeHeaders", + "type" : "Boolean", + "desc" : "True to measure headers with column data when auto sizing columns. Default is true.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "enableDragDrop", + "type" : "Boolean", + "desc" : "True to enable drag and drop of rows. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "dropTarget", + "type" : "Roo.dd.DropTarget", + "desc" : "An {@link Roo.dd.DropTarget} config", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "autoHeight", + "type" : "Boolean", + "desc" : "True to fit the height of the grid container to the height of the data. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getSelectionModel", + "desc" : "Returns the grid's SelectionModel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "SelectionModel", + "desc" : "" + } + ] + }, + { + "name" : "destroy", + "desc" : "Destroy this grid.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "removeEl", + "type" : "Boolean", + "desc" : "True to remove the element", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getColumnModel", + "desc" : "Returns the grid's ColumnModel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "ColumnModel", + "desc" : "" + } + ] + }, + { + "name" : "getGridEl", + "desc" : "Returns the grid's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The element" + } + ] + }, + { + "name" : "getDataSource", + "desc" : "Returns the grid's DataSource.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "DataSource", + "desc" : "" + } + ] + }, + { + "name" : "autoSize", + "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getView", + "desc" : "Returns the grid's GridView object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "GridView", + "desc" : "" + } + ] + }, + { + "name" : "getDragDropText", + "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "reconfigure", + "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "dataSource", + "type" : "Roo.data.Store", + "desc" : "The new {@link Roo.data.Store} object", + "isOptional" : false + }, + { + "name" : "The", + "type" : "Roo.grid.ColumnModel", + "desc" : "new {@link Roo.grid.ColumnModel} object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.grid.Grid", + "desc" : "this" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "rowcontextmenu", + "desc" : "Fires when a row is right clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "columnmove", + "desc" : "Fires when the user moves a column", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "oldIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "headercontextmenu", + "desc" : "Fires when a header is right clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires when the grid is rendered", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "grid", + "type" : "Grid", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "bodyscroll", + "desc" : "Fires when the body element is scrolled", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "scrollLeft", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scrollTop", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "columnresize", + "desc" : "Fires when the user resizes a column", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enddrag", + "desc" : "Fires when a drag operation is complete", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseout", + "desc" : "The raw mouseout event for the entire grid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "cellclick", + "desc" : "Fires when a cell is clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dragover", + "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowclass", + "desc" : "Fires when a row is rendered, so you can change add a style to it.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "gridview", + "type" : "GridView", + "desc" : "The grid view", + "isOptional" : false + }, + { + "name" : "rowcfg", + "type" : "Object", + "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keydown", + "desc" : "The raw keydown event for the entire grid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mousedown", + "desc" : "The raw mousedown event for the entire grid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dragenter", + "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dragout", + "desc" : "Fires when the dragged row(s) leave another DD target while being dragged", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseup", + "desc" : "The raw mouseup event for the entire grid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keypress", + "desc" : "The raw keypress event for the entire grid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "headerclick", + "desc" : "Fires when a header is clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseover", + "desc" : "The raw mouseover event for the entire grid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "headerdblclick", + "desc" : "Fires when a header cell is double clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dragdrop", + "desc" : "Fires when dragged row(s) are dropped on a valid DD target", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowclick", + "desc" : "Fires when a row is clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "The raw click event for the entire grid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowdblclick", + "desc" : "Fires when a row is double clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "startdrag", + "desc" : "Fires when row(s) start being dragged", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dblclick", + "desc" : "The raw dblclick event for the entire grid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "cellcontextmenu", + "desc" : "Fires when a cell is right clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "cellIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "contextmenu", + "desc" : "The raw contextmenu event for the entire grid.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "celldblclick", + "desc" : "Fires when a cell is double clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.grid.GridEditor.json b/docs2/symbols/Roo.grid.GridEditor.json new file mode 100644 index 0000000000..96ef508737 --- /dev/null +++ b/docs2/symbols/Roo.grid.GridEditor.json @@ -0,0 +1,1206 @@ +{ + "name" : "Roo.grid.GridEditor", + "augments" : [ + "Roo.Editor", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Class for creating and editable grid elements.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "hideEl", + "type" : "Boolean", + "desc" : "False to keep the bound element visible while the editor is displayed (defaults to true)", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "alignment", + "type" : "String", + "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"c-c?\").", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "constrain", + "type" : "Boolean", + "desc" : "True to constrain the editor to the viewport", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "\"sides\" for sides/bottom only, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"frame\")", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "field", + "type" : "Roo.form.Field", + "desc" : "Field to wrap (or xtyped)", + "memberOf" : "Roo.grid.GridEditor", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The data value of the underlying field (defaults to \"\")", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cancelOnEsc", + "type" : "Boolean", + "desc" : "True to cancel the edit when the escape key is pressed (defaults to false)", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "completeOnEnter", + "type" : "Boolean", + "desc" : "True to complete the edit when the enter key is pressed (defaults to false)", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "revertInvalid", + "type" : "Boolean", + "desc" : "True to automatically revert the field value and cancel the edit when the user completes an edit and the field\nvalidation fails (defaults to true)", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "ignoreNoChange", + "type" : "Boolean", + "desc" : "True to skip the the edit completion process (no save, no events fired) if the user completes an edit and\nthe value has not changed (defaults to false). Applies only to string values - edits for other data types\nwill never be ignored.", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "autosize", + "type" : "Boolean/String", + "desc" : "True for the editor to automatically adopt the size of the underlying field, \"width\" to adopt the width only,\nor \"height\" to adopt the height only (defaults to false)", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "updateEl", + "type" : "Boolean", + "desc" : "True to update the innerHTML of the bound element when the update completes (defaults to false)", + "memberOf" : "Roo.Editor", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "cancelEdit", + "desc" : "Cancels the editing process and hides the editor without persisting any changes. The field value will be\nreverted to the original starting value.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "remainVisible", + "type" : "Boolean", + "desc" : "Override the default behavior and keep the editor visible after\ncancel (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the height and width of this editor.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "realign", + "desc" : "Realigns the editor to the bound field based on the current alignment config value.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Gets the data value of the editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "The data value" + } + ] + }, + { + "name" : "completeEdit", + "desc" : "Ends the editing process, persists the changed value to the underlying field, and hides the editor.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "remainVisible", + "type" : "Boolean", + "desc" : "Override the default behavior and keep the editor visible after edit (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setValue", + "desc" : "Sets the data value of the editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "Any valid value supported by the underlying field", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "startEdit", + "desc" : "Starts the editing process and shows the editor.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The element to edit", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String", + "desc" : "(optional) A value to initialize the editor with. If a value is not provided, it defaults\nto the innerHTML of el.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforestartedit", + "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.", + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Editor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "boundEl", + "type" : "Roo.Element", + "desc" : "The underlying element bound to this editor", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The field value being set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforecomplete", + "desc" : "Fires after a change has been made to the field, but before the change is reflected in the underlying\nfield. Saving the change to the field can be canceled by returning false from the handler of this event.\nNote that if the value has not changed and ignoreNoChange = true, the editing will still end but this\nevent will not fire since no edit actually occurred.", + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Editor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The current field value", + "isOptional" : false + }, + { + "name" : "startValue", + "type" : "Mixed", + "desc" : "The original field value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "complete", + "desc" : "Fires after editing is complete and any changed value has been written to the underlying field.", + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Editor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The current field value", + "isOptional" : false + }, + { + "name" : "startValue", + "type" : "Mixed", + "desc" : "The original field value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "startedit", + "desc" : "Fires when this editor is displayed", + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "boundEl", + "type" : "Roo.Element", + "desc" : "The underlying element bound to this editor", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The starting field value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.grid.GridView.json b/docs2/symbols/Roo.grid.GridView.json new file mode 100644 index 0000000000..bdc8a16ae4 --- /dev/null +++ b/docs2/symbols/Roo.grid.GridView.json @@ -0,0 +1,607 @@ +{ + "name" : "Roo.grid.GridView", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getFooterPanel", + "desc" : "Gets a panel in the footer of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.GridView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "doShow", + "type" : "Boolean", + "desc" : "By default the footer is hidden. Pass true to show the panel", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Roo.Element" + } + ] + }, + { + "name" : "fitColumns", + "desc" : "Autofits all columns to the grid's width proportionate with their current size", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.GridView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "reserveScrollSpace", + "type" : "Boolean", + "desc" : "Reserve space for a scrollbar", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focusRow", + "desc" : "Focuses the specified row.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.GridView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "row", + "type" : "Number", + "desc" : "The row index", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "focusCell", + "desc" : "Focuses the specified cell.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.GridView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "row", + "type" : "Number", + "desc" : "The row index", + "isOptional" : false + }, + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "hscroll", + "type" : "Boolean", + "desc" : "false to disable horizontal scrolling", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autoSizeColumn", + "desc" : "Autofit a column to its content.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.GridView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "colIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "forceMinSize", + "type" : "Boolean", + "desc" : "true to force the column to go smaller if possible", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getHeaderPanel", + "desc" : "Gets a panel in the header of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.GridView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "doShow", + "type" : "Boolean", + "desc" : "By default the header is hidden. Pass true to show the panel", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Roo.Element" + } + ] + }, + { + "name" : "scrollToTop", + "desc" : "Scrolls the grid to the top", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.GridView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getCell", + "desc" : "Gets the 'td' of the cell", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.GridView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "rowIndex", + "type" : "Integer", + "desc" : "row to select", + "isOptional" : false + }, + { + "name" : "colIndex", + "type" : "Integer", + "desc" : "column to select", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] + }, + { + "name" : "refresh", + "desc" : "Refreshes the grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.GridView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "headersToo", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "autoSizeColumns", + "desc" : "Autofits all columns to their content and then expands to fit any extra space in the grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.GridView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "ensureVisible", + "desc" : "Scrolls the specified cell into view", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.GridView", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "row", + "type" : "Number", + "desc" : "The row index", + "isOptional" : false + }, + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "hscroll", + "type" : "Boolean", + "desc" : "false to disable horizontal scrolling", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.grid.PropertyGrid.json b/docs2/symbols/Roo.grid.PropertyGrid.json new file mode 100644 index 0000000000..40cafbd316 --- /dev/null +++ b/docs2/symbols/Roo.grid.PropertyGrid.json @@ -0,0 +1,1756 @@ +{ + "name" : "Roo.grid.PropertyGrid", + "augments" : [ + "Roo.grid.EditorGrid", + "Roo.grid.Grid", + "Roo.util.Observable" + ], + "desc" : "This class represents the interface of a component based property grid control.\n

Usage:
\n var grid = new Roo.grid.PropertyGrid(\"my-container-id\", {\n      \n });\n // set any options\n grid.render();\n
", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "autoSizeColumns", + "type" : "Boolean", + "desc" : "True to automatically resize the columns to fit their content\non initial render. It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "customEditors", + "type" : "Object", + "desc" : "map of colnames=> custom editors.\nthe custom editor can be one of the standard ones (date|string|number|int|boolean), or a\ngrid editor eg. Roo.grid.GridEditor(new Roo.form.TextArea({selectOnFocus:true})),\nfalse disables editing of the field.", + "memberOf" : "Roo.grid.PropertyGrid", + "values" : [ + ] + }, + { + "name" : "maxRowsToMeasure", + "type" : "Boolean", + "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "minColumnWidth", + "type" : "Number", + "desc" : "The minimum width a column can be resized to. Default is 25.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "autoExpandColumn", + "type" : "String", + "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "autoExpandMax", + "type" : "Number", + "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "enableRowHeightSync", + "type" : "Boolean", + "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "propertyNames", + "type" : "Object", + "desc" : "map of property Names to their displayed value", + "memberOf" : "Roo.grid.PropertyGrid", + "values" : [ + ] + }, + { + "name" : "monitorWindowResize", + "type" : "Boolean", + "desc" : "True to autoSize the grid when the window resizes. Default is true.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "autoExpandMin", + "type" : "Number", + "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "view", + "type" : "Object", + "desc" : "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "autoWidth", + "type" : "Boolean", + "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "ddGroup", + "type" : "String", + "desc" : "- drag drop group.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "enableDrag", + "type" : "Boolean", + "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "maxHeight", + "type" : "Number", + "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "trackMouseOver", + "type" : "Boolean", + "desc" : "True to highlight rows when the mouse is over. Default is true.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "loadMask", + "type" : "Object", + "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "stripeRows", + "type" : "Boolean", + "desc" : "True to stripe the rows. Default is true.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "enableColumnMove", + "type" : "Boolean", + "desc" : "True to enable drag and drop reorder of columns. Default is true.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "enableColumnHide", + "type" : "Boolean", + "desc" : "True to enable hiding of columns with the header context menu. Default is true.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "clicksToEdit", + "type" : "Number", + "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)", + "memberOf" : "Roo.grid.EditorGrid", + "values" : [ + ] + }, + { + "name" : "autoSizeHeaders", + "type" : "Boolean", + "desc" : "True to measure headers with column data when auto sizing columns. Default is true.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "enableDragDrop", + "type" : "Boolean", + "desc" : "True to enable drag and drop of rows. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "dropTarget", + "type" : "Roo.dd.DropTarget", + "desc" : "An {@link Roo.dd.DropTarget} config", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + }, + { + "name" : "autoHeight", + "type" : "Boolean", + "desc" : "True to fit the height of the grid container to the height of the data. Default is false.", + "memberOf" : "Roo.grid.Grid", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getSource", + "desc" : "Gets all the data from the grid.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.PropertyGrid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "data data stored in grid" + } + ] + }, + { + "name" : "setSource", + "desc" : "Sets the data for the Grid\naccepts a Key => Value object of all the elements avaiable.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.PropertyGrid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "to appear in grid.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "stopEditing", + "desc" : "Stops any active editing", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.EditorGrid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getDragDropText", + "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.EditorGrid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "startEditing", + "desc" : "Starts editing the specified for the specified row/column", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.EditorGrid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "colIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSelectionModel", + "desc" : "Returns the grid's SelectionModel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "SelectionModel", + "desc" : "" + } + ] + }, + { + "name" : "destroy", + "desc" : "Destroy this grid.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "removeEl", + "type" : "Boolean", + "desc" : "True to remove the element", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getColumnModel", + "desc" : "Returns the grid's ColumnModel.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "ColumnModel", + "desc" : "" + } + ] + }, + { + "name" : "getGridEl", + "desc" : "Returns the grid's underlying element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The element" + } + ] + }, + { + "name" : "getDataSource", + "desc" : "Returns the grid's DataSource.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "DataSource", + "desc" : "" + } + ] + }, + { + "name" : "autoSize", + "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getView", + "desc" : "Returns the grid's GridView object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "GridView", + "desc" : "" + } + ] + }, + { + "name" : "reconfigure", + "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "dataSource", + "type" : "Roo.data.Store", + "desc" : "The new {@link Roo.data.Store} object", + "isOptional" : false + }, + { + "name" : "The", + "type" : "Roo.grid.ColumnModel", + "desc" : "new {@link Roo.grid.ColumnModel} object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.grid.Grid", + "desc" : "this" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforepropertychange", + "desc" : "Fires before a property changes (return false to stop?)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "grid", + "type" : "Roo.grid.PropertyGrid", + "desc" : "property grid? (check could be store)", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "Record Id", + "isOptional" : false + }, + { + "name" : "newval", + "type" : "String", + "desc" : "New Value", + "isOptional" : false + }, + { + "name" : "oldval", + "type" : "String", + "desc" : "Old Value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "propertychange", + "desc" : "Fires after a property changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "grid", + "type" : "Roo.grid.PropertyGrid", + "desc" : "property grid? (check could be store)", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "Record Id", + "isOptional" : false + }, + { + "name" : "newval", + "type" : "String", + "desc" : "New Value", + "isOptional" : false + }, + { + "name" : "oldval", + "type" : "String", + "desc" : "Old Value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "validateedit", + "desc" : "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties
\n
    \n
  • editor - This editor
  • \n
  • grid - This grid
  • \n
  • record - The record being edited
  • \n
  • field - The field name being edited
  • \n
  • value - The value being set
  • \n
  • originalValue - The original value for the field, before the edit.
  • \n
  • row - The grid row index
  • \n
  • column - The grid column index
  • \n
  • cancel - Set this to true to cancel the edit or return false from your handler.
  • \n
", + "memberOf" : "Roo.grid.EditorGrid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Object", + "desc" : "An edit event (see above for description)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeedit", + "desc" : "Fires before cell editing is triggered. The edit event object has the following properties
\n
    \n
  • grid - This grid
  • \n
  • record - The record being edited
  • \n
  • field - The field name being edited
  • \n
  • value - The value for the field being edited.
  • \n
  • row - The grid row index
  • \n
  • column - The grid column index
  • \n
  • cancel - Set this to true to cancel the edit or return false from your handler.
  • \n
", + "memberOf" : "Roo.grid.EditorGrid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Object", + "desc" : "An edit event (see above for description)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "afteredit", + "desc" : "Fires after a cell is edited.
\n
    \n
  • grid - This grid
  • \n
  • record - The record being edited
  • \n
  • field - The field name being edited
  • \n
  • value - The value being set
  • \n
  • originalValue - The original value for the field, before the edit.
  • \n
  • row - The grid row index
  • \n
  • column - The grid column index
  • \n
", + "memberOf" : "Roo.grid.EditorGrid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Object", + "desc" : "An edit event (see above for description)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowcontextmenu", + "desc" : "Fires when a row is right clicked", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "columnmove", + "desc" : "Fires when the user moves a column", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "oldIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "headercontextmenu", + "desc" : "Fires when a header is right clicked", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires when the grid is rendered", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "grid", + "type" : "Grid", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "bodyscroll", + "desc" : "Fires when the body element is scrolled", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "scrollLeft", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scrollTop", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "columnresize", + "desc" : "Fires when the user resizes a column", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enddrag", + "desc" : "Fires when a drag operation is complete", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseout", + "desc" : "The raw mouseout event for the entire grid.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "cellclick", + "desc" : "Fires when a cell is clicked", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dragover", + "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowclass", + "desc" : "Fires when a row is rendered, so you can change add a style to it.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "gridview", + "type" : "GridView", + "desc" : "The grid view", + "isOptional" : false + }, + { + "name" : "rowcfg", + "type" : "Object", + "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keydown", + "desc" : "The raw keydown event for the entire grid.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mousedown", + "desc" : "The raw mousedown event for the entire grid.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dragenter", + "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dragout", + "desc" : "Fires when the dragged row(s) leave another DD target while being dragged", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseup", + "desc" : "The raw mouseup event for the entire grid.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "keypress", + "desc" : "The raw keypress event for the entire grid.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "headerclick", + "desc" : "Fires when a header is clicked", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseover", + "desc" : "The raw mouseover event for the entire grid.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "headerdblclick", + "desc" : "Fires when a header cell is double clicked", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dragdrop", + "desc" : "Fires when dragged row(s) are dropped on a valid DD target", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowclick", + "desc" : "Fires when a row is clicked", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "The raw click event for the entire grid.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowdblclick", + "desc" : "Fires when a row is double clicked", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "startdrag", + "desc" : "Fires when row(s) start being dragged", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dblclick", + "desc" : "The raw dblclick event for the entire grid.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "cellcontextmenu", + "desc" : "Fires when a cell is right clicked", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "cellIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "contextmenu", + "desc" : "The raw contextmenu event for the entire grid.", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "celldblclick", + "desc" : "Fires when a cell is double clicked", + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.grid.RowSelectionModel.json b/docs2/symbols/Roo.grid.RowSelectionModel.json new file mode 100644 index 0000000000..a788154c27 --- /dev/null +++ b/docs2/symbols/Roo.grid.RowSelectionModel.json @@ -0,0 +1,933 @@ +{ + "name" : "Roo.grid.RowSelectionModel", + "augments" : [ + "Roo.grid.AbstractSelectionModel", + "Roo.util.Observable" + ], + "desc" : "The default SelectionModel used by {@link Roo.grid.Grid}.\nIt supports multiple selections and keyboard selection/navigation.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "singleSelect", + "type" : "Boolean", + "desc" : "True to allow selection of only one row at a time (defaults to false)", + "memberOf" : "Roo.grid.RowSelectionModel", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "selectRange", + "desc" : "Selects a range of rows. All rows in between startRow and endRow are also selected.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "startRow", + "type" : "Number", + "desc" : "The index of the first row in the range", + "isOptional" : false + }, + { + "name" : "endRow", + "type" : "Number", + "desc" : "The index of the last row in the range", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to retain existing selections", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "selectFirstRow", + "desc" : "Selects the first row in the grid.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "deselectRow", + "desc" : "Deselects a row.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "row", + "type" : "Number", + "desc" : "The index of the row to deselect", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getCount", + "desc" : "Gets the number of selected rows.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "isSelected", + "desc" : "Returns True if the specified row is selected.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "record", + "type" : "Number/Record", + "desc" : "The record or index of the record to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "selectLastRow", + "desc" : "Select the last row.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hasSelection", + "desc" : "Returns True if there is a selection.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "isIdSelected", + "desc" : "Returns True if the specified record id is selected.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of record to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "getSelected", + "desc" : "Returns the first selected record.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Record", + "desc" : "" + } + ] + }, + { + "name" : "selectRecords", + "desc" : "Select records.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "records", + "type" : "Array", + "desc" : "The records to select", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clearSelections", + "desc" : "Clears all selections.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "deselectRange", + "desc" : "Deselects a range of rows. All rows in between startRow and endRow are also deselected.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "startRow", + "type" : "Number", + "desc" : "The index of the first row in the range", + "isOptional" : false + }, + { + "name" : "endRow", + "type" : "Number", + "desc" : "The index of the last row in the range", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getSelections", + "desc" : "Returns the selected records", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "Array of selected records" + } + ] + }, + { + "name" : "selectNext", + "desc" : "Selects the row immediately following the last selected row.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "selectAll", + "desc" : "Selects all rows.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "selectRow", + "desc" : "Selects a row.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "row", + "type" : "Number", + "desc" : "The index of the row to select", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "selectRows", + "desc" : "Selects multiple rows.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "rows", + "type" : "Array", + "desc" : "Array of the indexes of the row to select", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "selectPrevious", + "desc" : "Selects the row that precedes the last selected row.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "lock", + "desc" : "Locks the selections.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isLocked", + "desc" : "Returns true if the selections are locked.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "unlock", + "desc" : "Unlocks the selections.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
    \n
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "selectionchange", + "desc" : "Fires when the selection changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowselect", + "desc" : "Fires when a row is selected.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "The selected index", + "isOptional" : false + }, + { + "name" : "r", + "type" : "Roo.data.Record", + "desc" : "The record", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerowselect", + "desc" : "Fires when a row is selected being selected, return false to cancel.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "The selected index", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "False if other selections will be cleared", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "afterselectionchange", + "desc" : "Fires after the selection changes (eg. by key press or clicking)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowdeselect", + "desc" : "Fires when a row is deselected.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "The selected index", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.grid.json b/docs2/symbols/Roo.grid.json new file mode 100644 index 0000000000..d6447d29f9 --- /dev/null +++ b/docs2/symbols/Roo.grid.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.grid", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.json b/docs2/symbols/Roo.json new file mode 100644 index 0000000000..e3185eec60 --- /dev/null +++ b/docs2/symbols/Roo.json @@ -0,0 +1,791 @@ +{ + "name" : "Roo", + "augments" : [ + ], + "desc" : "Roo core utilities and functions.", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "removeMask", + "type" : "Boolean", + "desc" : "True to create a single-use mask that is automatically destroyed after loading (useful for page loads),\nFalse to persist the mask element reference for multiple uses (e.g., for paged data widgets). Defaults to false.", + "memberOf" : "Roo", + "values" : [ + ] + }, + { + "name" : "items", + "type" : "Array", + "desc" : "array of button configs or elements to add (will be converted to a MixedCollection)", + "memberOf" : "Roo", + "values" : [ + ] + }, + { + "name" : "mode", + "type" : "String", + "desc" : "The shadow display mode. Supports the following options:
\nsides: Shadow displays on both sides and bottom only
\nframe: Shadow displays equally on all four sides
\ndrop: Traditional bottom-right drop shadow (default)", + "memberOf" : "Roo", + "values" : [ + ] + }, + { + "name" : "tree", + "type" : "Roo.tree.TreePanel", + "desc" : "The tree TreePanel, with config etc.", + "memberOf" : "Roo", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "each", + "desc" : "Iterates an array calling the passed function with each item, stopping if your function returns false. If the\npassed array is not really an array, your function is called once with it.\nThe supplied function is called with (Object item, Number index, Array allItems).", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "array", + "type" : "Array/NodeList/Mixed", + "desc" : "", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "get", + "desc" : "Static method to retrieve Element objects. Uses simple caching to consistently return the same object.\nAutomatically fixes if an object was recreated with the same id via AJAX or DOM.\nShorthand of {@link Roo.Element#get}", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM Node or an existing Element.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The Element object" + } + ] + }, + { + "name" : "decode", + "desc" : "Shorthand for {@link Roo.util.JSON#decode}", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getDom", + "desc" : "Return the dom node for the passed string (id), dom node, or Roo.Element", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "HTMLElement" + } + ] + }, + { + "name" : "urlEncode", + "desc" : "Takes an object and converts it to an encoded URL. e.g. Roo.urlEncode({foo: 1, bar: 2}); would return \"foo=1&bar=2\". Optionally, property values can be arrays, instead of keys and the resulting string that's returned will contain a name/value pair for each array value.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "addBehaviors", + "desc" : "Applies event listeners to elements by selectors when the document is ready.\nThe event name is specified with an @ suffix.\n
\nRoo.addBehaviors({\n   // add a listener for click on all anchors in element with id foo\n   '#foo a@click' : function(e, t){\n       // do something\n   },\n\n   // add the same listener to multiple selectors (separated by comma BEFORE the @)\n   '#foo a, #bar span.some-class@mouseover' : function(){\n       // do something\n   }\n});\n
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "obj", + "type" : "Object", + "desc" : "The list of behaviors to apply", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "factory", + "desc" : "Creates namespaces to be used for scoping variables and classes so that they are not global. Usage:\n
\nRoo.factory({ xns: Roo.data, xtype : 'Store', .....});\nRoo.factory(conf, Roo.data);\n
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "classname", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "namespace", + "type" : "String", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "apply", + "desc" : "Copies all the properties of config to obj.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "obj", + "type" : "Object", + "desc" : "The receiver of the properties", + "isOptional" : false + }, + { + "name" : "config", + "type" : "Object", + "desc" : "The source of the properties", + "isOptional" : false + }, + { + "name" : "defaults", + "type" : "Object", + "desc" : "A different object that will also be applied for default values", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "returns obj" + } + ] + }, + { + "name" : "onReady", + "desc" : "Fires when the document is ready (before onload and before images are loaded). Shorthand of {@link Roo.EventManager#onDocumentReady}.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "An object that becomes the scope of the handler", + "isOptional" : false + }, + { + "name" : "override", + "type" : "boolean", + "desc" : "If true, the obj passed in becomes\n the execution scope of the listener", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "select", + "desc" : "Selects elements based on the passed CSS selector to enable working on them as 1.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String/Array", + "desc" : "The CSS selector or an array of elements", + "isOptional" : false + }, + { + "name" : "unique", + "type" : "Boolean", + "desc" : "(optional) true to create a unique Roo.Element for each element (defaults to a shared flyweight object)", + "isOptional" : false + }, + { + "name" : "root", + "type" : "HTMLElement/String", + "desc" : "(optional) The root element of the query or id of the root", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "CompositeElementLite/CompositeElement", + "desc" : "" + } + ] + }, + { + "name" : "applyIf", + "desc" : "Copies all the properties of config to obj if they don't already exist.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "obj", + "type" : "Object", + "desc" : "The receiver of the properties", + "isOptional" : false + }, + { + "name" : "config", + "type" : "Object", + "desc" : "The source of the properties", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "returns obj" + } + ] + }, + { + "name" : "getCmp", + "desc" : "Shorthand for {@link Roo.ComponentMgr#get}", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Roo.Component" + } + ] + }, + { + "name" : "id", + "desc" : "Generates unique ids. If the element already has an id, it is unchanged", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element to generate an id for", + "isOptional" : false + }, + { + "name" : "prefix", + "type" : "String", + "desc" : "(optional) Id prefix (defaults \"Roo-gen\")", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The generated Id." + } + ] + }, + { + "name" : "encodeURIComponent", + "desc" : "Safe version of encodeURIComponent", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "data", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "encode", + "desc" : "Shorthand for {@link Roo.util.JSON#encode}", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "fly", + "desc" : "Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -\nthe dom node can be overwritten by other code.\nShorthand of {@link Roo.Element#fly}", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement", + "desc" : "The dom node or id", + "isOptional" : false + }, + { + "name" : "named", + "type" : "String", + "desc" : "(optional) Allows for creation of named reusable flyweights to\n prevent conflicts (e.g. internally Roo uses \"_internal\")", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The shared Element object" + } + ] + }, + { + "name" : "isEmpty", + "desc" : "Returns true if the passed value is null, undefined or an empty string (optional).", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to test", + "isOptional" : false + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "(optional) Pass true if an empty string is not considered empty", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "query", + "desc" : "Selects an array of DOM nodes by CSS/XPath selector. Shorthand of {@link Roo.DomQuery#select}", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "path", + "type" : "String", + "desc" : "The selector/xpath query", + "isOptional" : false + }, + { + "name" : "root", + "type" : "Node", + "desc" : "(optional) The start of the query (defaults to document).", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "" + } + ] + }, + { + "name" : "urlDecode", + "desc" : "Takes an encoded URL and and converts it to an object. e.g. Roo.urlDecode(\"foo=1&bar=2\"); would return {foo: 1, bar: 2} or Roo.urlDecode(\"foo=1&bar=2&bar=3&bar=4\", true); would return {foo: 1, bar: [2, 3, 4]}.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "string", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "overwrite", + "type" : "Boolean", + "desc" : "(optional) Items of the same name will overwrite previous values instead of creating an an array (Defaults to false).", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "A literal with members" + } + ] + }, + { + "name" : "escapeRe", + "desc" : "Escapes the passed string for use in a regular expression", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "str", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "extend", + "desc" : "Extends one class with another class and optionally overrides members with the passed literal. This class\nalso adds the function \"override()\" to the class that can be used to override\nmembers on an instance.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "subclass", + "type" : "Object", + "desc" : "The class inheriting the functionality", + "isOptional" : false + }, + { + "name" : "superclass", + "type" : "Object", + "desc" : "The class being extended", + "isOptional" : false + }, + { + "name" : "overrides", + "type" : "Object", + "desc" : "(optional) A literal with members", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "namespace", + "desc" : "Creates namespaces to be used for scoping variables and classes so that they are not global. Usage:\n
\nRoo.namespace('Company', 'Company.data');\nCompany.Widget = function() { ... }\nCompany.data.CustomStore = function(config) { ... }\n
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "namespace1", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "namespace2", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "etc", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "override", + "desc" : "Adds a list of functions to the prototype of an existing class, overwriting any existing methods with the same name.\nUsage:
\nRoo.override(MyClass, {\n    newMethod1: function(){\n        // etc.\n    },\n    newMethod2: function(foo){\n        // etc.\n    }\n});\n 
", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "origclass", + "type" : "Object", + "desc" : "The class to override", + "isOptional" : false + }, + { + "name" : "overrides", + "type" : "Object", + "desc" : "The list of functions to add to origClass. This should be specified as an object literal\ncontaining one or more methods.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "selectNode", + "desc" : "Selects a single element as a Roo Element\nThis is about as close as you can get to jQuery's $('do crazy stuff')", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The selector/xpath query", + "isOptional" : false + }, + { + "name" : "root", + "type" : "Node", + "desc" : "(optional) The start of the query (defaults to document).", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] + }, + { + "name" : "type", + "desc" : "Returns the type of object that is passed in. If the object passed in is null or undefined it\nreturn false otherwise it returns one of the following values:
    \n
  • string: If the object passed is a string
  • \n
  • number: If the object passed is a number
  • \n
  • boolean: If the object passed is a boolean value
  • \n
  • function: If the object passed is a function reference
  • \n
  • object: If the object passed is an object
  • \n
  • array: If the object passed is an array
  • \n
  • regexp: If the object passed is a regular expression
  • \n
  • element: If the object passed is a DOM Element
  • \n
  • nodelist: If the object passed is a DOM NodeList
  • \n
  • textnode: If the object passed is a DOM text node and contains something other than whitespace
  • \n
  • whitespace: If the object passed is a DOM text node and contains only whitespace
  • ", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Mixed", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.lib.Ajax.json b/docs2/symbols/Roo.lib.Ajax.json new file mode 100644 index 0000000000..d440d095e7 --- /dev/null +++ b/docs2/symbols/Roo.lib.Ajax.json @@ -0,0 +1,31 @@ +{ + "name" : "Roo.lib.Ajax", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "request", + "desc" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.lib.Ajax", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.lib.Dom.json b/docs2/symbols/Roo.lib.Dom.json new file mode 100644 index 0000000000..fd3e6c5cfb --- /dev/null +++ b/docs2/symbols/Roo.lib.Dom.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.lib.Dom", + "augments" : [ + ], + "desc" : "Dom utils (from YIU afaik)", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.lib.json b/docs2/symbols/Roo.lib.json new file mode 100644 index 0000000000..e1cf062abb --- /dev/null +++ b/docs2/symbols/Roo.lib.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.lib", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.menu.Adapter.json b/docs2/symbols/Roo.menu.Adapter.json new file mode 100644 index 0000000000..b7ab8305f7 --- /dev/null +++ b/docs2/symbols/Roo.menu.Adapter.json @@ -0,0 +1,919 @@ +{ + "name" : "Roo.menu.Adapter", + "augments" : [ + "Roo.menu.BaseItem", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "A base utility class that adapts a non-menu component so that it can be wrapped by a menu item and added to a menu.\nIt provides basic rendering, activation management and enable/disable logic required to work in menus.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to prevent creation of this menu item (defaults to false)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "activeClass", + "type" : "String", + "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideOnClick", + "type" : "Boolean", + "desc" : "True to hide the containing menu after this item is clicked (defaults to true)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "canActivate", + "type" : "Boolean", + "desc" : "True if this item can be visually activated (defaults to false)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "Fires when this item is clicked", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Fires when this item is activated", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "deactivate", + "desc" : "Fires when this item is deactivated", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.menu.BaseItem.json b/docs2/symbols/Roo.menu.BaseItem.json new file mode 100644 index 0000000000..a1088f63ef --- /dev/null +++ b/docs2/symbols/Roo.menu.BaseItem.json @@ -0,0 +1,918 @@ +{ + "name" : "Roo.menu.BaseItem", + "augments" : [ + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "The base class for all items that render into menus. BaseItem provides default rendering, activated state\nmanagement and base configuration options shared by all menu components.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "activeClass", + "type" : "String", + "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to prevent creation of this menu item (defaults to false)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideOnClick", + "type" : "Boolean", + "desc" : "True to hide the containing menu after this item is clicked (defaults to true)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "canActivate", + "type" : "Boolean", + "desc" : "True if this item can be visually activated (defaults to false)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "Fires when this item is clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Fires when this item is activated", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "deactivate", + "desc" : "Fires when this item is deactivated", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.menu.CheckItem.json b/docs2/symbols/Roo.menu.CheckItem.json new file mode 100644 index 0000000000..641ff572ba --- /dev/null +++ b/docs2/symbols/Roo.menu.CheckItem.json @@ -0,0 +1,1090 @@ +{ + "name" : "Roo.menu.CheckItem", + "augments" : [ + "Roo.menu.Item", + "Roo.menu.BaseItem", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Adds a menu item that contains a checkbox by default, but can also be part of a radio group.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "showDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before showing this item (defaults to 200)", + "memberOf" : "Roo.menu.Item", + "values" : [ + ] + }, + { + "name" : "text", + "type" : "String", + "desc" : "The text to show on the menu item.", + "memberOf" : "Roo.menu.Item", + "values" : [ + ] + }, + { + "name" : "activeClass", + "type" : "String", + "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to prevent creation of this menu item (defaults to false)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "group", + "type" : "String", + "desc" : "All check items with the same group name will automatically be grouped into a single-select\nradio button group (defaults to '')", + "memberOf" : "Roo.menu.CheckItem", + "values" : [ + ] + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideOnClick", + "type" : "Boolean", + "desc" : "True to hide the containing menu after this item is clicked (defaults to true)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "itemCls", + "type" : "String", + "desc" : "The default CSS class to use for check items (defaults to \"x-menu-item x-menu-check-item\")", + "memberOf" : "Roo.menu.CheckItem", + "values" : [ + ] + }, + { + "name" : "HTML", + "type" : "String", + "desc" : "to render in menu\nThe text to show on the menu item (HTML version).", + "memberOf" : "Roo.menu.Item", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "groupClass", + "type" : "String", + "desc" : "The default CSS class to use for radio group check items (defaults to \"x-menu-group-item\")", + "memberOf" : "Roo.menu.CheckItem", + "values" : [ + ] + }, + { + "name" : "canActivate", + "type" : "Boolean", + "desc" : "True if this item can be visually activated (defaults to true)", + "memberOf" : "Roo.menu.Item", + "values" : [ + ] + }, + { + "name" : "icon", + "type" : "String", + "desc" : "The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)", + "memberOf" : "Roo.menu.Item", + "values" : [ + ] + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "True to initialize this checkbox as checked (defaults to false). Note that\nif this checkbox is part of a radio group (group = true) only the last item in the group that is\ninitialized with checked = true will be rendered as checked.", + "memberOf" : "Roo.menu.CheckItem", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "setChecked", + "desc" : "Set the checked state of this item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.CheckItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "checked", + "type" : "Boolean", + "desc" : "The new checked value", + "isOptional" : false + }, + { + "name" : "suppressEvent", + "type" : "Boolean", + "desc" : "(optional) True to prevent the checkchange event from firing (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setText", + "desc" : "Sets the text to display in this menu item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The text to display", + "isOptional" : false + }, + { + "name" : "isHTML", + "type" : "Boolean", + "desc" : "true to indicate text is pure html.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforecheckchange", + "desc" : "Fires before the checked value is set, providing an opportunity to cancel if needed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.CheckItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "The new checked value that will be set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "checkchange", + "desc" : "Fires after the checked value has been set", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.CheckItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "The checked value that was set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fires when this item is clicked", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Fires when this item is activated", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "deactivate", + "desc" : "Fires when this item is deactivated", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.menu.ColorItem.json b/docs2/symbols/Roo.menu.ColorItem.json new file mode 100644 index 0000000000..f24cbaa058 --- /dev/null +++ b/docs2/symbols/Roo.menu.ColorItem.json @@ -0,0 +1,920 @@ +{ + "name" : "Roo.menu.ColorItem", + "augments" : [ + "Roo.menu.Adapter", + "Roo.menu.BaseItem", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "A menu item that wraps the {@link Roo.ColorPalette} component.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "activeClass", + "type" : "String", + "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to prevent creation of this menu item (defaults to false)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideOnClick", + "type" : "Boolean", + "desc" : "True to hide the containing menu after this item is clicked (defaults to true)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "canActivate", + "type" : "Boolean", + "desc" : "True if this item can be visually activated (defaults to false)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "Fires when this item is clicked", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Fires when this item is activated", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "deactivate", + "desc" : "Fires when this item is deactivated", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.menu.ColorMenu.json b/docs2/symbols/Roo.menu.ColorMenu.json new file mode 100644 index 0000000000..3636b17707 --- /dev/null +++ b/docs2/symbols/Roo.menu.ColorMenu.json @@ -0,0 +1,942 @@ +{ + "name" : "Roo.menu.ColorMenu", + "augments" : [ + "Roo.menu.Menu", + "Roo.util.Observable" + ], + "desc" : "A menu containing a {@link Roo.menu.ColorItem} component (which provides a basic color picker).", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + }, + { + "name" : "subMenuAlign", + "type" : "String", + "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + }, + { + "name" : "defaultAlign", + "type" : "String", + "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum width of the menu in pixels (defaults to 120)", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + }, + { + "name" : "registerMenu", + "type" : "Boolean", + "desc" : "True (default) - means that clicking on screen etc. hides it.", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + }, + { + "name" : "allowOtherMenus", + "type" : "Boolean", + "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "addMenuItem", + "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "A MenuItem config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "addElement", + "desc" : "Adds an {@link Roo.Element} object to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element or DOM node to add, or its id", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "isVisible", + "desc" : "Read-only. Returns true if the menu is currently displayed, else false.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "add", + "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n
      \n
    • Any menu item object based on {@link Roo.menu.Item}
    • \n
    • An HTMLElement object which will be converted to a menu item
    • \n
    • A menu item config object that will be created as a new menu item
    • \n
    • A string, which can either be '-' or 'separator' to add a menu separator, otherwise\nit will be converted into a {@link Roo.menu.TextItem} and added
    • \n
    \nUsage:\n
    \n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n    menuItem,                // add existing item by ref\n    'Dynamic Item',          // new TextItem\n    '-',                     // new separator\n    { text: 'Config Item' }  // new item by config\n);\n
    ", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "args", + "type" : "Mixed", + "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added, or the last one if multiple items were added" + } + ] + }, + { + "name" : "addSeparator", + "desc" : "Adds a separator bar to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "removeAll", + "desc" : "Removes and destroys all items in the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to remove", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns this menu's underlying {@link Roo.Element} object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "insert", + "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index in the menu's list of current items where the new item should be inserted", + "isOptional" : false + }, + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "hide", + "desc" : "Hides this menu and optionally all parent menus", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Displays this menu relative to another element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)", + "isOptional" : false + }, + { + "name" : "parentMenu", + "type" : "Roo.menu.Menu", + "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addText", + "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The text to display in the menu item", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "addItem", + "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "showAt", + "desc" : "Displays this menu at a specific xy position", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "xyPosition", + "type" : "Array", + "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "parentMenu", + "type" : "Roo.menu.Menu", + "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "select", + "desc" : "", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "palette", + "type" : "ColorPalette", + "desc" : "", + "isOptional" : false + }, + { + "name" : "color", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseover", + "desc" : "Fires when the mouse is hovering over this menu", + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseout", + "desc" : "Fires when the mouse exits this menu", + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before this menu is hidden", + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "itemclick", + "desc" : "Fires when a menu item contained in this menu is clicked", + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "baseItem", + "type" : "Roo.menu.BaseItem", + "desc" : "The BaseItem that was clicked", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before this menu is displayed", + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after this menu is hidden", + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after this menu is displayed", + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.menu.DateItem.json b/docs2/symbols/Roo.menu.DateItem.json new file mode 100644 index 0000000000..307b9ae236 --- /dev/null +++ b/docs2/symbols/Roo.menu.DateItem.json @@ -0,0 +1,920 @@ +{ + "name" : "Roo.menu.DateItem", + "augments" : [ + "Roo.menu.Adapter", + "Roo.menu.BaseItem", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "A menu item that wraps the {@link Roo.DatPicker} component.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "activeClass", + "type" : "String", + "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to prevent creation of this menu item (defaults to false)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideOnClick", + "type" : "Boolean", + "desc" : "True to hide the containing menu after this item is clicked (defaults to true)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "canActivate", + "type" : "Boolean", + "desc" : "True if this item can be visually activated (defaults to false)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "Fires when this item is clicked", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Fires when this item is activated", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "deactivate", + "desc" : "Fires when this item is deactivated", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.menu.DateMenu.json b/docs2/symbols/Roo.menu.DateMenu.json new file mode 100644 index 0000000000..5ee1436131 --- /dev/null +++ b/docs2/symbols/Roo.menu.DateMenu.json @@ -0,0 +1,942 @@ +{ + "name" : "Roo.menu.DateMenu", + "augments" : [ + "Roo.menu.Menu", + "Roo.util.Observable" + ], + "desc" : "A menu containing a {@link Roo.menu.DateItem} component (which provides a date picker).", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + }, + { + "name" : "defaultAlign", + "type" : "String", + "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + }, + { + "name" : "subMenuAlign", + "type" : "String", + "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum width of the menu in pixels (defaults to 120)", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + }, + { + "name" : "registerMenu", + "type" : "Boolean", + "desc" : "True (default) - means that clicking on screen etc. hides it.", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + }, + { + "name" : "allowOtherMenus", + "type" : "Boolean", + "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "addMenuItem", + "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "A MenuItem config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "addElement", + "desc" : "Adds an {@link Roo.Element} object to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element or DOM node to add, or its id", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "isVisible", + "desc" : "Read-only. Returns true if the menu is currently displayed, else false.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "add", + "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n
      \n
    • Any menu item object based on {@link Roo.menu.Item}
    • \n
    • An HTMLElement object which will be converted to a menu item
    • \n
    • A menu item config object that will be created as a new menu item
    • \n
    • A string, which can either be '-' or 'separator' to add a menu separator, otherwise\nit will be converted into a {@link Roo.menu.TextItem} and added
    • \n
    \nUsage:\n
    \n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n    menuItem,                // add existing item by ref\n    'Dynamic Item',          // new TextItem\n    '-',                     // new separator\n    { text: 'Config Item' }  // new item by config\n);\n
    ", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "args", + "type" : "Mixed", + "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added, or the last one if multiple items were added" + } + ] + }, + { + "name" : "addSeparator", + "desc" : "Adds a separator bar to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "removeAll", + "desc" : "Removes and destroys all items in the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to remove", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns this menu's underlying {@link Roo.Element} object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "insert", + "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index in the menu's list of current items where the new item should be inserted", + "isOptional" : false + }, + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "hide", + "desc" : "Hides this menu and optionally all parent menus", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Displays this menu relative to another element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)", + "isOptional" : false + }, + { + "name" : "parentMenu", + "type" : "Roo.menu.Menu", + "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addText", + "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The text to display in the menu item", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "addItem", + "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "showAt", + "desc" : "Displays this menu at a specific xy position", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "xyPosition", + "type" : "Array", + "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "parentMenu", + "type" : "Roo.menu.Menu", + "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "select", + "desc" : "", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "picker", + "type" : "DatePicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Date", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseover", + "desc" : "Fires when the mouse is hovering over this menu", + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseout", + "desc" : "Fires when the mouse exits this menu", + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before this menu is hidden", + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "itemclick", + "desc" : "Fires when a menu item contained in this menu is clicked", + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "baseItem", + "type" : "Roo.menu.BaseItem", + "desc" : "The BaseItem that was clicked", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before this menu is displayed", + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after this menu is hidden", + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after this menu is displayed", + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.menu.Item.json b/docs2/symbols/Roo.menu.Item.json new file mode 100644 index 0000000000..ea5a5135fa --- /dev/null +++ b/docs2/symbols/Roo.menu.Item.json @@ -0,0 +1,987 @@ +{ + "name" : "Roo.menu.Item", + "augments" : [ + "Roo.menu.BaseItem", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "A base class for all menu items that require menu-related functionality (like sub-menus) and are not static\ndisplay items. Item extends the base functionality of {@link Roo.menu.BaseItem} by adding menu-specific\nactivation and click handling.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "showDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before showing this item (defaults to 200)", + "memberOf" : "Roo.menu.Item", + "values" : [ + ] + }, + { + "name" : "text", + "type" : "String", + "desc" : "The text to show on the menu item.", + "memberOf" : "Roo.menu.Item", + "values" : [ + ] + }, + { + "name" : "activeClass", + "type" : "String", + "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to prevent creation of this menu item (defaults to false)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideOnClick", + "type" : "Boolean", + "desc" : "True to hide the containing menu after this item is clicked (defaults to true)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "itemCls", + "type" : "String", + "desc" : "The default CSS class to use for menu items (defaults to \"x-menu-item\")", + "memberOf" : "Roo.menu.Item", + "values" : [ + ] + }, + { + "name" : "HTML", + "type" : "String", + "desc" : "to render in menu\nThe text to show on the menu item (HTML version).", + "memberOf" : "Roo.menu.Item", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "canActivate", + "type" : "Boolean", + "desc" : "True if this item can be visually activated (defaults to true)", + "memberOf" : "Roo.menu.Item", + "values" : [ + ] + }, + { + "name" : "icon", + "type" : "String", + "desc" : "The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)", + "memberOf" : "Roo.menu.Item", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "setText", + "desc" : "Sets the text to display in this menu item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The text to display", + "isOptional" : false + }, + { + "name" : "isHTML", + "type" : "Boolean", + "desc" : "true to indicate text is pure html.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "Fires when this item is clicked", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Fires when this item is activated", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "deactivate", + "desc" : "Fires when this item is deactivated", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.menu.Menu.json b/docs2/symbols/Roo.menu.Menu.json new file mode 100644 index 0000000000..ea2211f3fd --- /dev/null +++ b/docs2/symbols/Roo.menu.Menu.json @@ -0,0 +1,916 @@ +{ + "name" : "Roo.menu.Menu", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "A menu object. This is the container to which you add all other menu items. Menu can also serve a as a base class\nwhen you want a specialzed menu based off of another component (like {@link Roo.menu.DateMenu} for example).", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + }, + { + "name" : "defaultAlign", + "type" : "String", + "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + }, + { + "name" : "subMenuAlign", + "type" : "String", + "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum width of the menu in pixels (defaults to 120)", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + }, + { + "name" : "registerMenu", + "type" : "Boolean", + "desc" : "True (default) - means that clicking on screen etc. hides it.", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + }, + { + "name" : "allowOtherMenus", + "type" : "Boolean", + "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "addMenuItem", + "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "A MenuItem config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "addElement", + "desc" : "Adds an {@link Roo.Element} object to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element or DOM node to add, or its id", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "isVisible", + "desc" : "Read-only. Returns true if the menu is currently displayed, else false.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "add", + "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n
      \n
    • Any menu item object based on {@link Roo.menu.Item}
    • \n
    • An HTMLElement object which will be converted to a menu item
    • \n
    • A menu item config object that will be created as a new menu item
    • \n
    • A string, which can either be '-' or 'separator' to add a menu separator, otherwise\nit will be converted into a {@link Roo.menu.TextItem} and added
    • \n
    \nUsage:\n
    \n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n    menuItem,                // add existing item by ref\n    'Dynamic Item',          // new TextItem\n    '-',                     // new separator\n    { text: 'Config Item' }  // new item by config\n);\n
    ", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "args", + "type" : "Mixed", + "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added, or the last one if multiple items were added" + } + ] + }, + { + "name" : "addSeparator", + "desc" : "Adds a separator bar to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "removeAll", + "desc" : "Removes and destroys all items in the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to remove", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns this menu's underlying {@link Roo.Element} object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "insert", + "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index in the menu's list of current items where the new item should be inserted", + "isOptional" : false + }, + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "hide", + "desc" : "Hides this menu and optionally all parent menus", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Displays this menu relative to another element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)", + "isOptional" : false + }, + { + "name" : "parentMenu", + "type" : "Roo.menu.Menu", + "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addText", + "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The text to display in the menu item", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "addItem", + "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "showAt", + "desc" : "Displays this menu at a specific xy position", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "xyPosition", + "type" : "Array", + "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "parentMenu", + "type" : "Roo.menu.Menu", + "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "mouseover", + "desc" : "Fires when the mouse is hovering over this menu", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseout", + "desc" : "Fires when the mouse exits this menu", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before this menu is hidden", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "itemclick", + "desc" : "Fires when a menu item contained in this menu is clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "baseItem", + "type" : "Roo.menu.BaseItem", + "desc" : "The BaseItem that was clicked", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before this menu is displayed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after this menu is hidden", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after this menu is displayed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.menu.MenuMgr.json b/docs2/symbols/Roo.menu.MenuMgr.json new file mode 100644 index 0000000000..eacbad6f6f --- /dev/null +++ b/docs2/symbols/Roo.menu.MenuMgr.json @@ -0,0 +1,53 @@ +{ + "name" : "Roo.menu.MenuMgr", + "augments" : [ + ], + "desc" : "Provides a common registry of all menu items on a page so that they can be easily accessed by id.", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "hideAll", + "desc" : "Hides all menus that are currently visible", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.MenuMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "get", + "desc" : "Returns a {@link Roo.menu.Menu} object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.MenuMgr", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "menu", + "type" : "String/Object", + "desc" : "The string menu id, an existing menu object reference, or a Menu config that will\nbe used to generate and return a new Menu instance.", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.menu.Separator.json b/docs2/symbols/Roo.menu.Separator.json new file mode 100644 index 0000000000..5cd1cfa138 --- /dev/null +++ b/docs2/symbols/Roo.menu.Separator.json @@ -0,0 +1,927 @@ +{ + "name" : "Roo.menu.Separator", + "augments" : [ + "Roo.menu.BaseItem", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Adds a separator bar to a menu, used to divide logical groups of menu items. Generally you will\nadd one of these by using \"-\" in you call to add() or in your items config rather than creating one directly.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "activeClass", + "type" : "String", + "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to prevent creation of this menu item (defaults to false)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "hideOnClick", + "type" : "Boolean", + "desc" : "True to hide the containing menu after this item is clicked (defaults to false)", + "memberOf" : "Roo.menu.Separator", + "values" : [ + ] + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "itemCls", + "type" : "String", + "desc" : "The default CSS class to use for separators (defaults to \"x-menu-sep\")", + "memberOf" : "Roo.menu.Separator", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "canActivate", + "type" : "Boolean", + "desc" : "True if this item can be visually activated (defaults to false)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "Fires when this item is clicked", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Fires when this item is activated", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "deactivate", + "desc" : "Fires when this item is deactivated", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.menu.TextItem.json b/docs2/symbols/Roo.menu.TextItem.json new file mode 100644 index 0000000000..44a72f83b0 --- /dev/null +++ b/docs2/symbols/Roo.menu.TextItem.json @@ -0,0 +1,935 @@ +{ + "name" : "Roo.menu.TextItem", + "augments" : [ + "Roo.menu.BaseItem", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Adds a static text string to a menu, usually used as either a heading or group separator.\nNote: old style constructor with text is still supported.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "text", + "type" : "Boolean", + "desc" : "Text to show on item.", + "memberOf" : "Roo.menu.TextItem", + "values" : [ + ] + }, + { + "name" : "activeClass", + "type" : "String", + "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to prevent creation of this menu item (defaults to false)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "hideOnClick", + "type" : "Boolean", + "desc" : "True to hide the containing menu after this item is clicked (defaults to false)", + "memberOf" : "Roo.menu.TextItem", + "values" : [ + ] + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "hideDelay", + "type" : "Number", + "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "itemCls", + "type" : "String", + "desc" : "The default CSS class to use for text items (defaults to \"x-menu-text\")", + "memberOf" : "Roo.menu.TextItem", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "canActivate", + "type" : "Boolean", + "desc" : "True if this item can be visually activated (defaults to false)", + "memberOf" : "Roo.menu.BaseItem", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "click", + "desc" : "Fires when this item is clicked", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "activate", + "desc" : "Fires when this item is activated", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "deactivate", + "desc" : "Fires when this item is deactivated", + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.menu.json b/docs2/symbols/Roo.menu.json new file mode 100644 index 0000000000..d82865e014 --- /dev/null +++ b/docs2/symbols/Roo.menu.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.menu", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.state.CookieProvider.json b/docs2/symbols/Roo.state.CookieProvider.json new file mode 100644 index 0000000000..f8c3b3b53c --- /dev/null +++ b/docs2/symbols/Roo.state.CookieProvider.json @@ -0,0 +1,216 @@ +{ + "name" : "Roo.state.CookieProvider", + "augments" : [ + "Roo.state.Provider" + ], + "desc" : "The default Provider implementation which saves state via cookies.\n
    Usage:\n
    \n   var cp = new Roo.state.CookieProvider({\n       path: \"/cgi-bin/\",\n       expires: new Date(new Date().getTime()+(1000*60*60*24*30)); //30 days\n       domain: \"roojs.com\"\n   })\n   Roo.state.Manager.setProvider(cp);\n 
    ", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "path", + "type" : "String", + "desc" : "The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)", + "memberOf" : "Roo.state.CookieProvider", + "values" : [ + ] + }, + { + "name" : "secure", + "type" : "Boolean", + "desc" : "True if the site is using SSL (defaults to false)", + "memberOf" : "Roo.state.CookieProvider", + "values" : [ + ] + }, + { + "name" : "domain", + "type" : "String", + "desc" : "The domain to save the cookie for. Note that you cannot specify a different domain than\nyour page is on, but you can specify a sub-domain, or simply the domain itself like 'roojs.com' to include\nall sub-domains if you need to access cookies across different sub-domains (defaults to null which uses the same\ndomain the page is running on including the 'www' like 'www.roojs.com')", + "memberOf" : "Roo.state.CookieProvider", + "values" : [ + ] + }, + { + "name" : "expires", + "type" : "Date", + "desc" : "The cookie expiration date (defaults to 7 days from now)", + "memberOf" : "Roo.state.CookieProvider", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "clear", + "desc" : "Clears a value from the state", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.state.Provider", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The key name", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "decodeValue", + "desc" : "Decodes a string previously encoded with {@link #encodeValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.state.Provider", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value to decode", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "The decoded value" + } + ] + }, + { + "name" : "get", + "desc" : "Returns the current value for a key", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.state.Provider", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The key name", + "isOptional" : false + }, + { + "name" : "defaultValue", + "type" : "Mixed", + "desc" : "A default value to return if the key's value is not found", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "The state data" + } + ] + }, + { + "name" : "set", + "desc" : "Sets the value for a key", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.state.Provider", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The key name", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "encodeValue", + "desc" : "Encodes a value including type information. Decode with {@link #decodeValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.state.Provider", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to encode", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The encoded value" + } + ] + } + ], + "events" : [ + { + "name" : "statechange", + "desc" : "Fires when a state change occurs.", + "memberOf" : "Roo.state.Provider", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Provider", + "desc" : "This state provider", + "isOptional" : false + }, + { + "name" : "key", + "type" : "String", + "desc" : "The state key which was changed", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String", + "desc" : "The encoded value for the state", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.state.Manager.json b/docs2/symbols/Roo.state.Manager.json new file mode 100644 index 0000000000..e4fe69b51a --- /dev/null +++ b/docs2/symbols/Roo.state.Manager.json @@ -0,0 +1,141 @@ +{ + "name" : "Roo.state.Manager", + "augments" : [ + ], + "desc" : "This is the global state manager. By default all components that are \"state aware\" check this class\nfor state information if you don't pass them a custom state provider. In order for this class\nto be useful, it must be initialized with a provider when your application initializes.\n
    \n// in your initialization function\ninit : function(){\n   Roo.state.Manager.setProvider(new Roo.state.CookieProvider());\n   ...\n   // supposed you have a {@link Roo.BorderLayout}\n   var layout = new Roo.BorderLayout(...);\n   layout.restoreState();\n   // or a {Roo.BasicDialog}\n   var dialog = new Roo.BasicDialog(...);\n   dialog.restoreState();\n 
    ", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "getProvider", + "desc" : "Gets the currently configured state provider", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.state.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Provider", + "desc" : "The state provider" + } + ] + }, + { + "name" : "clear", + "desc" : "Clears a value from the state", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.state.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The key name", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "get", + "desc" : "Returns the current value for a key", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.state.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The key name", + "isOptional" : false + }, + { + "name" : "defaultValue", + "type" : "Mixed", + "desc" : "The default value to return if the key lookup does not match", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "The state data" + } + ] + }, + { + "name" : "set", + "desc" : "Sets the value for a key", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.state.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The key name", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The state data", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setProvider", + "desc" : "Configures the default state provider for your application", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.state.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "stateProvider", + "type" : "Provider", + "desc" : "The state provider to set", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.state.Provider.json b/docs2/symbols/Roo.state.Provider.json new file mode 100644 index 0000000000..e970ddbc05 --- /dev/null +++ b/docs2/symbols/Roo.state.Provider.json @@ -0,0 +1,183 @@ +{ + "name" : "Roo.state.Provider", + "augments" : [ + ], + "desc" : "Abstract base class for state provider implementations. This class provides methods\nfor encoding and decoding typed variables including dates and defines the \nProvider interface.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "clear", + "desc" : "Clears a value from the state", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.state.Provider", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The key name", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "decodeValue", + "desc" : "Decodes a string previously encoded with {@link #encodeValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.state.Provider", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value to decode", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "The decoded value" + } + ] + }, + { + "name" : "get", + "desc" : "Returns the current value for a key", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.state.Provider", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The key name", + "isOptional" : false + }, + { + "name" : "defaultValue", + "type" : "Mixed", + "desc" : "A default value to return if the key's value is not found", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "The state data" + } + ] + }, + { + "name" : "set", + "desc" : "Sets the value for a key", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.state.Provider", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The key name", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "encodeValue", + "desc" : "Encodes a value including type information. Decode with {@link #decodeValue}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.state.Provider", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to encode", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The encoded value" + } + ] + } + ], + "events" : [ + { + "name" : "statechange", + "desc" : "Fires when a state change occurs.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Provider", + "desc" : "This state provider", + "isOptional" : false + }, + { + "name" : "key", + "type" : "String", + "desc" : "The state key which was changed", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String", + "desc" : "The encoded value for the state", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.state.json b/docs2/symbols/Roo.state.json new file mode 100644 index 0000000000..ca027e0d32 --- /dev/null +++ b/docs2/symbols/Roo.state.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.state", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.tree.AsyncTreeNode.json b/docs2/symbols/Roo.tree.AsyncTreeNode.json new file mode 100644 index 0000000000..5312f961d5 --- /dev/null +++ b/docs2/symbols/Roo.tree.AsyncTreeNode.json @@ -0,0 +1,2007 @@ +{ + "name" : "Roo.tree.AsyncTreeNode", + "augments" : [ + "Roo.tree.TreeNode", + "Roo.data.Node", + "Roo.util.Observable" + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "hrefTarget", + "type" : "String", + "desc" : "target frame for the link", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id for this node. If one is not specified, one is generated.", + "memberOf" : "Roo.data.Node", + "values" : [ + ] + }, + { + "name" : "text", + "type" : "String", + "desc" : "The text for this node", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "uiProvider", + "type" : "Function", + "desc" : "A UI class to use for this node (defaults to Roo.tree.TreeNodeUI)", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "expanded", + "type" : "Boolean", + "desc" : "true to start the node expanded", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "qtipCfg", + "type" : "String", + "desc" : "An Ext QuickTip config for the node (used instead of qtip)", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "allowDrop", + "type" : "Boolean", + "desc" : "false if this node cannot be drop on", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "true to start the node disabled", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A css class to be added to the node", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "iconCls", + "type" : "String", + "desc" : "A css class to be added to the nodes icon element for applying css background images", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "allowDrag", + "type" : "Boolean", + "desc" : "false to make this node undraggable if DD is on (defaults to true)", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "loader", + "type" : "TreeLoader", + "desc" : "A TreeLoader to be used by this node (defaults to the loader defined on the tree)", + "memberOf" : "Roo.tree.AsyncTreeNode", + "values" : [ + ] + }, + { + "name" : "icon", + "type" : "String", + "desc" : "The path to an icon for the node. The preferred way to do this", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "singleClickExpand", + "type" : "Boolean", + "desc" : "True for single click expand on this node", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "An Ext QuickTip for the node", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "True to render a checked checkbox for this node, false to render an unchecked checkbox\n(defaults to undefined with no checkbox rendered)", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "href", + "type" : "String", + "desc" : "URL of the link used for the node (defaults to #)", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "leaf", + "type" : "Boolean", + "desc" : "true if this node is a leaf and does not have children", + "memberOf" : "Roo.data.Node", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "isLoaded", + "desc" : "Returns true if this node has been loaded", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.AsyncTreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "isLoading", + "desc" : "Returns true if this node is currently loading", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.AsyncTreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "reload", + "desc" : "Trigger a reload for this node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.AsyncTreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "callback", + "type" : "Function", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "select", + "desc" : "Triggers selection of this node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Enables this node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "collapseChildNodes", + "desc" : "Collapse all child nodes", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) true if the child nodes should also collapse their child nodes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "ensureVisible", + "desc" : "Ensures all parent nodes are expanded", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isSelected", + "desc" : "Returns true if this node is selected", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "disable", + "desc" : "Disables this node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getUI", + "desc" : "Returns the UI object for this node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "TreeNodeUI", + "desc" : "" + } + ] + }, + { + "name" : "setText", + "desc" : "Sets the text for this node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toggle", + "desc" : "Toggles expanded/collapsed state of the node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "unselect", + "desc" : "Triggers deselection of this node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isExpanded", + "desc" : "Returns true if this node is expanded", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "expandChildNodes", + "desc" : "Expand all child nodes", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) true if the child nodes should also expand their child nodes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "expand", + "desc" : "Expand this node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to expand all children as well", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "(optional) false to cancel the default animation", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) A callback to be called when\nexpanding this node completes (does not wait for deep expand to complete).\nCalled with 1 parameter, this node.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collapse", + "desc" : "Collapse this node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to collapse all children as well", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "(optional) false to cancel the default animation", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "sort", + "desc" : "Sorts this nodes children using the supplied sort function", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeChild", + "desc" : "Removes a child node from this node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node to remove", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The removed node" + } + ] + }, + { + "name" : "isAncestor", + "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "contains", + "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "cascade", + "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to current node)", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) The args to call the function with (default to passing the current node)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getDepth", + "desc" : "Returns depth of this node (the root node has a depth of 0)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "getPath", + "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "attr", + "type" : "String", + "desc" : "(optional) The attr to use for the path (defaults to the node's id)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The path" + } + ] + }, + { + "name" : "indexOf", + "desc" : "Returns the index of a child node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the node or -1 if it was not found" + } + ] + }, + { + "name" : "isFirst", + "desc" : "Returns true if this node is the first child of its parent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "isLast", + "desc" : "Returns true if this node is the last child of its parent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "isLeaf", + "desc" : "Returns true if this node is a leaf", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "insertBefore", + "desc" : "Inserts the first node before the second node in this nodes childNodes collection.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node to insert", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The node to insert before (if null the node is appended)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The inserted node" + } + ] + }, + { + "name" : "item", + "desc" : "Returns the child node at the specified index.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "" + } + ] + }, + { + "name" : "getOwnerTree", + "desc" : "Returns the tree this node is in.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Tree", + "desc" : "" + } + ] + }, + { + "name" : "appendChild", + "desc" : "Insert node(s) as the last child node of this node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node/Array", + "desc" : "The node or Array of nodes to append", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The appended node if single append, or null if an array was passed" + } + ] + }, + { + "name" : "findChildBy", + "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The found child or null if none was found" + } + ] + }, + { + "name" : "replaceChild", + "desc" : "Replaces one child node in this node with another.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "newChild", + "type" : "Node", + "desc" : "The replacement node", + "isOptional" : false + }, + { + "name" : "oldChild", + "type" : "Node", + "desc" : "The node to replace", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The replaced node" + } + ] + }, + { + "name" : "bubble", + "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to current node)", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) The args to call the function with (default to passing the current node)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "eachChild", + "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to current node)", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) The args to call the function with (default to passing the current node)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "findChild", + "desc" : "Finds the first child that has the attribute with the specified value.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "attribute", + "type" : "String", + "desc" : "The attribute name", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to search for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The found child or null if none was found" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "load", + "desc" : "Fires when this node is loaded", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeload", + "desc" : "Fires before this node is loaded, return false to cancel", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforecollapse", + "desc" : "Fires before this node is collapsed, return false to cancel.", + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "deep", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dblclick", + "desc" : "Fires when this node is double clicked", + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disabledchange", + "desc" : "Fires when the disabled status of this node changes", + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforechildrenrendered", + "desc" : "Fires right before the child nodes for this node are rendered", + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeclick", + "desc" : "Fires before click processing. Return false to cancel the default action.", + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "checkchange", + "desc" : "Fires when a node with a checkbox's checked property changes", + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collapse", + "desc" : "Fires when this node is collapsed", + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "textchange", + "desc" : "Fires when the text for this node is changed", + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "text", + "type" : "String", + "desc" : "The new text", + "isOptional" : false + }, + { + "name" : "oldText", + "type" : "String", + "desc" : "The old text", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeexpand", + "desc" : "Fires before this node is expanded, return false to cancel.", + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "deep", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fires when this node is clicked", + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "contextmenu", + "desc" : "Fires when this node is right clicked", + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "expand", + "desc" : "Fires when this node is expanded", + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeappend", + "desc" : "Fires before a new child is appended, return false to cancel the append.", + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be appended", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires when this node is moved to a new location in the tree", + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The old parent of this node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent of this node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it was moved to", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "append", + "desc" : "Fires when a new child node is appended", + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The newly appended node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the newly appended node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeremove", + "desc" : "Fires before a child is removed, return false to cancel the remove.", + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be removed", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Fires when a child node is removed", + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The removed node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeinsert", + "desc" : "Fires before a new child is inserted, return false to cancel the insert.", + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node is being inserted before", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "insert", + "desc" : "Fires when a new child node is inserted.", + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node was inserted before", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforemove", + "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.", + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The parent of this node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent this node is moving to", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it is being moved to", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.tree.ColumnTree.json b/docs2/symbols/Roo.tree.ColumnTree.json new file mode 100644 index 0000000000..b3930f7987 --- /dev/null +++ b/docs2/symbols/Roo.tree.ColumnTree.json @@ -0,0 +1,56 @@ +{ + "name" : "Roo.tree.ColumnTree", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "columns", + "type" : "Object", + "desc" : "Including width, header, renderer, cls, dataIndex", + "memberOf" : "Roo.tree.ColumnTree", + "values" : [ + ] + }, + { + "name" : "borderWidth", + "type" : "int", + "desc" : "compined right/left border allowance", + "memberOf" : "Roo.tree.ColumnTree", + "values" : [ + ] + } + ], + "methods" : [ + ], + "events" : [ + { + "name" : "resize", + "desc" : "Fire this event on a container when it resizes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "w", + "type" : "int", + "desc" : "Width", + "isOptional" : false + }, + { + "name" : "h", + "type" : "int", + "desc" : "Height", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.tree.DefaultSelectionModel.json b/docs2/symbols/Roo.tree.DefaultSelectionModel.json new file mode 100644 index 0000000000..d5dd16493b --- /dev/null +++ b/docs2/symbols/Roo.tree.DefaultSelectionModel.json @@ -0,0 +1,537 @@ +{ + "name" : "Roo.tree.DefaultSelectionModel", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "The default single selection for a TreePanel.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getSelectedNode", + "desc" : "Get the selected node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.DefaultSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "TreeNode", + "desc" : "The selected node" + } + ] + }, + { + "name" : "clearSelections", + "desc" : "Clear all selections", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.DefaultSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isSelected", + "desc" : "Returns true if the node is selected", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.DefaultSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "TreeNode", + "desc" : "The node to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "selectPrevious", + "desc" : "Selects the node above the selected node in the tree, intelligently walking the nodes", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.DefaultSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "TreeNode The new selection" + } + ] + }, + { + "name" : "unselect", + "desc" : "Deselect a node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.DefaultSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "TreeNode", + "desc" : "The node to unselect", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "select", + "desc" : "Select a node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.DefaultSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "TreeNode", + "desc" : "The node to select", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "TreeNode", + "desc" : "The selected node" + } + ] + }, + { + "name" : "selectNext", + "desc" : "Selects the node above the selected node in the tree, intelligently walking the nodes", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.DefaultSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "TreeNode The new selection" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "selectionchange", + "desc" : "Fires when the selected node changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "DefaultSelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "node", + "type" : "TreeNode", + "desc" : "the new selection", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeselect", + "desc" : "Fires before the selected node changes, return false to cancel the change", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "DefaultSelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "node", + "type" : "TreeNode", + "desc" : "the new selection", + "isOptional" : false + }, + { + "name" : "node", + "type" : "TreeNode", + "desc" : "the old selection", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.tree.MultiSelectionModel.json b/docs2/symbols/Roo.tree.MultiSelectionModel.json new file mode 100644 index 0000000000..f3aa29b67c --- /dev/null +++ b/docs2/symbols/Roo.tree.MultiSelectionModel.json @@ -0,0 +1,476 @@ +{ + "name" : "Roo.tree.MultiSelectionModel", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "Multi selection for a TreePanel.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getSelectedNodes", + "desc" : "Returns an array of the selected nodes", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.MultiSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "" + } + ] + }, + { + "name" : "clearSelections", + "desc" : "Clear all selections", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.MultiSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isSelected", + "desc" : "Returns true if the node is selected", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.MultiSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "TreeNode", + "desc" : "The node to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "unselect", + "desc" : "Deselect a node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.MultiSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "TreeNode", + "desc" : "The node to unselect", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "select", + "desc" : "Select a node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.MultiSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "TreeNode", + "desc" : "The node to select", + "isOptional" : false + }, + { + "name" : "e", + "type" : "EventObject", + "desc" : "(optional) An event associated with the selection", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "True to retain existing selections", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "TreeNode", + "desc" : "The selected node" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "selectionchange", + "desc" : "Fires when the selected nodes change", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "MultiSelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "nodes", + "type" : "Array", + "desc" : "Array of the selected nodes", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.tree.TreeEditor.json b/docs2/symbols/Roo.tree.TreeEditor.json new file mode 100644 index 0000000000..6ad5c9c3de --- /dev/null +++ b/docs2/symbols/Roo.tree.TreeEditor.json @@ -0,0 +1,1263 @@ +{ + "name" : "Roo.tree.TreeEditor", + "augments" : [ + "Roo.Editor", + "Roo.Component", + "Roo.util.Observable" + ], + "desc" : "Provides editor functionality for inline tree node editing. Any valid {@link Roo.form.Field} can be used\nas the editor field.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "alignment", + "type" : "String", + "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"l-l\").", + "memberOf" : "Roo.tree.TreeEditor", + "values" : [ + ] + }, + { + "name" : "hideEl", + "type" : "Boolean", + "desc" : "True to hide the bound element while the editor is displayed (defaults to false)", + "memberOf" : "Roo.tree.TreeEditor", + "values" : [ + ] + }, + { + "name" : "maxWidth", + "type" : "Number", + "desc" : "The maximum width in pixels of the editor field (defaults to 250). Note that if the maxWidth would exceed\nthe containing tree element's size, it will be automatically limited for you to the container width, taking\nscroll and client offsets into account prior to each edit.", + "memberOf" : "Roo.tree.TreeEditor", + "values" : [ + ] + }, + { + "name" : "constrain", + "type" : "Boolean", + "desc" : "True to constrain the editor to the viewport", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "\"sides\" for sides/bottom only, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"frame\")", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "field", + "type" : "Roo.form.TextField|Object", + "desc" : "The field configuration", + "memberOf" : "Roo.tree.TreeEditor", + "values" : [ + ] + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "memberOf" : "Roo.Component", + "values" : [ + "(display", + "visibility)" + ] + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The data value of the underlying field (defaults to \"\")", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "CSS class to apply to the editor (defaults to \"x-small-editor x-tree-editor\")", + "memberOf" : "Roo.tree.TreeEditor", + "values" : [ + ] + }, + { + "name" : "shim", + "type" : "Boolean", + "desc" : "True to shim the editor if selects/iframes could be displayed beneath it (defaults to false)", + "memberOf" : "Roo.tree.TreeEditor", + "values" : [ + ] + }, + { + "name" : "cancelOnEsc", + "type" : "Boolean", + "desc" : "True to cancel the edit when the escape key is pressed (defaults to false)", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "completeOnEnter", + "type" : "Boolean", + "desc" : "True to complete the edit when the enter key is pressed (defaults to false)", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "revertInvalid", + "type" : "Boolean", + "desc" : "True to automatically revert the field value and cancel the edit when the user completes an edit and the field\nvalidation fails (defaults to true)", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "tree", + "type" : "Roo.tree.TreePanel", + "desc" : "The tree to bind to.", + "memberOf" : "Roo.tree.TreeEditor", + "values" : [ + ] + }, + { + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component", + "values" : [ + ] + }, + { + "name" : "ignoreNoChange", + "type" : "Boolean", + "desc" : "True to skip the the edit completion process (no save, no events fired) if the user completes an edit and\nthe value has not changed (defaults to false). Applies only to string values - edits for other data types\nwill never be ignored.", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "autosize", + "type" : "Boolean/String", + "desc" : "True for the editor to automatically adopt the size of the underlying field, \"width\" to adopt the width only,\nor \"height\" to adopt the height only (defaults to false)", + "memberOf" : "Roo.Editor", + "values" : [ + ] + }, + { + "name" : "updateEl", + "type" : "Boolean", + "desc" : "True to update the innerHTML of the bound element when the update completes (defaults to false)", + "memberOf" : "Roo.Editor", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "cancelEdit", + "desc" : "Cancels the editing process and hides the editor without persisting any changes. The field value will be\nreverted to the original starting value.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "remainVisible", + "type" : "Boolean", + "desc" : "Override the default behavior and keep the editor visible after\ncancel (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setSize", + "desc" : "Sets the height and width of this editor.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "width", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "realign", + "desc" : "Realigns the editor to the bound field based on the current alignment config value.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getValue", + "desc" : "Gets the data value of the editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "The data value" + } + ] + }, + { + "name" : "completeEdit", + "desc" : "Ends the editing process, persists the changed value to the underlying field, and hides the editor.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "remainVisible", + "type" : "Boolean", + "desc" : "Override the default behavior and keep the editor visible after edit (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "setValue", + "desc" : "Sets the data value of the editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "Any valid value supported by the underlying field", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "startEdit", + "desc" : "Starts the editing process and shows the editor.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The element to edit", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String", + "desc" : "(optional) A value to initialize the editor with. If a value is not provided, it defaults\nto the innerHTML of el.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getId", + "desc" : "Returns the id of this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "name" : "render", + "desc" : "If this is a lazy rendering component, render it to its container element.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isVisible", + "desc" : "Returns true if this component is visible.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setDisabled", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Hide this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "focus", + "desc" : "Try to focus this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selectText", + "type" : "Boolean", + "desc" : "True to also select the text in this component (if applicable)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "show", + "desc" : "Show this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "enable", + "desc" : "Enable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "desc" : "Convenience function to hide or show this component by boolean.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "desc" : "Disable this component.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "desc" : "Returns the underlying {@link Roo.Element}.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforenodeedit", + "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Editor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Roo.tree.Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforestartedit", + "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.", + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Editor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "boundEl", + "type" : "Roo.Element", + "desc" : "The underlying element bound to this editor", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The field value being set", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforecomplete", + "desc" : "Fires after a change has been made to the field, but before the change is reflected in the underlying\nfield. Saving the change to the field can be canceled by returning false from the handler of this event.\nNote that if the value has not changed and ignoreNoChange = true, the editing will still end but this\nevent will not fire since no edit actually occurred.", + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Editor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The current field value", + "isOptional" : false + }, + { + "name" : "startValue", + "type" : "Mixed", + "desc" : "The original field value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "complete", + "desc" : "Fires after editing is complete and any changed value has been written to the underlying field.", + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Editor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The current field value", + "isOptional" : false + }, + { + "name" : "startValue", + "type" : "Mixed", + "desc" : "The original field value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "specialkey", + "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "startedit", + "desc" : "Fires when this editor is displayed", + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "boundEl", + "type" : "Roo.Element", + "desc" : "The underlying element bound to this editor", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The starting field value", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforerender", + "desc" : "Fires before the component is rendered. Return false to stop the render.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disable", + "desc" : "Fires after the component is disabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Fires after the component is rendered.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "destroy", + "desc" : "Fires after the component is destroyed.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after the component is hidden.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after the component is shown.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before the component is shown. Return false to stop the show.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Fires after the component is enabled.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforedestroy", + "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.tree.TreeFilter.json b/docs2/symbols/Roo.tree.TreeFilter.json new file mode 100644 index 0000000000..09926a87d4 --- /dev/null +++ b/docs2/symbols/Roo.tree.TreeFilter.json @@ -0,0 +1,93 @@ +{ + "name" : "Roo.tree.TreeFilter", + "augments" : [ + ], + "desc" : "Note this class is experimental and doesn't update the indent (lines) or expand collapse icons of the nodes", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "clear", + "desc" : "Clears the current filter. Note: with the \"remove\" option\nset a filter cannot be cleared.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeFilter", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "filter", + "desc" : "Filter the data by a specific attribute.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeFilter", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String/RegExp", + "desc" : "Either string that the attribute value\nshould start with or a RegExp to test against the attribute", + "isOptional" : false + }, + { + "name" : "attr", + "type" : "String", + "desc" : "(optional) The attribute passed in your node's attributes collection. Defaults to \"text\".", + "isOptional" : false + }, + { + "name" : "startNode", + "type" : "TreeNode", + "desc" : "(optional) The node to start the filter at.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "filterBy", + "desc" : "Filter by a function. The passed function will be called with each\nnode in the tree (or from the startNode). If the function returns true, the node is kept\notherwise it is filtered. If a node is filtered, its children are also filtered.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeFilter", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The filter function", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to the current node)", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.tree.TreeLoader.json b/docs2/symbols/Roo.tree.TreeLoader.json new file mode 100644 index 0000000000..20df94c770 --- /dev/null +++ b/docs2/symbols/Roo.tree.TreeLoader.json @@ -0,0 +1,536 @@ +{ + "name" : "Roo.tree.TreeLoader", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "A TreeLoader provides for lazy loading of an {@link Roo.tree.TreeNode}'s child\nnodes from a specified URL. The response must be a javascript Array definition\nwho's elements are node definition objects. eg:\n
    \n{  success : true,\n   data :      [\n   \n    { 'id': 1, 'text': 'A folder Node', 'leaf': false },\n    { 'id': 2, 'text': 'A leaf Node', 'leaf': true }\n    ]\n}\n\n\n
    \n

    \nThe old style respose with just an array is still supported, but not recommended.\n

    \n\nA server request is sent, and child nodes are loaded only when a node is expanded.\nThe loading node's id is passed to the server under the parameter name \"node\" to\nenable the server to produce the correct child nodes.\n

    \nTo pass extra parameters, an event handler may be attached to the \"beforeload\"\nevent, and the parameters specified in the TreeLoader's baseParams property:\n
    \n    myTreeLoader.on(\"beforeload\", function(treeLoader, node) {\n        this.baseParams.category = node.attributes.category;\n    }, this);\n
    <\nThis would pass an HTTP parameter called \"category\" to the server containing\nthe value of the Node's \"category\" attribute.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "clearOnLoad", + "type" : "Boolean", + "desc" : "(optional) Default to true. Remove previously existing\nchild nodes before loading.", + "memberOf" : "Roo.tree.TreeLoader", + "values" : [ + ] + }, + { + "name" : "dataUrl", + "type" : "String", + "desc" : "The URL from which to request a Json string which\nspecifies an array of node definition object representing the child nodes\nto be loaded.", + "memberOf" : "Roo.tree.TreeLoader", + "values" : [ + ] + }, + { + "name" : "root", + "type" : "String", + "desc" : "(optional) Default to false. Use this to read data from an object \nproperty on loading, rather than expecting an array. (eg. more compatible to a standard\nGrid query { data : [ .....] }", + "memberOf" : "Roo.tree.TreeLoader", + "values" : [ + ] + }, + { + "name" : "requestMethod", + "type" : "String", + "desc" : "either GET or POST\ndefaults to POST (due to BC)\nto be loaded.", + "memberOf" : "Roo.tree.TreeLoader", + "values" : [ + ] + }, + { + "name" : "baseParams", + "type" : "Object", + "desc" : "(optional) An object containing properties which\nspecify HTTP parameters to be passed to each request for child nodes.", + "memberOf" : "Roo.tree.TreeLoader", + "values" : [ + ] + }, + { + "name" : "baseAttrs", + "type" : "Object", + "desc" : "(optional) An object containing attributes to be added to all nodes\ncreated by this loader. If the attributes sent by the server have an attribute in this object,\nthey take priority.", + "memberOf" : "Roo.tree.TreeLoader", + "values" : [ + ] + }, + { + "name" : "uiProviders", + "type" : "Object", + "desc" : "(optional) An object containing properties which\n\nDEPRECATED - use 'create' event handler to modify attributes - which affect creation.\nspecify custom {@link Roo.tree.TreeNodeUI} implementations. If the optional\nuiProvider attribute of a returned child node is a string rather\nthan a reference to a TreeNodeUI implementation, this that string value\nis used as a property name in the uiProviders object. You can define the provider named\n'default' , and this will be used for all nodes (if no uiProvider is delivered by the node data)", + "memberOf" : "Roo.tree.TreeLoader", + "values" : [ + ] + }, + { + "name" : "queryParam", + "type" : "String", + "desc" : "(optional) \nName of the query as it will be passed on the querystring (defaults to 'node')\neg. the request will be ?node=[id]", + "memberOf" : "Roo.tree.TreeLoader", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "load", + "desc" : "Load an {@link Roo.tree.TreeNode} from the URL specified in the constructor.\nThis is called automatically when a node is expanded, but may be used to reload\na node (or append new children if the {@link #clearOnLoad} option is false.)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeLoader", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Roo.tree.TreeNode", + "desc" : "", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "create", + "desc" : "Fires before a node is created, enabling you to return custom Node types", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "TreeLoader object.", + "isOptional" : false + }, + { + "name" : "attr", + "type" : "Object", + "desc" : "- the data returned from the AJAX call (modify it to suit)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeload", + "desc" : "Fires before a network request is made to retrieve the Json text which specifies a node's children.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "TreeLoader object.", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Object", + "desc" : "The {@link Roo.tree.TreeNode} object being loaded.", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Object", + "desc" : "The callback function specified in the {@link #load} call.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "load", + "desc" : "Fires when the node has been successfuly loaded.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "TreeLoader object.", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Object", + "desc" : "The {@link Roo.tree.TreeNode} object being loaded.", + "isOptional" : false + }, + { + "name" : "response", + "type" : "Object", + "desc" : "The response object containing the data from the server.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "loadexception", + "desc" : "Fires if the network request failed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "TreeLoader object.", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Object", + "desc" : "The {@link Roo.tree.TreeNode} object being loaded.", + "isOptional" : false + }, + { + "name" : "response", + "type" : "Object", + "desc" : "The response object containing the data from the server.", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.tree.TreeNode.json b/docs2/symbols/Roo.tree.TreeNode.json new file mode 100644 index 0000000000..ae6815c0b1 --- /dev/null +++ b/docs2/symbols/Roo.tree.TreeNode.json @@ -0,0 +1,1896 @@ +{ + "name" : "Roo.tree.TreeNode", + "augments" : [ + "Roo.data.Node", + "Roo.util.Observable" + ], + "desc" : "is to use the cls or iconCls attributes and add the icon via a CSS background image.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "hrefTarget", + "type" : "String", + "desc" : "target frame for the link", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id for this node. If one is not specified, one is generated.", + "memberOf" : "Roo.data.Node", + "values" : [ + ] + }, + { + "name" : "text", + "type" : "String", + "desc" : "The text for this node", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "uiProvider", + "type" : "Function", + "desc" : "A UI class to use for this node (defaults to Roo.tree.TreeNodeUI)", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "expanded", + "type" : "Boolean", + "desc" : "true to start the node expanded", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "qtipCfg", + "type" : "String", + "desc" : "An Ext QuickTip config for the node (used instead of qtip)", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "allowDrop", + "type" : "Boolean", + "desc" : "false if this node cannot be drop on", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "true to start the node disabled", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "cls", + "type" : "String", + "desc" : "A css class to be added to the node", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "iconCls", + "type" : "String", + "desc" : "A css class to be added to the nodes icon element for applying css background images", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "allowDrag", + "type" : "Boolean", + "desc" : "false to make this node undraggable if DD is on (defaults to true)", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "icon", + "type" : "String", + "desc" : "The path to an icon for the node. The preferred way to do this", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "singleClickExpand", + "type" : "Boolean", + "desc" : "True for single click expand on this node", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "qtip", + "type" : "String", + "desc" : "An Ext QuickTip for the node", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "True to render a checked checkbox for this node, false to render an unchecked checkbox\n(defaults to undefined with no checkbox rendered)", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "href", + "type" : "String", + "desc" : "URL of the link used for the node (defaults to #)", + "memberOf" : "Roo.tree.TreeNode", + "values" : [ + ] + }, + { + "name" : "leaf", + "type" : "Boolean", + "desc" : "true if this node is a leaf and does not have children", + "memberOf" : "Roo.data.Node", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "select", + "desc" : "Triggers selection of this node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "enable", + "desc" : "Enables this node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "collapseChildNodes", + "desc" : "Collapse all child nodes", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) true if the child nodes should also collapse their child nodes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "ensureVisible", + "desc" : "Ensures all parent nodes are expanded", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isSelected", + "desc" : "Returns true if this node is selected", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "disable", + "desc" : "Disables this node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getUI", + "desc" : "Returns the UI object for this node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "TreeNodeUI", + "desc" : "" + } + ] + }, + { + "name" : "setText", + "desc" : "Sets the text for this node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "toggle", + "desc" : "Toggles expanded/collapsed state of the node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "unselect", + "desc" : "Triggers deselection of this node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isExpanded", + "desc" : "Returns true if this node is expanded", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "expandChildNodes", + "desc" : "Expand all child nodes", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) true if the child nodes should also expand their child nodes", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "expand", + "desc" : "Expand this node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to expand all children as well", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "(optional) false to cancel the default animation", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) A callback to be called when\nexpanding this node completes (does not wait for deep expand to complete).\nCalled with 1 parameter, this node.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collapse", + "desc" : "Collapse this node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to collapse all children as well", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "(optional) false to cancel the default animation", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "sort", + "desc" : "Sorts this nodes children using the supplied sort function", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeChild", + "desc" : "Removes a child node from this node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node to remove", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The removed node" + } + ] + }, + { + "name" : "isAncestor", + "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "contains", + "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "cascade", + "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to current node)", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) The args to call the function with (default to passing the current node)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getDepth", + "desc" : "Returns depth of this node (the root node has a depth of 0)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "getPath", + "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "attr", + "type" : "String", + "desc" : "(optional) The attr to use for the path (defaults to the node's id)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The path" + } + ] + }, + { + "name" : "indexOf", + "desc" : "Returns the index of a child node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the node or -1 if it was not found" + } + ] + }, + { + "name" : "isFirst", + "desc" : "Returns true if this node is the first child of its parent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "isLast", + "desc" : "Returns true if this node is the last child of its parent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "isLeaf", + "desc" : "Returns true if this node is a leaf", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "insertBefore", + "desc" : "Inserts the first node before the second node in this nodes childNodes collection.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node to insert", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The node to insert before (if null the node is appended)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The inserted node" + } + ] + }, + { + "name" : "item", + "desc" : "Returns the child node at the specified index.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "" + } + ] + }, + { + "name" : "getOwnerTree", + "desc" : "Returns the tree this node is in.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Tree", + "desc" : "" + } + ] + }, + { + "name" : "appendChild", + "desc" : "Insert node(s) as the last child node of this node.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node/Array", + "desc" : "The node or Array of nodes to append", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The appended node if single append, or null if an array was passed" + } + ] + }, + { + "name" : "findChildBy", + "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The found child or null if none was found" + } + ] + }, + { + "name" : "replaceChild", + "desc" : "Replaces one child node in this node with another.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "newChild", + "type" : "Node", + "desc" : "The replacement node", + "isOptional" : false + }, + { + "name" : "oldChild", + "type" : "Node", + "desc" : "The node to replace", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The replaced node" + } + ] + }, + { + "name" : "bubble", + "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to current node)", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) The args to call the function with (default to passing the current node)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "eachChild", + "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to current node)", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) The args to call the function with (default to passing the current node)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "findChild", + "desc" : "Finds the first child that has the attribute with the specified value.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "attribute", + "type" : "String", + "desc" : "The attribute name", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to search for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The found child or null if none was found" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "beforecollapse", + "desc" : "Fires before this node is collapsed, return false to cancel.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "deep", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dblclick", + "desc" : "Fires when this node is double clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disabledchange", + "desc" : "Fires when the disabled status of this node changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforechildrenrendered", + "desc" : "Fires right before the child nodes for this node are rendered", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeclick", + "desc" : "Fires before click processing. Return false to cancel the default action.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "checkchange", + "desc" : "Fires when a node with a checkbox's checked property changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collapse", + "desc" : "Fires when this node is collapsed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "textchange", + "desc" : "Fires when the text for this node is changed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "text", + "type" : "String", + "desc" : "The new text", + "isOptional" : false + }, + { + "name" : "oldText", + "type" : "String", + "desc" : "The old text", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeexpand", + "desc" : "Fires before this node is expanded, return false to cancel.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "deep", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fires when this node is clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "contextmenu", + "desc" : "Fires when this node is right clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "expand", + "desc" : "Fires when this node is expanded", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeappend", + "desc" : "Fires before a new child is appended, return false to cancel the append.", + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be appended", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires when this node is moved to a new location in the tree", + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The old parent of this node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent of this node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it was moved to", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "append", + "desc" : "Fires when a new child node is appended", + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The newly appended node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the newly appended node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeremove", + "desc" : "Fires before a child is removed, return false to cancel the remove.", + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be removed", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Fires when a child node is removed", + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The removed node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeinsert", + "desc" : "Fires before a new child is inserted, return false to cancel the insert.", + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node is being inserted before", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "insert", + "desc" : "Fires when a new child node is inserted.", + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node was inserted before", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforemove", + "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.", + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The parent of this node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent this node is moving to", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it is being moved to", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.tree.TreeNodeUI.json b/docs2/symbols/Roo.tree.TreeNodeUI.json new file mode 100644 index 0000000000..4825bd33dd --- /dev/null +++ b/docs2/symbols/Roo.tree.TreeNodeUI.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.tree.TreeNodeUI", + "augments" : [ + ], + "desc" : "The TreeNode UI implementation is separate from the\ntree implementation. Unless you are customizing the tree UI,\nyou should never have to use this directly.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.tree.TreePanel.json b/docs2/symbols/Roo.tree.TreePanel.json new file mode 100644 index 0000000000..d3911294b3 --- /dev/null +++ b/docs2/symbols/Roo.tree.TreePanel.json @@ -0,0 +1,1551 @@ +{ + "name" : "Roo.tree.TreePanel", + "augments" : [ + "Roo.data.Tree", + "Roo.util.Observable" + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "editor", + "type" : "Object|Roo.tree.TreeEditor", + "desc" : "The TreeEditor or xtype data to display when clicked.", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "singleExpand", + "type" : "Boolean", + "desc" : "true if only 1 node per branch may be expanded", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "ddAppendOnly", + "type" : "String", + "desc" : "True if the tree should only allow append drops (use for trees which are sorted)", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "dragConfig", + "type" : "Object", + "desc" : "Custom config to pass to the {@link Roo.tree.TreeDragZone} instance", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "enableDrop", + "type" : "Boolean", + "desc" : "true to enable just drop", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "hlColor", + "type" : "String", + "desc" : "The color of the node highlight (defaults to C3DAF9)", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "rendererTip", + "type" : "Function", + "desc" : "DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes hovertip to return HTML markup for the tree view. The render function is called with the following parameters:
    • The {Object} The data for the node.
    ", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "enableDD", + "type" : "Boolean", + "desc" : "true to enable drag and drop", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "hlDrop", + "type" : "Boolean", + "desc" : "false to disable node highlight on drop (defaults to the value of Roo.enableFx)", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "renderer", + "type" : "Function", + "desc" : "DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes. to return HTML markup for the tree view. The render function is called with the following parameters:
    • The {Object} The data for the node.
    ", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "rootVisible", + "type" : "Boolean", + "desc" : "false to hide the root node (defaults to true)", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "enableDrag", + "type" : "Boolean", + "desc" : "true to enable just drag", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "ddGroup", + "type" : "String", + "desc" : "The DD group this TreePanel belongs to", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "lines", + "type" : "Boolean", + "desc" : "false to disable tree lines (defaults to true)", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "dropConfig", + "type" : "Object", + "desc" : "Custom config to pass to the {@link Roo.tree.TreeDropZone} instance", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "selModel", + "type" : "Boolean", + "desc" : "A tree selection model to use with this TreePanel (defaults to a {@link Roo.tree.DefaultSelectionModel})", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "loader", + "type" : "Boolean", + "desc" : "A TreeLoader for use with this TreePanel", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "containerScroll", + "type" : "Boolean", + "desc" : "true to register this container with ScrollManager", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "ddScroll", + "type" : "Boolean", + "desc" : "true to enable YUI body scrolling", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "animate", + "type" : "Boolean", + "desc" : "true to enable animated expand/collapse (defaults to the value of Roo.enableFx)", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + }, + { + "name" : "pathSeparator", + "type" : "String", + "desc" : "The token used to separate sub-paths in path strings (defaults to '/')", + "memberOf" : "Roo.tree.TreePanel", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "getLoader", + "desc" : "Returns the default TreeLoader for this TreePanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreePanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "render", + "desc" : "Trigger rendering of this TreePanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreePanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getSelectionModel", + "desc" : "Returns the selection model used by this TreePanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreePanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "expandPath", + "desc" : "Expands a specified path in this TreePanel. A path can be retrieved from a node with {@link Roo.data.Node#getPath}", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreePanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "path", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "attr", + "type" : "String", + "desc" : "(optional) The attribute used in the path (see {@link Roo.data.Node#getPath} for more info)", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) The callback to call when the expand is complete. The callback will be called with\n(bSuccess, oLastNode) where bSuccess is if the expand was successful and oLastNode is the last node that was expanded.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "expandAll", + "desc" : "Expand all nodes", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreePanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "getChecked", + "desc" : "Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. \"id\")", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreePanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "attribute", + "type" : "String", + "desc" : "(optional) Defaults to null (return the actual nodes)", + "isOptional" : false + }, + { + "name" : "startNode", + "type" : "TreeNode", + "desc" : "(optional) The node to start from, defaults to the root", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "" + } + ] + }, + { + "name" : "selectPath", + "desc" : "Selects the node in this tree at the specified path. A path can be retrieved from a node with {@link Roo.data.Node#getPath}", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreePanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "path", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "attr", + "type" : "String", + "desc" : "(optional) The attribute used in the path (see {@link Roo.data.Node#getPath} for more info)", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) The callback to call when the selection is complete. The callback will be called with\n(bSuccess, oSelNode) where bSuccess is if the selection was successful and oSelNode is the selected node.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns the container element for this TreePanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreePanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "collapseAll", + "desc" : "Collapse all nodes", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.tree.TreePanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "setRootNode", + "desc" : "Sets the root node for this tree.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "" + } + ] + }, + { + "name" : "getRootNode", + "desc" : "Returns the root node for this tree.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "" + } + ] + }, + { + "name" : "getNodeById", + "desc" : "Gets a node in this tree by its id.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "" + } + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "dblclick", + "desc" : "Fires when a node is double clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "contextmenu", + "desc" : "Fires when a node is right clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeclick", + "desc" : "Fires before click processing on a node. Return false to cancel the default action.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "checkchange", + "desc" : "Fires when a node with a checkbox's checked property changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "nodedragover", + "desc" : "Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent\npassed to handlers has the following properties:
    \n
      \n
    • tree - The TreePanel
    • \n
    • target - The node being targeted for the drop
    • \n
    • data - The drag data from the drag source
    • \n
    • point - The point of the drop - append, above or below
    • \n
    • source - The drag source
    • \n
    • rawEvent - Raw mouse event
    • \n
    • dropNode - Drop node(s) provided by the source.
    • \n
    • cancel - Set this to true to signal drop not allowed.
    • \n
    ", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "dragOverEvent", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeexpand", + "desc" : "Fires before a node is expanded, return false to cancel.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + }, + { + "name" : "deep", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "collapse", + "desc" : "Fires when a node is collapsed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforenodedrop", + "desc" : "Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The dropEvent\npassed to handlers has the following properties:
    \n
      \n
    • tree - The TreePanel
    • \n
    • target - The node being targeted for the drop
    • \n
    • data - The drag data from the drag source
    • \n
    • point - The point of the drop - append, above or below
    • \n
    • source - The drag source
    • \n
    • rawEvent - Raw mouse event
    • \n
    • dropNode - Drop node(s) provided by the source OR you can supply node(s)\nto be inserted by setting them on this object.
    • \n
    • cancel - Set this to true to cancel the drop.
    • \n
    ", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "dropEvent", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforechildrenrendered", + "desc" : "Fires right before the child nodes for a node are rendered", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "textchange", + "desc" : "Fires when the text for a node is changed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + }, + { + "name" : "text", + "type" : "String", + "desc" : "The new text", + "isOptional" : false + }, + { + "name" : "oldText", + "type" : "String", + "desc" : "The old text", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "load", + "desc" : "Fires when a node is loaded", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node that was loaded", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "startdrag", + "desc" : "Fires when a node starts being dragged", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.tree.TreePanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Roo.tree.TreeNode", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fires when a node is clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "expand", + "desc" : "Fires when a node is expanded", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "enddrag", + "desc" : "Fires when a drag operation is complete", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.tree.TreePanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Roo.tree.TreeNode", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "nodedrop", + "desc" : "Fires after a DD object is dropped on a node in this tree. The dropEvent\npassed to handlers has the following properties:
    \n
      \n
    • tree - The TreePanel
    • \n
    • target - The node being targeted for the drop
    • \n
    • data - The drag data from the drag source
    • \n
    • point - The point of the drop - append, above or below
    • \n
    • source - The drag source
    • \n
    • rawEvent - Raw mouse event
    • \n
    • dropNode - Dropped node(s).
    • \n
    ", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "dropEvent", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "dragdrop", + "desc" : "Fires when a dragged node is dropped on a valid DD target", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.tree.TreePanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Roo.tree.TreeNode", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "DD", + "desc" : "The dd it was dropped on", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforecollapse", + "desc" : "Fires before a node is collapsed, return false to cancel.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + }, + { + "name" : "deep", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "disabledchange", + "desc" : "Fires when the disabled status of a node changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeload", + "desc" : "Fires before a node is loaded, return false to cancel", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node being loaded", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "append", + "desc" : "Fires when a new child node is appended to a node in this tree.", + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The newly appended node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the newly appended node", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforemove", + "desc" : "Fires before a node is moved to a new location in the tree. Return false to cancel the move.", + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The node being moved", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The parent of the node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent the node is moving to", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it is being moved to", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "insert", + "desc" : "Fires when a new child node is inserted in a node in this tree.", + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node was inserted before", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeappend", + "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.", + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be appended", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "move", + "desc" : "Fires when a node is moved to a new location in the tree", + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The node moved", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The old parent of this node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent of this node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it was moved to", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeremove", + "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.", + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be removed", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Fires when a child node is removed from a node in this tree.", + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node removed", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeinsert", + "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.", + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node is being inserted before", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.tree.TreeSorter.json b/docs2/symbols/Roo.tree.TreeSorter.json new file mode 100644 index 0000000000..f1a36b3601 --- /dev/null +++ b/docs2/symbols/Roo.tree.TreeSorter.json @@ -0,0 +1,63 @@ +{ + "name" : "Roo.tree.TreeSorter", + "augments" : [ + ], + "desc" : "Provides sorting of nodes in a TreePanel", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "folderSort", + "type" : "Boolean", + "desc" : "True to sort leaf nodes under non leaf nodes", + "memberOf" : "Roo.tree.TreeSorter", + "values" : [ + ] + }, + { + "name" : "leafAttr", + "type" : "String", + "desc" : "The attribute used to determine leaf nodes in folder sort (defaults to \"leaf\")", + "memberOf" : "Roo.tree.TreeSorter", + "values" : [ + ] + }, + { + "name" : "caseSensitive", + "type" : "Boolean", + "desc" : "true for case sensitive sort (defaults to false)", + "memberOf" : "Roo.tree.TreeSorter", + "values" : [ + ] + }, + { + "name" : "dir", + "type" : "String", + "desc" : "The direction to sort (asc or desc) (defaults to asc)", + "memberOf" : "Roo.tree.TreeSorter", + "values" : [ + ] + }, + { + "name" : "sortType", + "type" : "Function", + "desc" : "A custom \"casting\" function used to convert node values before sorting", + "memberOf" : "Roo.tree.TreeSorter", + "values" : [ + ] + }, + { + "name" : "property", + "type" : "String", + "desc" : "The named attribute on the node to sort by (defaults to text)", + "memberOf" : "Roo.tree.TreeSorter", + "values" : [ + ] + } + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.tree.json b/docs2/symbols/Roo.tree.json new file mode 100644 index 0000000000..deaa11e46f --- /dev/null +++ b/docs2/symbols/Roo.tree.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.tree", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.util.CSS.json b/docs2/symbols/Roo.util.CSS.json new file mode 100644 index 0000000000..dd61b0e3ea --- /dev/null +++ b/docs2/symbols/Roo.util.CSS.json @@ -0,0 +1,218 @@ +{ + "name" : "Roo.util.CSS", + "augments" : [ + ], + "desc" : "Utility class for manipulating CSS rules", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "createStyleSheet", + "desc" : "Very simple dynamic creation of stylesheets from a text blob of rules. The text will wrapped in a style\ntag and appended to the HEAD of the document.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.CSS", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "cssText", + "type" : "String|Object", + "desc" : "The text containing the css rules", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "An id to add to the stylesheet for later removal", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "StyleSheet", + "desc" : "" + } + ] + }, + { + "name" : "getRules", + "desc" : "Gets all css rules for the document", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.CSS", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "refreshCache", + "type" : "Boolean", + "desc" : "true to refresh the internal cache", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object (hash) of rules indexed by selector" + } + ] + }, + { + "name" : "swapStyleSheet", + "desc" : "Dynamically swaps an existing stylesheet reference for a new one", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.CSS", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of an existing link tag to remove", + "isOptional" : false + }, + { + "name" : "url", + "type" : "String", + "desc" : "The href of the new stylesheet to include", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "updateRule", + "desc" : "Updates a rule property", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.CSS", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String/Array", + "desc" : "If it's an array it tries each selector until it finds one. Stops immediately once one is found.", + "isOptional" : false + }, + { + "name" : "property", + "type" : "String", + "desc" : "The css property", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String", + "desc" : "The new value for the property", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "true If a rule was found and updated" + } + ] + }, + { + "name" : "getRule", + "desc" : "Gets an an individual CSS rule by selector(s)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.CSS", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "selector", + "type" : "String/Array", + "desc" : "The CSS selector or an array of selectors to try. The first selector that is found is returned.", + "isOptional" : false + }, + { + "name" : "refreshCache", + "type" : "Boolean", + "desc" : "true to refresh the internal cache if you have recently updated any rules or added styles dynamically", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "CSSRule", + "desc" : "The CSS rule or null if one is not found" + } + ] + }, + { + "name" : "refreshCache", + "desc" : "Refresh the rule cache if you have dynamically added stylesheets", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.CSS", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object (hash) of rules indexed by selector" + } + ] + }, + { + "name" : "removeStyleSheet", + "desc" : "Removes a style or link tag by id", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.CSS", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of the tag", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.util.ClickRepeater.json b/docs2/symbols/Roo.util.ClickRepeater.json new file mode 100644 index 0000000000..7e032c2f8d --- /dev/null +++ b/docs2/symbols/Roo.util.ClickRepeater.json @@ -0,0 +1,439 @@ +{ + "name" : "Roo.util.ClickRepeater", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "A wrapper class which can be applied to any element. Fires a \"click\" event while the\nmouse is pressed. The interval between firings may be specified in the config but\ndefaults to 10 milliseconds.\n\nOptionally, a CSS class may be applied to the element during the time it is pressed.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "stopDefault", + "type" : "Boolean", + "desc" : "True to stop the default click event", + "memberOf" : "Roo.util.ClickRepeater", + "values" : [ + ] + }, + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "delay", + "type" : "Number", + "desc" : "The initial delay before the repeating event begins firing.\nSimilar to an autorepeat key delay.", + "memberOf" : "Roo.util.ClickRepeater", + "values" : [ + ] + }, + { + "name" : "accelerate", + "type" : "Boolean", + "desc" : "True if autorepeating should start slowly and accelerate.\n \"interval\" and \"delay\" are ignored. \"immediate\" is honored.", + "memberOf" : "Roo.util.ClickRepeater", + "values" : [ + ] + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : "True to prevent the default click event", + "memberOf" : "Roo.util.ClickRepeater", + "values" : [ + ] + }, + { + "name" : "interval", + "type" : "Number", + "desc" : "The interval between firings of the \"click\" event. Default 10 ms.", + "memberOf" : "Roo.util.ClickRepeater", + "values" : [ + ] + }, + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The element to act as a button.", + "memberOf" : "Roo.util.ClickRepeater", + "values" : [ + ] + }, + { + "name" : "pressClass", + "type" : "String", + "desc" : "A CSS class name to be applied to the element while pressed.", + "memberOf" : "Roo.util.ClickRepeater", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "mousedown", + "desc" : "Fires when the mouse button is depressed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.util.ClickRepeater", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fires on a specified interval during the time the element is pressed.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.util.ClickRepeater", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseup", + "desc" : "Fires when the mouse key is released.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.util.ClickRepeater", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.util.DelayedTask.json b/docs2/symbols/Roo.util.DelayedTask.json new file mode 100644 index 0000000000..4e107aa01b --- /dev/null +++ b/docs2/symbols/Roo.util.DelayedTask.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.util.DelayedTask", + "augments" : [ + ], + "desc" : "Provides a convenient method of performing setTimeout where a new\ntimeout cancels the old timeout. An example would be performing validation on a keypress.\nYou can use this class to buffer\nthe keypress events for a certain number of milliseconds, and perform only if they stop\nfor that amount of time.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.util.Format.json b/docs2/symbols/Roo.util.Format.json new file mode 100644 index 0000000000..bbb3603af3 --- /dev/null +++ b/docs2/symbols/Roo.util.Format.json @@ -0,0 +1,462 @@ +{ + "name" : "Roo.util.Format", + "augments" : [ + ], + "desc" : "Reusable data formatting functions", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "uppercase", + "desc" : "Converts a string to all upper case letters", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Format", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The text to convert", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The converted text" + } + ] + }, + { + "name" : "date", + "desc" : "Parse a value into a formatted date using the specified format pattern.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Format", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to format", + "isOptional" : false + }, + { + "name" : "format", + "type" : "String", + "desc" : "(optional) Any valid date format string (defaults to 'm/d/Y')", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The formatted date string" + } + ] + }, + { + "name" : "lowercase", + "desc" : "Converts a string to all lower case letters", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Format", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The text to convert", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The converted text" + } + ] + }, + { + "name" : "undef", + "desc" : "Checks a reference and converts it to empty string if it is undefined", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Format", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "Reference to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "Empty string if converted, otherwise the original value" + } + ] + }, + { + "name" : "stripTags", + "desc" : "Strips all HTML tags", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Format", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The text from which to strip tags", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The stripped text" + } + ] + }, + { + "name" : "ellipsis", + "desc" : "Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Format", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The string to truncate", + "isOptional" : false + }, + { + "name" : "length", + "type" : "Number", + "desc" : "The maximum length to allow before truncating", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The converted text" + } + ] + }, + { + "name" : "htmlDecode", + "desc" : "Convert certain characters (&, <, >, and ') from their HTML character equivalents.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Format", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The string to decode", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The decoded text" + } + ] + }, + { + "name" : "htmlEncode", + "desc" : "Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Format", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The string to encode", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The encoded text" + } + ] + }, + { + "name" : "toFixed", + "desc" : "safer version of Math.toFixed..??/", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Format", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Number/String", + "desc" : "The numeric value to format", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Number/String", + "desc" : "Decimal places", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The formatted currency string" + } + ] + }, + { + "name" : "substr", + "desc" : "Returns a substring from within an original string", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Format", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The original text", + "isOptional" : false + }, + { + "name" : "start", + "type" : "Number", + "desc" : "The start index of the substring", + "isOptional" : false + }, + { + "name" : "length", + "type" : "Number", + "desc" : "The length of the substring", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The substring" + } + ] + }, + { + "name" : "number", + "desc" : "Format a number\neventually this should probably emulate php's number_format", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Format", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Number/String", + "desc" : "The numeric value to format", + "isOptional" : false + }, + { + "name" : "decimals", + "type" : "Number", + "desc" : "number of decimal places", + "isOptional" : false + }, + { + "name" : "delimiter", + "type" : "String", + "desc" : "for thousands (default comma)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The formatted currency string" + } + ] + }, + { + "name" : "usMoney", + "desc" : "Format a number as US currency", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Format", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "Number/String", + "desc" : "The numeric value to format", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The formatted currency string" + } + ] + }, + { + "name" : "capitalize", + "desc" : "Converts the first character only of a string to upper case", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Format", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The text to convert", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The converted text" + } + ] + }, + { + "name" : "trim", + "desc" : "Trims any whitespace from either side of a string", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Format", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The text to trim", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The trimmed text" + } + ] + }, + { + "name" : "dateRenderer", + "desc" : "Returns a date rendering function that can be reused to apply a date format multiple times efficiently", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Format", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "format", + "type" : "String", + "desc" : "Any valid date format string", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Function", + "desc" : "The date formatting function" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.util.JSON.json b/docs2/symbols/Roo.util.JSON.json new file mode 100644 index 0000000000..bf0f14872b --- /dev/null +++ b/docs2/symbols/Roo.util.JSON.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.util.JSON", + "augments" : [ + ], + "desc" : "Modified version of Douglas Crockford\"s json.js that doesn\"t\nmess with the Object prototype \nhttp://www.json.org/js.html", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.util.MixedCollection.json b/docs2/symbols/Roo.util.MixedCollection.json new file mode 100644 index 0000000000..71e7614cb2 --- /dev/null +++ b/docs2/symbols/Roo.util.MixedCollection.json @@ -0,0 +1,1211 @@ +{ + "name" : "Roo.util.MixedCollection", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "A Collection class that maintains both numeric indexes and keys and exposes events.", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "remove", + "desc" : "Removed an item from the collection.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "The item to remove.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The item removed." + } + ] + }, + { + "name" : "get", + "desc" : "Returns the item associated with the passed key or index.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "key", + "type" : "String/Number", + "desc" : "The key or index of the item.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The item associated with the passed key." + } + ] + }, + { + "name" : "itemAt", + "desc" : "Returns the item at the specified index.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the item.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] + }, + { + "name" : "each", + "desc" : "Executes the specified function once for every item in the collection, passing each\nitem as the first and only parameter. returning false from the function will stop the iteration.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to execute for each item.", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the function.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "insert", + "desc" : "Inserts an item at the specified index in the collection.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index to insert the item at.", + "isOptional" : false + }, + { + "name" : "key", + "type" : "String", + "desc" : "The key to associate with the new item, or the item itself.", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object", + "desc" : "(optional) If the second parameter was a key, the new item.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The item inserted." + } + ] + }, + { + "name" : "getCount", + "desc" : "Returns the number of items in the collection.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "the number of items in the collection." + } + ] + }, + { + "name" : "clear", + "desc" : "Removes all items from the collection.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "keySort", + "desc" : "Sorts this collection by keys", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "direction", + "type" : "String", + "desc" : "(optional) \"ASC\" or \"DESC\"", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "(optional) a comparison function (defaults to case insensitive string)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "indexOf", + "desc" : "Returns index within the collection of the passed Object.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "The item to find the index of.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "index of the item." + } + ] + }, + { + "name" : "clone", + "desc" : "Creates a duplicate of this collection", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "MixedCollection", + "desc" : "" + } + ] + }, + { + "name" : "containsKey", + "desc" : "Returns true if the collection contains the passed Object as a key.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "key", + "type" : "String", + "desc" : "The key to look for in the collection.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the collection contains the Object as a key." + } + ] + }, + { + "name" : "getKey", + "desc" : "MixedCollection has a generic way to fetch keys if you implement getKey.\n
    \n// normal way\nvar mc = new Roo.util.MixedCollection();\nmc.add(someEl.dom.id, someEl);\nmc.add(otherEl.dom.id, otherEl);\n//and so on\n\n// using getKey\nvar mc = new Roo.util.MixedCollection();\nmc.getKey = function(el){\n   return el.dom.id;\n};\nmc.add(someEl);\nmc.add(otherEl);\n\n// or via the constructor\nvar mc = new Roo.util.MixedCollection(false, function(el){\n   return el.dom.id;\n});\nmc.add(someEl);\nmc.add(otherEl);\n
    ", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "", + "desc" : "{Object} The item for which to find the key.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The key for the passed item." + } + ] + }, + { + "name" : "find", + "desc" : "Returns the first item in the collection which elicits a true return value from the\npassed selection function.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The selection function to execute for each item.", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the function.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The first item in the collection which returned true from the selection function." + } + ] + }, + { + "name" : "getRange", + "desc" : "Returns a range of items in this collection", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "startIndex", + "type" : "Number", + "desc" : "(optional) defaults to 0", + "isOptional" : false + }, + { + "name" : "endIndex", + "type" : "Number", + "desc" : "(optional) default to the last item", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "An array of items" + } + ] + }, + { + "name" : "eachKey", + "desc" : "Executes the specified function once for every key in the collection, passing each\nkey, and its associated item as the first two parameters.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to execute for each item.", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the function.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "indexOfKey", + "desc" : "Returns index within the collection of the passed key.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "key", + "type" : "String", + "desc" : "The key to find the index of.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "index of the key." + } + ] + }, + { + "name" : "contains", + "desc" : "Returns true if the collection contains the passed Object as an item.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "The Object to look for in the collection.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the collection contains the Object as an item." + } + ] + }, + { + "name" : "addAll", + "desc" : "Adds all elements of an Array or an Object to the collection.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "objs", + "type" : "Object/Array", + "desc" : "An Object containing properties which will be added to the collection, or\nan Array of values, each of which are added to the collection.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "key", + "desc" : "Returns the item associated with the passed key.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "key", + "type" : "String/Number", + "desc" : "The key of the item.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The item associated with the passed key." + } + ] + }, + { + "name" : "item", + "desc" : "Returns the item associated with the passed key OR index. Key has priority over index.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "key", + "type" : "String/Number", + "desc" : "The key or index of the item.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The item associated with the passed key." + } + ] + }, + { + "name" : "filterBy", + "desc" : "Filter by a function. * Returns a new collection that has been filtered.\nThe passed function will be called with each \nobject in the collection. If the function returns true, the value is included \notherwise it is filtered.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to be called, it will receive the args o (the object), k (the key)", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to this)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "MixedCollection", + "desc" : "The new filtered collection" + } + ] + }, + { + "name" : "add", + "desc" : "Adds an item to the collection.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "key", + "type" : "String", + "desc" : "The key to associate with the item", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object", + "desc" : "The item to add.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The item added." + } + ] + }, + { + "name" : "removeAt", + "desc" : "Remove an item from a specified index in the collection.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index within the collection of the item to remove.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeKey", + "desc" : "Removed an item associated with the passed key fom the collection.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "key", + "type" : "String", + "desc" : "The key of the item to remove.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "filter", + "desc" : "Filter the objects in this collection by a specific property. \nReturns a new collection that has been filtered.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "property", + "type" : "String", + "desc" : "A property on your objects", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String/RegExp", + "desc" : "Either string that the property values \nshould start with or a RegExp to test against the property", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "MixedCollection", + "desc" : "The new filtered collection" + } + ] + }, + { + "name" : "last", + "desc" : "Returns the last item in the collection.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "the last item in the collection.." + } + ] + }, + { + "name" : "replace", + "desc" : "Replaces an item in the collection.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "key", + "type" : "String", + "desc" : "The key associated with the item to replace, or the item to replace.", + "isOptional" : false + }, + { + "name" : "o", + "type" : "", + "desc" : "{Object} o (optional) If the first parameter passed was a key, the item to associate with that key.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The new item." + } + ] + }, + { + "name" : "first", + "desc" : "Returns the first item in the collection.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "the first item in the collection.." + } + ] + }, + { + "name" : "sort", + "desc" : "Sorts this collection with the passed comparison function", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.MixedCollection", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "direction", + "type" : "String", + "desc" : "(optional) \"ASC\" or \"DESC\"", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "(optional) comparison function", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "remove", + "desc" : "Fires when an item is removed from the collection.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "The item being removed.", + "isOptional" : false + }, + { + "name" : "key", + "type" : "String", + "desc" : "(optional) The key associated with the removed item.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "add", + "desc" : "Fires when an item is added to the collection.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index at which the item was added.", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object", + "desc" : "The item added.", + "isOptional" : false + }, + { + "name" : "key", + "type" : "String", + "desc" : "The key associated with the added item.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "replace", + "desc" : "Fires when an item is replaced in the collection.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "key", + "type" : "String", + "desc" : "he key associated with the new added.", + "isOptional" : false + }, + { + "name" : "old", + "type" : "Object", + "desc" : "The item being replaced.", + "isOptional" : false + }, + { + "name" : "new", + "type" : "Object", + "desc" : "The new item.", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "clear", + "desc" : "Fires when the collection is cleared.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.util.Observable.json b/docs2/symbols/Roo.util.Observable.json new file mode 100644 index 0000000000..ec903637ac --- /dev/null +++ b/docs2/symbols/Roo.util.Observable.json @@ -0,0 +1,325 @@ +{ + "name" : "Roo.util.Observable", + "augments" : [ + ], + "desc" : "Base class that provides a common interface for publishing events. Subclasses are expected to\nto have a property \"events\" with all the events defined.
    \nFor example:\n
    \n Employee = function(name){\n    this.name = name;\n    this.addEvents({\n        \"fired\" : true,\n        \"quit\" : true\n    });\n }\n Roo.extend(Employee, Roo.util.Observable);\n
    ", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
    \n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
    ", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
      \n
    • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
    • \n
    • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
    • \n
    • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
    • \n
    • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
    • \n

    \n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

    \n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
    \n

    \nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

    \n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
    ", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.util.TextMetrics.Instance.json b/docs2/symbols/Roo.util.TextMetrics.Instance.json new file mode 100644 index 0000000000..b4a8fe4a86 --- /dev/null +++ b/docs2/symbols/Roo.util.TextMetrics.Instance.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.util.TextMetrics.Instance", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.util.TextMetrics.json b/docs2/symbols/Roo.util.TextMetrics.json new file mode 100644 index 0000000000..71c5b9db7a --- /dev/null +++ b/docs2/symbols/Roo.util.TextMetrics.json @@ -0,0 +1,87 @@ +{ + "name" : "Roo.util.TextMetrics", + "augments" : [ + ], + "desc" : "Provides precise pixel measurements for blocks of text so that you can determine exactly how high and\nwide, in pixels, a given block of text will be.", + "isSingleton" : true, + "isStatic" : true, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + { + "name" : "createInstance", + "desc" : "Return a unique TextMetrics instance that can be bound directly to an element and reused. This reduces\nthe overhead of multiple calls to initialize the style properties on each measurement.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.TextMetrics", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement", + "desc" : "The element, dom node or id that the instance will be bound to", + "isOptional" : false + }, + { + "name" : "fixedWidth", + "type" : "Number", + "desc" : "(optional) If the text will be multiline, you have to set a fixed width\nin order to accurately measure the text height", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.util.TextMetrics.Instance", + "desc" : "instance The new instance" + } + ] + }, + { + "name" : "measure", + "desc" : "Measures the size of the specified text", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.TextMetrics", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement", + "desc" : "The element, dom node or id from which to copy existing CSS styles\nthat can affect the size of the rendered text", + "isOptional" : false + }, + { + "name" : "text", + "type" : "String", + "desc" : "The text to measure", + "isOptional" : false + }, + { + "name" : "fixedWidth", + "type" : "Number", + "desc" : "(optional) If the text will be multiline, you have to set a fixed width\nin order to accurately measure the text height", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the text's size {width: (width), height: (height)}" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/Roo.util.json b/docs2/symbols/Roo.util.json new file mode 100644 index 0000000000..44af1f307b --- /dev/null +++ b/docs2/symbols/Roo.util.json @@ -0,0 +1,15 @@ +{ + "name" : "Roo.util", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/String.json b/docs2/symbols/String.json new file mode 100644 index 0000000000..5ee2dcc9c6 --- /dev/null +++ b/docs2/symbols/String.json @@ -0,0 +1,174 @@ +{ + "name" : "String", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : true, + "config" : [ + ], + "methods" : [ + { + "name" : "escape", + "desc" : "Escapes the passed string for ' and \\", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "String", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "string", + "type" : "String", + "desc" : "The string to escape", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The escaped string" + } + ] + }, + { + "name" : "leftPad", + "desc" : "Pads the left side of a string with a specified character. This is especially useful\nfor normalizing number and date strings. Example usage:\n
    \nvar s = String.leftPad('123', 5, '0');\n// s now contains the string: '00123'\n
    ", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "String", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "string", + "type" : "String", + "desc" : "The original string", + "isOptional" : false + }, + { + "name" : "size", + "type" : "Number", + "desc" : "The total length of the output string", + "isOptional" : false + }, + { + "name" : "char", + "type" : "String", + "desc" : "(optional) The character with which to pad the original string (defaults to empty string \" \")", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The padded string" + } + ] + }, + { + "name" : "toggle", + "desc" : "Utility function that allows you to easily switch a string between two alternating values. The passed value\nis compared to the current string, and if they are equal, the other value that was passed in is returned. If\nthey are already different, the first value passed in is returned. Note that this method returns the new value\nbut does not change the current string.\n
    \n// alternate sort directions\nsort = sort.toggle('ASC', 'DESC');\n\n// instead of conditional logic:\nsort = (sort == 'ASC' ? 'DESC' : 'ASC');\n
    ", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "String", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value to compare to the current string", + "isOptional" : false + }, + { + "name" : "other", + "type" : "String", + "desc" : "The new value to use if the string already equals the first value passed in", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The new value" + } + ] + }, + { + "name" : "format", + "desc" : "Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens. Each\ntoken must be unique, and must increment in the format {0}, {1}, etc. Example usage:\n
    \nvar cls = 'my-class', text = 'Some text';\nvar s = String.format('
    {1}
    ', cls, text);\n// s now contains the string: '
    Some text
    '\n
    ", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "String", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "string", + "type" : "String", + "desc" : "The tokenized string to be formatted", + "isOptional" : false + }, + { + "name" : "value1", + "type" : "String", + "desc" : "The value to replace token {0}", + "isOptional" : false + }, + { + "name" : "value2", + "type" : "String", + "desc" : "Etc...", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The formatted string" + } + ] + }, + { + "name" : "unicodeClean", + "desc" : "Remove invalid unicode characters from a string", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "String", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The clean string" + } + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/_global_.json b/docs2/symbols/_global_.json new file mode 100644 index 0000000000..da1ea435cd --- /dev/null +++ b/docs2/symbols/_global_.json @@ -0,0 +1,111 @@ +{ + "name" : "_global_", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : true, + "config" : [ + ], + "methods" : [ + { + "name" : "escape", + "desc" : "Helpers", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "_global_", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "Renderer", + "desc" : "Renderer", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "_global_", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "InlineLexer", + "desc" : "Inline Lexer & Compiler", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "_global_", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "marked", + "desc" : "Marked", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "_global_", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "Lexer", + "desc" : "Block Lexer", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "_global_", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "Parser", + "desc" : "Parsing & Compiling", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "_global_", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + } + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/symbols/this.json b/docs2/symbols/this.json new file mode 100644 index 0000000000..1d0eb25c8b --- /dev/null +++ b/docs2/symbols/this.json @@ -0,0 +1,15 @@ +{ + "name" : "this", + "augments" : [ + ], + "desc" : "", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "config" : [ + ], + "methods" : [ + ], + "events" : [ + ] +} \ No newline at end of file diff --git a/docs2/tree.json b/docs2/tree.json new file mode 100644 index 0000000000..511d0424fb --- /dev/null +++ b/docs2/tree.json @@ -0,0 +1,1736 @@ +[ + { + "name" : "Array", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Date", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Function", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Number", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo", + "cn" : [ + { + "name" : "Roo.Ajax", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.BasicDialog", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.BasicLayoutRegion", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.BorderLayout", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.BoxComponent", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.Button", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.CalendarPanel", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.ColorPalette", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.Component", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.ComponentMgr", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.CompositeElement", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.CompositeElementLite", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.ContentPanel", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.DDView", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.DatePicker", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.DialogManager", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.Document", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.DomHelper", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.DomQuery", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.DomTemplate", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.Editor", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.Element", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.EventManager", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.EventObject", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.Fx", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.GridPanel", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.HtmlEditorCore", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.JsonView", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.KeyMap", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.KeyNav", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.Layer", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.LayoutDialog", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.LayoutManager", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.LayoutRegion", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.LoadMask", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.MasterTemplate", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.NestedLayoutPanel", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.PagingToolbar", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.QuickTips", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.ReaderLayout", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.Resizable", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.Shadow", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.SplitBar", + "cn" : [ + { + "name" : "Roo.SplitBar.AbsoluteLayoutAdapter", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.SplitBar.BasicLayoutAdapter", + "cn" : [ + ], + "is_class" : true + } + ], + "is_class" : true + }, + { + "name" : "Roo.SplitButton", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.SplitLayoutRegion", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.TabPanel", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.TabPanelItem", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.Template", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.Toolbar", + "cn" : [ + { + "name" : "Roo.Toolbar.Button", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.Toolbar.Fill", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.Toolbar.Item", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.Toolbar.Separator", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.Toolbar.Spacer", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.Toolbar.SplitButton", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.Toolbar.TextItem", + "cn" : [ + ], + "is_class" : true + } + ], + "is_class" : true + }, + { + "name" : "Roo.TreePanel", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.UpdateManager", + "cn" : [ + { + "name" : "Roo.UpdateManager.BasicRenderer", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.UpdateManager.defaults", + "cn" : [ + ], + "is_class" : false + } + ], + "is_class" : true + }, + { + "name" : "Roo.View", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.XComponent", + "cn" : [ + { + "name" : "Roo.XComponent.event", + "cn" : [ + { + "name" : "Roo.XComponent.event.events", + "cn" : [ + ], + "is_class" : false + } + ], + "is_class" : false + } + ], + "is_class" : true + }, + { + "name" : "Roo.XTemplate", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap", + "cn" : [ + { + "name" : "Roo.bootstrap.Alert", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.BezierSignature", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Body", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Brick", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Button", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.ButtonGroup", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Calendar", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.CheckBox", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Column", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.ComboBox", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Component", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Container", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.DateField", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.DateSplitField", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.DocumentManager", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.DocumentSlider", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.DocumentViewer", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Element", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.FieldLabel", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Form", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Graph", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Header", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.HtmlEditor", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Img", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Input", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.LayoutMasonry", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.LayoutMasonryAuto", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Link", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.LocationPicker", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.MasonryBrick", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Menu", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.MenuItem", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.MenuMgr", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.MenuSeparator", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.MessageBar", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.MessageBox", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Modal", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.MoneyField", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.MonthField", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.NavGroup", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.NavHeaderbar", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.NavItem", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.NavProgressBar", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.NavProgressItem", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.NavSidebar", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.NavSidebarItem", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.NavSimplebar", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Navbar", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.NumberField", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Pagination", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.PaginationItem", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.PagingToolbar", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.PhoneInput", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Popover", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Progress", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.ProgressBar", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Radio", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.RadioSet", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Row", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.SecurePass", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Slider", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.SplitBar", + "cn" : [ + { + "name" : "Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter", + "cn" : [ + ], + "is_class" : true + } + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.TabGroup", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.TabPanel", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Table", + "cn" : [ + { + "name" : "Roo.bootstrap.Table.AbstractSelectionModel", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Table.RowSelectionModel", + "cn" : [ + ], + "is_class" : true + } + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.TableBody", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.TableCell", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.TableRow", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.TextArea", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.TimeField", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.Tooltip", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.TriggerField", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.UploadCropbox", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.dash", + "cn" : [ + { + "name" : "Roo.bootstrap.dash.NumberBox", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.dash.TabBox", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.dash.TabPane", + "cn" : [ + ], + "is_class" : true + } + ], + "is_class" : false + }, + { + "name" : "Roo.bootstrap.htmleditor", + "cn" : [ + { + "name" : "Roo.bootstrap.htmleditor.ToolbarStandard", + "cn" : [ + ], + "is_class" : true + } + ], + "is_class" : false + }, + { + "name" : "Roo.bootstrap.layout", + "cn" : [ + { + "name" : "Roo.bootstrap.layout.Basic", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.layout.Border", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.layout.Manager", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.layout.Region", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.layout.Split", + "cn" : [ + ], + "is_class" : true + } + ], + "is_class" : false + }, + { + "name" : "Roo.bootstrap.menu", + "cn" : [ + { + "name" : "Roo.bootstrap.menu.Item", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.menu.Menu", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.menu.Separator", + "cn" : [ + ], + "is_class" : true + } + ], + "is_class" : false + }, + { + "name" : "Roo.bootstrap.panel", + "cn" : [ + { + "name" : "Roo.bootstrap.panel.Content", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.panel.Grid", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.panel.Nest", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.panel.TabItem", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.bootstrap.panel.Tabs", + "cn" : [ + ], + "is_class" : true + } + ], + "is_class" : false + } + ], + "is_class" : false + }, + { + "name" : "Roo.data", + "cn" : [ + { + "name" : "Roo.data.ArrayReader", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.data.Connection", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.data.DataProxy", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.data.DataReader", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.data.HttpProxy", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.data.JsonReader", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.data.JsonStore", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.data.MemoryProxy", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.data.Node", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.data.Record", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.data.ScriptTagProxy", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.data.SimpleStore", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.data.SortTypes", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.data.Store", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.data.Tree", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.data.XmlReader", + "cn" : [ + ], + "is_class" : true + } + ], + "is_class" : false + }, + { + "name" : "Roo.dd", + "cn" : [ + { + "name" : "Roo.dd.DD", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.dd.DDProxy", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.dd.DDTarget", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.dd.DragDrop", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.dd.DragDropMgr", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.dd.DragSource", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.dd.DragZone", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.dd.DropTarget", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.dd.DropZone", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.dd.Registry", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.dd.ScrollManager", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.dd.StatusProxy", + "cn" : [ + ], + "is_class" : true + } + ], + "is_class" : false + }, + { + "name" : "Roo.form", + "cn" : [ + { + "name" : "Roo.form.Action", + "cn" : [ + ], + "is_class" : false + }, + { + "name" : "Roo.form.BasicForm", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.Checkbox", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.Column", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.ComboBox", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.ComboBoxArray", + "cn" : [ + { + "name" : "Roo.form.ComboBoxArray.Item", + "cn" : [ + ], + "is_class" : true + } + ], + "is_class" : true + }, + { + "name" : "Roo.form.ComboCheck", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.DateField", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.DayPicker", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.DisplayField", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.FCKeditor", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.Field", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.FieldSet", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.Form", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.GridField", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.Hidden", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.HtmlEditor", + "cn" : [ + { + "name" : "Roo.form.HtmlEditor.ToolbarContext", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.HtmlEditor.ToolbarStandard", + "cn" : [ + ], + "is_class" : true + } + ], + "is_class" : true + }, + { + "name" : "Roo.form.Layout", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.MonthField", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.NumberField", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.Radio", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.Row", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.Select", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.Signature", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.TextArea", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.TextField", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.TriggerField", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.form.VTypes", + "cn" : [ + ], + "is_class" : true + } + ], + "is_class" : false + }, + { + "name" : "Roo.grid", + "cn" : [ + { + "name" : "Roo.grid.AbstractGridView", + "cn" : [ + ], + "is_class" : false + }, + { + "name" : "Roo.grid.AbstractSelectionModel", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.grid.Calendar", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.grid.CellSelectionModel", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.grid.ColumnModel", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.grid.EditorGrid", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.grid.Grid", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.grid.GridEditor", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.grid.GridView", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.grid.PropertyGrid", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.grid.RowSelectionModel", + "cn" : [ + ], + "is_class" : true + } + ], + "is_class" : false + }, + { + "name" : "Roo.lib", + "cn" : [ + { + "name" : "Roo.lib.Ajax", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.lib.Dom", + "cn" : [ + ], + "is_class" : false + } + ], + "is_class" : false + }, + { + "name" : "Roo.menu", + "cn" : [ + { + "name" : "Roo.menu.Adapter", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.menu.BaseItem", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.menu.CheckItem", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.menu.ColorItem", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.menu.ColorMenu", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.menu.DateItem", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.menu.DateMenu", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.menu.Item", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.menu.Menu", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.menu.MenuMgr", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.menu.Separator", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.menu.TextItem", + "cn" : [ + ], + "is_class" : true + } + ], + "is_class" : false + }, + { + "name" : "Roo.state", + "cn" : [ + { + "name" : "Roo.state.CookieProvider", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.state.Manager", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.state.Provider", + "cn" : [ + ], + "is_class" : true + } + ], + "is_class" : false + }, + { + "name" : "Roo.tree", + "cn" : [ + { + "name" : "Roo.tree.AsyncTreeNode", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.tree.ColumnTree", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.tree.DefaultSelectionModel", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.tree.MultiSelectionModel", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.tree.TreeEditor", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.tree.TreeFilter", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.tree.TreeLoader", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.tree.TreeNode", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.tree.TreeNodeUI", + "cn" : [ + ], + "is_class" : false + }, + { + "name" : "Roo.tree.TreePanel", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.tree.TreeSorter", + "cn" : [ + ], + "is_class" : false + } + ], + "is_class" : false + }, + { + "name" : "Roo.util", + "cn" : [ + { + "name" : "Roo.util.CSS", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.util.ClickRepeater", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.util.DelayedTask", + "cn" : [ + ], + "is_class" : false + }, + { + "name" : "Roo.util.Format", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.util.JSON", + "cn" : [ + ], + "is_class" : false + }, + { + "name" : "Roo.util.MixedCollection", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.util.Observable", + "cn" : [ + ], + "is_class" : true + }, + { + "name" : "Roo.util.TextMetrics", + "cn" : [ + { + "name" : "Roo.util.TextMetrics.Instance", + "cn" : [ + ], + "is_class" : false + } + ], + "is_class" : true + } + ], + "is_class" : false + } + ], + "is_class" : true + }, + { + "name" : "String", + "cn" : [ + ], + "is_class" : true + } +] \ No newline at end of file diff --git a/images/roojsorg_logo-100.png b/images/roojsorg_logo-100.png new file mode 100644 index 0000000000..a8ba786ffd Binary files /dev/null and b/images/roojsorg_logo-100.png differ diff --git a/roojs-bootstrap-debug.js b/roojs-bootstrap-debug.js index 3fc684a5d2..2bcdb19dde 100644 --- a/roojs-bootstrap-debug.js +++ b/roojs-bootstrap-debug.js @@ -2060,13 +2060,13 @@ Roo.bootstrap.Menu = function(config){ this.addEvents({ /** * @event beforeshow - * Fires before this menu is displayed + * Fires before this menu is displayed (return false to block) * @param {Roo.menu.Menu} this */ beforeshow : true, /** * @event beforehide - * Fires before this menu is hidden + * Fires before this menu is hidden (return false to block) * @param {Roo.menu.Menu} this */ beforehide : true, @@ -2288,12 +2288,17 @@ Roo.extend(Roo.bootstrap.Menu, Roo.bootstrap.Component, { * the element (defaults to this.defaultAlign) * @param {Roo.menu.Menu} parentMenu (optional) This menu's parent menu, if applicable (defaults to undefined) */ - show : function(el, pos, parentMenu){ - this.parentMenu = parentMenu; + show : function(el, pos, parentMenu) + { + if (false === this.fireEvent("beforeshow", this)) { + Roo.log("show canceled"); + return; + } + this.parentMenu = parentMenu; if(!this.el){ this.render(); } - this.fireEvent("beforeshow", this); + this.showAt(this.el.getAlignToXY(el, pos || this.defaultAlign), parentMenu, false); }, /** @@ -2356,10 +2361,13 @@ Roo.extend(Roo.bootstrap.Menu, Roo.bootstrap.Component, { */ hide : function(deep) { - + if (false === this.fireEvent("beforehide", this)) { + Roo.log("hide canceled"); + return; + } this.hideMenuItems(); if(this.el && this.isVisible()){ - this.fireEvent("beforehide", this); + if(this.activeItem){ this.activeItem.deactivate(); this.activeItem = null; @@ -2426,16 +2434,11 @@ Roo.extend(Roo.bootstrap.Menu, Roo.bootstrap.Component, { if (!this.el) { return; } - //$(backdrop).remove() + this.el.select('.open',true).each(function(aa) { aa.removeClass('open'); - //var parent = getParent($(this)) - //var relatedTarget = { relatedTarget: this } - - //$parent.trigger(e = $.Event('hide.bs.dropdown', relatedTarget)) - //if (e.isDefaultPrevented()) return - //$parent.removeClass('open').trigger('hidden.bs.dropdown', relatedTarget) + }); }, addxtypeChild : function (tree, cntr) { @@ -3936,7 +3939,7 @@ Roo.extend(Roo.bootstrap.Navbar, Roo.bootstrap.Component, { getChildContainer : function() { - if (this.el.select('.collapse').getCount()) { + if (this.el && this.el.select('.collapse').getCount()) { return this.el.select('.collapse',true).first(); } @@ -5125,7 +5128,7 @@ Roo.extend(Roo.bootstrap.NavSidebarItem, Roo.bootstrap.NavItem, { e.preventDefault(); } - this.fireEvent('click', this); + this.fireEvent('click', this, e); }, disable : function() @@ -12379,7 +12382,7 @@ Roo.extend(Roo.data.MemoryProxy, Roo.data.DataProxy, { params = params || {}; var result; try { - result = reader.readRecords(this.data); + result = reader.readRecords(params.data ? params.data :this.data); }catch(e){ this.fireEvent("loadexception", this, arg, null, e); callback.call(scope, null, arg, false); @@ -12991,12 +12994,16 @@ var myReader = new Roo.data.ArrayReader({ * Create a new JsonReader * @param {Object} meta Metadata configuration options. * @param {Object} recordType Either an Array of field definition objects + * @cfg {Array} fields Array of field definition objects + * @cfg {String} id Name of the property within a row object that contains a record identifier value. * as specified to {@link Roo.data.Record#create}, * or an {@link Roo.data.Record} object * created using {@link Roo.data.Record#create}. */ Roo.data.ArrayReader = function(meta, recordType){ - Roo.data.ArrayReader.superclass.constructor.call(this, meta, recordType); + + + Roo.data.ArrayReader.superclass.constructor.call(this, meta, recordType||meta.fields); }; Roo.extend(Roo.data.ArrayReader, Roo.data.JsonReader, { diff --git a/roojs-bootstrap.js b/roojs-bootstrap.js index b8a92f657d..57ca6fb3e6 100644 --- a/roojs-bootstrap.js +++ b/roojs-bootstrap.js @@ -91,10 +91,10 @@ this.triggerEl.on(Roo.isTouch?'touchstart':'mouseup',this.onTriggerPress,this);i }this.el.on('click',this.onClick,this);this.el.on("mouseover",this.onMouseOver,this);this.el.on("mouseout",this.onMouseOut,this);},findTargetItem:function(e){var t=e.getTarget(".dropdown-menu-item",this.el,true);if(!t){return false;}if(t&&t.id){return this.menuitems.get(t.id); }return false;},onTouch:function(e){Roo.log("menu.onTouch");this.onClick(e);},onClick:function(e){Roo.log("menu.onClick");var t=this.findTargetItem(e);if(!t||t.isContainer){return;}Roo.log(e);Roo.log('pass click event');t.onClick(e);this.fireEvent("click",this,t,e); var A=this;if(!t.href.length||t.href=='#'){(function(){A.hide();}).defer(100);}},onMouseOver:function(e){var t=this.findTargetItem(e);this.fireEvent("mouseover",this,e,t);},isVisible:function(){return !this.hidden;},onMouseOut:function(e){var t=this.findTargetItem(e); -this.fireEvent("mouseout",this,e,t);},show:function(el,A,B){this.parentMenu=B;if(!this.el){this.render();}this.fireEvent("beforeshow",this);this.showAt(this.el.getAlignToXY(el,A||this.defaultAlign),B,false);},showAt:function(xy,A,_e){this.parentMenu=A;if(!this.el){this.render(); -}if(_e!==false){this.fireEvent("beforeshow",this);}this.hideMenuItems();this.hidden=false;this.triggerEl.addClass('open');this.el.addClass('show');if(this.el.getWidth()+xy[0]>=Roo.lib.Dom.getViewWidth()){xy[0]=xy[0]-this.el.getWidth()+this.triggerEl.getWidth(); +this.fireEvent("mouseout",this,e,t);},show:function(el,A,B){if(false===this.fireEvent("beforeshow",this)){Roo.log("show canceled");return;}this.parentMenu=B;if(!this.el){this.render();}this.showAt(this.el.getAlignToXY(el,A||this.defaultAlign),B,false);},showAt:function(xy,A,_e){this.parentMenu=A; +if(!this.el){this.render();}if(_e!==false){this.fireEvent("beforeshow",this);}this.hideMenuItems();this.hidden=false;this.triggerEl.addClass('open');this.el.addClass('show');if(this.el.getWidth()+xy[0]>=Roo.lib.Dom.getViewWidth()){xy[0]=xy[0]-this.el.getWidth()+this.triggerEl.getWidth(); }if(this.el.getHeight()+xy[1]>=Roo.lib.Dom.getViewHeight()){xy[1]=xy[1]-this.el.getHeight()-this.triggerEl.getHeight();}if(this.el.getStyle('top')!='auto'&&this.el.getStyle('top').slice(-1)!="%"){this.el.setXY(xy);}this.focus();this.fireEvent("show",this); -},focus:function(){return;if(!this.hidden){this.doFocus.defer(50,this);}},doFocus:function(){if(!this.hidden){this.focusEl.focus();}},hide:function(A){this.hideMenuItems();if(this.el&&this.isVisible()){this.fireEvent("beforehide",this);if(this.activeItem){this.activeItem.deactivate(); +},focus:function(){return;if(!this.hidden){this.doFocus.defer(50,this);}},doFocus:function(){if(!this.hidden){this.focusEl.focus();}},hide:function(A){if(false===this.fireEvent("beforehide",this)){Roo.log("hide canceled");return;}this.hideMenuItems();if(this.el&&this.isVisible()){if(this.activeItem){this.activeItem.deactivate(); this.activeItem=null;}this.triggerEl.removeClass('open');;this.el.removeClass('show');this.hidden=true;this.fireEvent("hide",this);}if(A===true&&this.parentMenu){this.parentMenu.hide(true);}},onTriggerClick:function(e){Roo.log('trigger click');var A=e.getTarget(); Roo.log(A.nodeName.toLowerCase());if(A.nodeName.toLowerCase()==='i'){e.preventDefault();}},onTriggerPress:function(e){Roo.log('trigger press');var A=Roo.get(e.getTarget());if(A.findParent('.dropdown-menu')||A.findParent('.treeview-menu')){Roo.log('is treeview or dropdown?'); return;}if(e.getTarget().nodeName.toLowerCase()!=='i'&&this.isLink){return;}if(this.isVisible()){Roo.log('hide');this.hide();}else{Roo.log('show');this.show(this.triggerEl,'?',false);}if(this.stopEvent||e.getTarget().nodeName.toLowerCase()==='i'){e.stopEvent(); @@ -156,7 +156,7 @@ Roo.bootstrap.Navbar=function(A){Roo.bootstrap.Navbar.superclass.constructor.cal ;},initEvents:function(){this.el.select('.navbar-toggle',true).on('click',function(){if(this.fireEvent('beforetoggle',this)!==false){var ce=this.el.select('.navbar-collapse',true).first();ce.toggleClass('in');if(ce.hasClass('collapse')){ce.removeClass('collapse'); ce.addClass('show');var h=ce.getHeight();Roo.log(h);ce.removeClass('show');ce.addClass('collapsing');ce.setHeight(0);ce.on('transitionend',function(){Roo.log('done transition');ce.removeClass('collapsing');ce.addClass('show');ce.removeClass('collapse');ce.dom.style.height=''; },this,{single:true});ce.setHeight(h);}else{ce.setHeight(ce.getHeight());ce.removeClass('show');ce.addClass('collapsing');ce.on('transitionend',function(){ce.dom.style.height='';ce.removeClass('collapsing');ce.addClass('collapse');},this,{single:true});ce.setHeight(0); -}}},this);var A={tag:"div",cls:"x-dlg-mask"};this.maskEl=Roo.DomHelper.append(this.el,A,true);var B=this.el.getSize();this.maskEl.setSize(B.width,B.height);this.maskEl.enableDisplayMode("block");this.maskEl.hide();if(this.loadMask){this.maskEl.show();}},getChildContainer:function(){if(this.el.select('.collapse').getCount()){return this.el.select('.collapse',true).first(); +}}},this);var A={tag:"div",cls:"x-dlg-mask"};this.maskEl=Roo.DomHelper.append(this.el,A,true);var B=this.el.getSize();this.maskEl.setSize(B.width,B.height);this.maskEl.enableDisplayMode("block");this.maskEl.hide();if(this.loadMask){this.maskEl.show();}},getChildContainer:function(){if(this.el&&this.el.select('.collapse').getCount()){return this.el.select('.collapse',true).first(); }return this.el;},mask:function(){this.maskEl.show();},unmask:function(){this.maskEl.hide();}}); // Roo/bootstrap/NavSimplebar.js Roo.bootstrap.NavSimplebar=function(A){Roo.bootstrap.NavSimplebar.superclass.constructor.call(this,A);};Roo.extend(Roo.bootstrap.NavSimplebar,Roo.bootstrap.Navbar,{inverse:false,type:false,arrangement:'',align:false,weight:'light',main:false,tag:false,getAutoCreate:function(){var A={tag:this.tag||'div',cls:'navbar navbar-expand-lg roo-navbar-simple'} @@ -207,7 +207,7 @@ Roo.bootstrap.NavSidebarItem=function(A){Roo.bootstrap.NavSidebarItem.superclass }if(this.open){A.cls+=' open x-open';}if(this.glyphicon||this.icon){var c=this.glyphicon?('glyphicon glyphicon-'+this.glyphicon):this.icon;a.cn.push({tag:'i',cls:c});}if(!this.buttonView){var B={tag:'span',html:this.html||''};a.cn.push(B);}if(this.badge!==''){a.cn.push({tag:'span',cls:'badge pull-right badge-'+this.badgeWeight,html:this.badge} );}if(this.menu){if(this.showArrow){a.cn.push({tag:'i',cls:'glyphicon glyphicon-chevron-down pull-right'});}a.cls+=' dropdown-toggle treeview';}return A;},initEvents:function(){if(typeof(this.menu)!='undefined'){this.menu.parentType=this.xtype;this.menu.triggerEl=this.el; this.menu=this.addxtype(Roo.apply({},this.menu));}this.el.on('click',this.onClick,this);if(this.badge!==''){this.badgeEl=this.el.select('.badge',true).first().setVisibilityMode(Roo.Element.DISPLAY);}},onClick:function(e){if(this.disabled){e.preventDefault(); -return;}if(this.preventDefault){e.preventDefault();}this.fireEvent('click',this);},disable:function(){this.setDisabled(true);},enable:function(){this.setDisabled(false);},setDisabled:function(A){if(this.disabled==A){return;}this.disabled=A;if(A){this.el.addClass('disabled'); +return;}if(this.preventDefault){e.preventDefault();}this.fireEvent('click',this,e);},disable:function(){this.setDisabled(true);},enable:function(){this.setDisabled(false);},setDisabled:function(A){if(this.disabled==A){return;}this.disabled=A;if(A){this.el.addClass('disabled'); return;}this.el.removeClass('disabled');return;},setActive:function(A){if(this.active==A){return;}this.active=A;if(A){this.el.addClass('active');return;}this.el.removeClass('active');return;},isActive:function(){return this.active;},setBadge:function(A){if(!this.badgeEl){return; }this.badgeEl.dom.innerHTML=A;}}); // Roo/bootstrap/Row.js @@ -507,8 +507,8 @@ break;case 'date':da[c.name]=new Date();break;case 'float':da[c.name]=0.0;break; // Roo/data/DataProxy.js Roo.data.DataProxy=function(){this.addEvents({beforeload:true,load:true,loadexception:true});Roo.data.DataProxy.superclass.constructor.call(this);};Roo.extend(Roo.data.DataProxy,Roo.util.Observable); // Roo/data/MemoryProxy.js -Roo.data.MemoryProxy=function(A){if(A.data){A=A.data;}Roo.data.MemoryProxy.superclass.constructor.call(this);this.data=A;};Roo.extend(Roo.data.MemoryProxy,Roo.data.DataProxy,{load:function(A,B,C,D,E){A=A||{};var F;try{F=B.readRecords(this.data);}catch(e){this.fireEvent("loadexception",this,E,null,e); -C.call(D,null,E,false);return;}C.call(D,F,E,true);},update:function(A,B){}}); +Roo.data.MemoryProxy=function(A){if(A.data){A=A.data;}Roo.data.MemoryProxy.superclass.constructor.call(this);this.data=A;};Roo.extend(Roo.data.MemoryProxy,Roo.data.DataProxy,{load:function(A,B,C,D,E){A=A||{};var F;try{F=B.readRecords(A.data?A.data:this.data); +}catch(e){this.fireEvent("loadexception",this,E,null,e);C.call(D,null,E,false);return;}C.call(D,F,E,true);},update:function(A,B){}}); // Roo/data/HttpProxy.js Roo.data.HttpProxy=function(A){Roo.data.HttpProxy.superclass.constructor.call(this);this.conn=A;this.useAjax=!A||!A.events;};Roo.extend(Roo.data.HttpProxy,Roo.data.DataProxy,{getConnection:function(){return this.useAjax?Roo.Ajax:this.conn;},load:function(A,B,C,D,E){if(this.fireEvent("beforeload",this,A)!==false){var o={params:A||{} ,request:{callback:C,scope:D,arg:E},reader:B,callback:this.loadResponse,scope:this};if(this.useAjax){Roo.applyIf(o,this.conn);if(this.activeRequest){Roo.Ajax.abort(this.activeRequest);}this.activeRequest=Roo.Ajax.request(o);}else{this.conn.request(o);}}else{C.call(D||this,null,E,false); @@ -532,8 +532,8 @@ jjString(b).toUpperCase()?1:-1; };if((!this.topModule||!this.topModule.modules)&&!this.elmodules.length){throw "No top level modules to build";}var C=this.topModule?[this.topModule]:[];Roo.each(this.elmodules,function(e){C.push(e);if(!this.topModule&&typeof(e.parent)=='string'&&e.parent.substring(0,1)=='#'&&Roo.get(e.parent.substr(1))){A.topModule=e; }});var D=function(m){Roo.debug&&Roo.log("build Order: add: "+m.name);C.push(m);if(m.modules&&!m.disabled){Roo.debug&&Roo.log("build Order: "+m.modules.length+" child modules");m.modules.keySort('ASC',B);Roo.debug&&Roo.log("build Order: "+m.modules.length+" child modules (after sort)");